Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcV_type
LOCAL lcId
LOCAL lcName
LOCAL lcIntegrationId
LOCAL lcIntegrationType
LOCAL lcPendingSwitchboardIntegrationId
LOCAL lcPendingSwitchboardIntegrationName
LOCAL lcPendingSwitchboardIntegrationIntegrationId
LOCAL lcPendingSwitchboardIntegrationIntegrationType
LOCAL lnIsDefault
LOCAL lcDisplayName
LOCAL lcDescription
LOCAL lcIconUrl
LOCAL lcLang
LOCAL lcBusinessLastRead
LOCAL lcLastUpdatedAt
LOCAL lnHasMore
LOCAL lcAfterCursor
LOCAL lcBeforeCursor
LOCAL lcPrev
LOCAL lcV_Next
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loHttp.BasicAuth = 1
loHttp.Login = "username"
loHttp.Password = "password"
loQueryParams = CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams.UpdateString("page[after]","5e1606762556d93e9c176f69")
loQueryParams.UpdateString("page[before]","5e1606762556d93e9c176f69")
loQueryParams.UpdateInt("page[size]",10)
loQueryParams.UpdateString("filter[userId]","incididunt ea proident in sit")
loQueryParams.UpdateString("filter[userExternalId]","occaecat sed")
loResp = loHttp.QuickRequestParams("GET","https://domain.com/v2/apps/{{appId}}/conversations",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lnHasMore = loJResp.BoolOf("meta.hasMore")
lcAfterCursor = loJResp.StringOf("meta.afterCursor")
lcBeforeCursor = loJResp.StringOf("meta.beforeCursor")
lcPrev = loJResp.StringOf("links.prev")
lcV_Next = loJResp.StringOf("links.next")
i = 0
lnCount_i = loJResp.SizeOfArray("conversations")
DO WHILE i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("conversations[i].id")
lcV_type = loJResp.StringOf("conversations[i].type")
lcId = loJResp.StringOf("conversations[i].activeSwitchboardIntegration.id")
lcName = loJResp.StringOf("conversations[i].activeSwitchboardIntegration.name")
lcIntegrationId = loJResp.StringOf("conversations[i].activeSwitchboardIntegration.integrationId")
lcIntegrationType = loJResp.StringOf("conversations[i].activeSwitchboardIntegration.integrationType")
lcPendingSwitchboardIntegrationId = loJResp.StringOf("conversations[i].pendingSwitchboardIntegration.id")
lcPendingSwitchboardIntegrationName = loJResp.StringOf("conversations[i].pendingSwitchboardIntegration.name")
lcPendingSwitchboardIntegrationIntegrationId = loJResp.StringOf("conversations[i].pendingSwitchboardIntegration.integrationId")
lcPendingSwitchboardIntegrationIntegrationType = loJResp.StringOf("conversations[i].pendingSwitchboardIntegration.integrationType")
lnIsDefault = loJResp.BoolOf("conversations[i].isDefault")
lcDisplayName = loJResp.StringOf("conversations[i].displayName")
lcDescription = loJResp.StringOf("conversations[i].description")
lcIconUrl = loJResp.StringOf("conversations[i].iconUrl")
lcLang = loJResp.StringOf("conversations[i].metadata.lang")
lcBusinessLastRead = loJResp.StringOf("conversations[i].businessLastRead")
lcLastUpdatedAt = loJResp.StringOf("conversations[i].lastUpdatedAt")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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": ""
}
]
}
