Chilkat Online Tools

Foxpro / Sunshine Conversations API / List Clients

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcV_type
LOCAL lcStatus
LOCAL lcIntegrationId
LOCAL lcExternalId
LOCAL lcLastSeen
LOCAL lcLinkedAt
LOCAL lcDisplayName
LOCAL lcAvatarUrl
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.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

loHttp.BasicAuth = 1
loHttp.Login = "username"
loHttp.Password = "password"

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("page[after]","5e1606762556d93e9c176f69")
loQueryParams.UpdateString("page[before]","5e1606762556d93e9c176f69")
loQueryParams.UpdateInt("page[size]",10)

loResp = loHttp.QuickRequestParams("GET","https://domain.com/v2/apps/{{appId}}/users/:userIdOrExternalId/clients",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loQueryParams
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.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)

* {
*   "clients": [
*     {
*       "id": "5c9a34160c89726709136733",
*       "type": "telegram",
*       "status": "active",
*       "integrationId": "582dedf230e788746891281a",
*       "externalId": "your-own-id",
*       "lastSeen": "2020-08-20T16:13:07.462Z",
*       "linkedAt": "2020-06-23T14:33:47.492Z",
*       "displayName": "Steve",
*       "avatarUrl": "http://FyCxWeGPlJnZUcHsnFgIcfwVDdHd.dpueX8iJUlDIHClHNkd2I20OTKQLPVs8bVOVUBbGvT1n-",
*       "info": {},
*       "raw": {}
*     },
*     {
*       "id": "5c9a34160c89726709136733",
*       "type": "telegram",
*       "status": "active",
*       "integrationId": "582dedf230e788746891281a",
*       "externalId": "your-own-id",
*       "lastSeen": "2020-08-20T16:13:07.462Z",
*       "linkedAt": "2020-06-23T14:33:47.492Z",
*       "displayName": "Steve",
*       "avatarUrl": "http://TcKCiyuxrvZpuRTjBbrogTxoG.vjdxDLAN2iji7OauGJ5ui0l5aJDsCm+s5jxv+ORX6ILS-AiyUv,EWcEBviIVSpM1a05HdCgBkl22X",
*       "info": {},
*       "raw": {}
*     }
*   ],
*   "meta": {
*     "hasMore": false,
*     "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("clients")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("clients[i].id")
    lcV_type = loJResp.StringOf("clients[i].type")
    lcStatus = loJResp.StringOf("clients[i].status")
    lcIntegrationId = loJResp.StringOf("clients[i].integrationId")
    lcExternalId = loJResp.StringOf("clients[i].externalId")
    lcLastSeen = loJResp.StringOf("clients[i].lastSeen")
    lcLinkedAt = loJResp.StringOf("clients[i].linkedAt")
    lcDisplayName = loJResp.StringOf("clients[i].displayName")
    lcAvatarUrl = loJResp.StringOf("clients[i].avatarUrl")
    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"
	-u 'username:password'
https://domain.com/v2/apps/{{appId}}/users/:userIdOrExternalId/clients

Postman Collection Item JSON

{
  "name": "List Clients",
  "_postman_id": "6302f027-d4a1-4272-a03c-276ea7ac4ac6",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{url}}/v2/apps/{{appId}}/users/:userIdOrExternalId/clients?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10",
      "host": [
        "{{url}}"
      ],
      "path": [
        "v2",
        "apps",
        "{{appId}}",
        "users",
        ":userIdOrExternalId",
        "clients"
      ],
      "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."
        }
      ],
      "variable": [
        {
          "key": "userIdOrExternalId"
        }
      ]
    },
    "description": "Get all the clients for a particular user, including both linked clients and pending clients.\nThis API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits).\n\n```shell\n/v2/apps/:appId/users/:userId/clients?page[after]=5ebee0975ac5304b664a12fa\n```\n"
  },
  "response": [
    {
      "id": "2ec3b760-42a8-44d5-af25-526c4149390b",
      "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/users/:userIdOrExternalId/clients?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "users",
            ":userIdOrExternalId",
            "clients"
          ],
          "query": [
            {
              "key": "page[after]",
              "value": "5e1606762556d93e9c176f69"
            },
            {
              "key": "page[before]",
              "value": "5e1606762556d93e9c176f69"
            },
            {
              "key": "page[size]",
              "value": "10"
            }
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "userIdOrExternalId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"clients\": [\n  {\n   \"id\": \"5c9a34160c89726709136733\",\n   \"type\": \"telegram\",\n   \"status\": \"active\",\n   \"integrationId\": \"582dedf230e788746891281a\",\n   \"externalId\": \"your-own-id\",\n   \"lastSeen\": \"2020-08-20T16:13:07.462Z\",\n   \"linkedAt\": \"2020-06-23T14:33:47.492Z\",\n   \"displayName\": \"Steve\",\n   \"avatarUrl\": \"http://FyCxWeGPlJnZUcHsnFgIcfwVDdHd.dpueX8iJUlDIHClHNkd2I20OTKQLPVs8bVOVUBbGvT1n-\",\n   \"info\": {},\n   \"raw\": {}\n  },\n  {\n   \"id\": \"5c9a34160c89726709136733\",\n   \"type\": \"telegram\",\n   \"status\": \"active\",\n   \"integrationId\": \"582dedf230e788746891281a\",\n   \"externalId\": \"your-own-id\",\n   \"lastSeen\": \"2020-08-20T16:13:07.462Z\",\n   \"linkedAt\": \"2020-06-23T14:33:47.492Z\",\n   \"displayName\": \"Steve\",\n   \"avatarUrl\": \"http://TcKCiyuxrvZpuRTjBbrogTxoG.vjdxDLAN2iji7OauGJ5ui0l5aJDsCm+s5jxv+ORX6ILS-AiyUv,EWcEBviIVSpM1a05HdCgBkl22X\",\n   \"info\": {},\n   \"raw\": {}\n  }\n ],\n \"meta\": {\n  \"hasMore\": false,\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}"
    }
  ]
}