Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "username"
$oHttp.Password = "password"
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("page[after]","5e1606762556d93e9c176f69")
$oQueryParams.UpdateString("page[before]","5e1606762556d93e9c176f69")
$oQueryParams.UpdateInt("page[size]",10)
Local $oResp = $oHttp.QuickRequestParams("GET","https://domain.com/v2/apps/{{appId}}/users/:userIdOrExternalId/clients",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sId
Local $sV_type
Local $status
Local $sIntegrationId
Local $sExternalId
Local $sLastSeen
Local $sLinkedAt
Local $sDisplayName
Local $sAvatarUrl
Local $bHasMore = $oJResp.BoolOf("meta.hasMore")
Local $sAfterCursor = $oJResp.StringOf("meta.afterCursor")
Local $sBeforeCursor = $oJResp.StringOf("meta.beforeCursor")
Local $sPrev = $oJResp.StringOf("links.prev")
Local $sV_Next = $oJResp.StringOf("links.next")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("clients")
While $i < $iCount_i
$oJResp.I = $i
$sId = $oJResp.StringOf("clients[i].id")
$sV_type = $oJResp.StringOf("clients[i].type")
$status = $oJResp.StringOf("clients[i].status")
$sIntegrationId = $oJResp.StringOf("clients[i].integrationId")
$sExternalId = $oJResp.StringOf("clients[i].externalId")
$sLastSeen = $oJResp.StringOf("clients[i].lastSeen")
$sLinkedAt = $oJResp.StringOf("clients[i].linkedAt")
$sDisplayName = $oJResp.StringOf("clients[i].displayName")
$sAvatarUrl = $oJResp.StringOf("clients[i].avatarUrl")
$i = $i + 1
Wend
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}"
}
]
}
