Chilkat Online Tools

Ruby / Sunshine Conversations API / List Conversations

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[userId]","incididunt ea proident in sit")
queryParams.UpdateString("filter[userExternalId]","occaecat sed")

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/v2/apps/{{appId}}/conversations",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)

# {
#   "conversations": [
#     {
#       "id": "c93bb9c14dde8ffb94564eae",
#       "type": "personal",
#       "activeSwitchboardIntegration": {
#         "id": "5ef21b86e933b7355c11c604",
#         "name": "bot",
#         "integrationId": "5ef21b86e933b7355c11c605",
#         "integrationType": "zd:agentWorkspace"
#       },
#       "pendingSwitchboardIntegration": {
#         "id": "5ef21b86e933b7355c11c604",
#         "name": "bot",
#         "integrationId": "5ef21b86e933b7355c11c605",
#         "integrationType": "zd:agentWorkspace"
#       },
#       "isDefault": false,
#       "displayName": "dolo",
#       "description": "Conversation between Rogers and Carl.",
#       "iconUrl": "https://www.gravatar.com/image.jpg",
#       "metadata": {
#         "lang": "en-ca"
#       },
#       "businessLastRead": "2020-06-23T14:33:47.492Z",
#       "lastUpdatedAt": "2020-06-26T14:33:47.120Z"
#     },
#     {
#       "id": "c93bb9c14dde8ffb94564eae",
#       "type": "personal",
#       "activeSwitchboardIntegration": {
#         "id": "5ef21b86e933b7355c11c604",
#         "name": "bot",
#         "integrationId": "5ef21b86e933b7355c11c605",
#         "integrationType": "zd:agentWorkspace"
#       },
#       "pendingSwitchboardIntegration": {
#         "id": "5ef21b86e933b7355c11c604",
#         "name": "bot",
#         "integrationId": "5ef21b86e933b7355c11c605",
#         "integrationType": "zd:agentWorkspace"
#       },
#       "isDefault": false,
#       "displayName": "ut s",
#       "description": "Conversation between Rogers and Carl.",
#       "iconUrl": "https://www.gravatar.com/image.jpg",
#       "metadata": {
#         "lang": "en-ca"
#       },
#       "businessLastRead": "2020-06-23T14:33:47.492Z",
#       "lastUpdatedAt": "2020-06-26T14:33:47.120Z"
#     }
#   ],
#   "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("conversations")
while i < count_i
    jResp.put_I(i)
    id = jResp.stringOf("conversations[i].id")
    v_type = jResp.stringOf("conversations[i].type")
    Id = jResp.stringOf("conversations[i].activeSwitchboardIntegration.id")
    Name = jResp.stringOf("conversations[i].activeSwitchboardIntegration.name")
    IntegrationId = jResp.stringOf("conversations[i].activeSwitchboardIntegration.integrationId")
    IntegrationType = jResp.stringOf("conversations[i].activeSwitchboardIntegration.integrationType")
    pendingSwitchboardIntegrationId = jResp.stringOf("conversations[i].pendingSwitchboardIntegration.id")
    pendingSwitchboardIntegrationName = jResp.stringOf("conversations[i].pendingSwitchboardIntegration.name")
    pendingSwitchboardIntegrationIntegrationId = jResp.stringOf("conversations[i].pendingSwitchboardIntegration.integrationId")
    pendingSwitchboardIntegrationIntegrationType = jResp.stringOf("conversations[i].pendingSwitchboardIntegration.integrationType")
    isDefault = jResp.BoolOf("conversations[i].isDefault")
    displayName = jResp.stringOf("conversations[i].displayName")
    description = jResp.stringOf("conversations[i].description")
    iconUrl = jResp.stringOf("conversations[i].iconUrl")
    Lang = jResp.stringOf("conversations[i].metadata.lang")
    businessLastRead = jResp.stringOf("conversations[i].businessLastRead")
    lastUpdatedAt = jResp.stringOf("conversations[i].lastUpdatedAt")
    i = i + 1
end

Curl Command

curl -G -d "page[after]=5e1606762556d93e9c176f69"
	-d "page[before]=5e1606762556d93e9c176f69"
	-d "page[size]=10"
	-d "filter[userId]=incididunt%20ea%20proident%20in%20sit"
	-d "filter[userExternalId]=occaecat%20sed"
	-u 'username:password'
https://domain.com/v2/apps/{{appId}}/conversations

Postman Collection Item JSON

{
  "name": "List Conversations",
  "_postman_id": "90efc8c1-d5bf-4533-9c7e-89e994d67a11",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{url}}/v2/apps/{{appId}}/conversations?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10&filter[userId]=incididunt ea proident in sit&filter[userExternalId]=occaecat sed",
      "host": [
        "{{url}}"
      ],
      "path": [
        "v2",
        "apps",
        "{{appId}}",
        "conversations"
      ],
      "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[userId]",
          "value": "incididunt ea proident in sit",
          "description": "(Required) Contains parameters for filtering the results."
        },
        {
          "key": "filter[userExternalId]",
          "value": "occaecat sed",
          "description": "(Required) Contains parameters for filtering the results."
        }
      ]
    },
    "description": "Lists all conversations 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/:appId/conversations?filter[userId]=42589ad070d43be9b00ff7e5\n```\n"
  },
  "response": [
    {
      "id": "1cb978d1-7d9f-46e3-832b-bf0866adfc55",
      "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/:appId/conversations?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10&filter[userId]=incididunt ea proident in sit&filter[userExternalId]=occaecat sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "conversations"
          ],
          "query": [
            {
              "key": "page[after]",
              "value": "5e1606762556d93e9c176f69"
            },
            {
              "key": "page[before]",
              "value": "5e1606762556d93e9c176f69"
            },
            {
              "key": "page[size]",
              "value": "10"
            },
            {
              "key": "filter[userId]",
              "value": "incididunt ea proident in sit"
            },
            {
              "key": "filter[userExternalId]",
              "value": "occaecat sed"
            }
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"conversations\": [\n  {\n   \"id\": \"c93bb9c14dde8ffb94564eae\",\n   \"type\": \"personal\",\n   \"activeSwitchboardIntegration\": {\n    \"id\": \"5ef21b86e933b7355c11c604\",\n    \"name\": \"bot\",\n    \"integrationId\": \"5ef21b86e933b7355c11c605\",\n    \"integrationType\": \"zd:agentWorkspace\"\n   },\n   \"pendingSwitchboardIntegration\": {\n    \"id\": \"5ef21b86e933b7355c11c604\",\n    \"name\": \"bot\",\n    \"integrationId\": \"5ef21b86e933b7355c11c605\",\n    \"integrationType\": \"zd:agentWorkspace\"\n   },\n   \"isDefault\": false,\n   \"displayName\": \"dolo\",\n   \"description\": \"Conversation between Rogers and Carl.\",\n   \"iconUrl\": \"https://www.gravatar.com/image.jpg\",\n   \"metadata\": {\n    \"lang\": \"en-ca\"\n   },\n   \"businessLastRead\": \"2020-06-23T14:33:47.492Z\",\n   \"lastUpdatedAt\": \"2020-06-26T14:33:47.120Z\"\n  },\n  {\n   \"id\": \"c93bb9c14dde8ffb94564eae\",\n   \"type\": \"personal\",\n   \"activeSwitchboardIntegration\": {\n    \"id\": \"5ef21b86e933b7355c11c604\",\n    \"name\": \"bot\",\n    \"integrationId\": \"5ef21b86e933b7355c11c605\",\n    \"integrationType\": \"zd:agentWorkspace\"\n   },\n   \"pendingSwitchboardIntegration\": {\n    \"id\": \"5ef21b86e933b7355c11c604\",\n    \"name\": \"bot\",\n    \"integrationId\": \"5ef21b86e933b7355c11c605\",\n    \"integrationType\": \"zd:agentWorkspace\"\n   },\n   \"isDefault\": false,\n   \"displayName\": \"ut s\",\n   \"description\": \"Conversation between Rogers and Carl.\",\n   \"iconUrl\": \"https://www.gravatar.com/image.jpg\",\n   \"metadata\": {\n    \"lang\": \"en-ca\"\n   },\n   \"businessLastRead\": \"2020-06-23T14:33:47.492Z\",\n   \"lastUpdatedAt\": \"2020-06-26T14:33:47.120Z\"\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": "6626d909-8a14-4f6b-ad72-53f862c5f11e",
      "name": "User not found",
      "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/:appId/conversations?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10&filter[userId]=incididunt ea proident in sit&filter[userExternalId]=occaecat sed",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "conversations"
          ],
          "query": [
            {
              "key": "page[after]",
              "value": "5e1606762556d93e9c176f69"
            },
            {
              "key": "page[before]",
              "value": "5e1606762556d93e9c176f69"
            },
            {
              "key": "page[size]",
              "value": "10"
            },
            {
              "key": "filter[userId]",
              "value": "incididunt ea proident in sit"
            },
            {
              "key": "filter[userExternalId]",
              "value": "occaecat sed"
            }
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}