Chilkat Online Tools

Ruby / Sunshine Conversations API / List Apps

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

http.put_BasicAuth(true)
http.put_Login("username")
http.put_Password("password")

queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("page[after]","5e1606762556d93e9c176f69")
queryParams.UpdateString("page[before]","5e1606762556d93e9c176f69")
queryParams.UpdateInt("page[size]",10)
queryParams.UpdateString("filter[serviceAccountId]","laborum consectetur id")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/v2/apps",queryParams)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "apps": [
#     {
#       "id": "5d8cff3cd55b040010928b5b",
#       "displayName": "ipsu",
#       "settings": {
#         "conversationRetentionSeconds": 55645305,
#         "maskCreditCardNumbers": true,
#         "useAnimalNames": true,
#         "echoPostback": false,
#         "ignoreAutoConversationStart": false,
#         "multiConvoEnabled": false,
#         "attachmentsAccess": "public",
#         "attachmentsTokenExpirationSeconds": 64028
#       },
#       "metadata": {
#         "lang": "en-ca"
#       }
#     },
#     {
#       "id": "5d8cff3cd55b040010928b5b",
#       "displayName": "Exce",
#       "settings": {
#         "conversationRetentionSeconds": 1491566,
#         "maskCreditCardNumbers": false,
#         "useAnimalNames": true,
#         "echoPostback": true,
#         "ignoreAutoConversationStart": true,
#         "multiConvoEnabled": false,
#         "attachmentsAccess": "public",
#         "attachmentsTokenExpirationSeconds": 64028
#       },
#       "metadata": {
#         "lang": "en-ca"
#       }
#     }
#   ],
#   "meta": {
#     "hasMore": true,
#     "afterCursor": "55c8d9758590aa1900b9b9f6",
#     "beforeCursor": "55c8d9758590aa1900b9b9f6"
#   },
#   "links": {
#     "prev": "https://api.smooch.io/v2/apps?page[before]=fcafad804c39a39648004af9",
#     "next": "https://api.smooch.io/v2/apps?page[after]=5ea868f862cdd24abf010b38"
#   }
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

HasMore = jResp.BoolOf("meta.hasMore")
AfterCursor = jResp.stringOf("meta.afterCursor")
BeforeCursor = jResp.stringOf("meta.beforeCursor")
Prev = jResp.stringOf("links.prev")
v_Next = jResp.stringOf("links.next")
i = 0
count_i = jResp.SizeOfArray("apps")
while i < count_i
    jResp.put_I(i)
    id = jResp.stringOf("apps[i].id")
    displayName = jResp.stringOf("apps[i].displayName")
    ConversationRetentionSeconds = jResp.IntOf("apps[i].settings.conversationRetentionSeconds")
    MaskCreditCardNumbers = jResp.BoolOf("apps[i].settings.maskCreditCardNumbers")
    UseAnimalNames = jResp.BoolOf("apps[i].settings.useAnimalNames")
    EchoPostback = jResp.BoolOf("apps[i].settings.echoPostback")
    IgnoreAutoConversationStart = jResp.BoolOf("apps[i].settings.ignoreAutoConversationStart")
    MultiConvoEnabled = jResp.BoolOf("apps[i].settings.multiConvoEnabled")
    AttachmentsAccess = jResp.stringOf("apps[i].settings.attachmentsAccess")
    AttachmentsTokenExpirationSeconds = jResp.IntOf("apps[i].settings.attachmentsTokenExpirationSeconds")
    Lang = jResp.stringOf("apps[i].metadata.lang")
    i = i + 1
end

Curl Command

curl -G -d "page[after]=5e1606762556d93e9c176f69"
	-d "page[before]=5e1606762556d93e9c176f69"
	-d "page[size]=10"
	-d "filter[serviceAccountId]=laborum%20consectetur%20id"
	-u 'username:password'
https://domain.com/v2/apps

Postman Collection Item JSON

{
  "name": "List Apps",
  "_postman_id": "9e945a28-9ef0-4a15-92ad-f6b39c1223ce",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{url}}/v2/apps?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10&filter[serviceAccountId]=laborum consectetur id",
      "host": [
        "{{url}}"
      ],
      "path": [
        "v2",
        "apps"
      ],
      "query": [
        {
          "key": "page[after]",
          "value": "5e1606762556d93e9c176f69",
          "description": "Contains parameters for applying cursor pagination."
        },
        {
          "key": "page[before]",
          "value": "5e1606762556d93e9c176f69",
          "description": "Contains parameters for applying cursor pagination."
        },
        {
          "key": "page[size]",
          "value": "10",
          "description": "Contains parameters for applying cursor pagination."
        },
        {
          "key": "filter[serviceAccountId]",
          "value": "laborum consectetur id",
          "description": "Contains parameters for filtering the results."
        }
      ]
    },
    "description": "Lists all apps that a user is part of. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits). \n```shell\n/v2/apps?page[after]=5e1606762556d93e9c176f69&page[size]=10\n```\n"
  },
  "response": [
    {
      "id": "20d18287-f52c-47f5-b6c5-ff8ecd484eeb",
      "name": "Can supply only one of page[after] or page[before], not both",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v2/apps?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10&filter[serviceAccountId]=laborum consectetur id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps"
          ],
          "query": [
            {
              "key": "page[after]",
              "value": "5e1606762556d93e9c176f69"
            },
            {
              "key": "page[before]",
              "value": "5e1606762556d93e9c176f69"
            },
            {
              "key": "page[size]",
              "value": "10"
            },
            {
              "key": "filter[serviceAccountId]",
              "value": "laborum consectetur id"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "id": "8bc21ad8-9781-42a8-8e87-e25a48c04d58",
      "name": "Ok",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v2/apps?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10&filter[serviceAccountId]=laborum consectetur id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps"
          ],
          "query": [
            {
              "key": "page[after]",
              "value": "5e1606762556d93e9c176f69"
            },
            {
              "key": "page[before]",
              "value": "5e1606762556d93e9c176f69"
            },
            {
              "key": "page[size]",
              "value": "10"
            },
            {
              "key": "filter[serviceAccountId]",
              "value": "laborum consectetur id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"apps\": [\n  {\n   \"id\": \"5d8cff3cd55b040010928b5b\",\n   \"displayName\": \"ipsu\",\n   \"settings\": {\n    \"conversationRetentionSeconds\": 55645305,\n    \"maskCreditCardNumbers\": true,\n    \"useAnimalNames\": true,\n    \"echoPostback\": false,\n    \"ignoreAutoConversationStart\": false,\n    \"multiConvoEnabled\": false,\n    \"attachmentsAccess\": \"public\",\n    \"attachmentsTokenExpirationSeconds\": 64028\n   },\n   \"metadata\": {\n    \"lang\": \"en-ca\"\n   }\n  },\n  {\n   \"id\": \"5d8cff3cd55b040010928b5b\",\n   \"displayName\": \"Exce\",\n   \"settings\": {\n    \"conversationRetentionSeconds\": 1491566,\n    \"maskCreditCardNumbers\": false,\n    \"useAnimalNames\": true,\n    \"echoPostback\": true,\n    \"ignoreAutoConversationStart\": true,\n    \"multiConvoEnabled\": false,\n    \"attachmentsAccess\": \"public\",\n    \"attachmentsTokenExpirationSeconds\": 64028\n   },\n   \"metadata\": {\n    \"lang\": \"en-ca\"\n   }\n  }\n ],\n \"meta\": {\n  \"hasMore\": true,\n  \"afterCursor\": \"55c8d9758590aa1900b9b9f6\",\n  \"beforeCursor\": \"55c8d9758590aa1900b9b9f6\"\n },\n \"links\": {\n  \"prev\": \"https://api.smooch.io/v2/apps?page[before]=fcafad804c39a39648004af9\",\n  \"next\": \"https://api.smooch.io/v2/apps?page[after]=5ea868f862cdd24abf010b38\"\n }\n}"
    },
    {
      "id": "f3936c25-49e4-421f-9fb2-c6b58a66a999",
      "name": "The serviceAccountId provided does not match supplied credentials",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v2/apps?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10&filter[serviceAccountId]=laborum consectetur id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps"
          ],
          "query": [
            {
              "key": "page[after]",
              "value": "5e1606762556d93e9c176f69"
            },
            {
              "key": "page[before]",
              "value": "5e1606762556d93e9c176f69"
            },
            {
              "key": "page[size]",
              "value": "10"
            },
            {
              "key": "filter[serviceAccountId]",
              "value": "laborum consectetur id"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}