Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_V_type
string ls_Status
string ls_IntegrationId
string ls_ExternalId
string ls_LastSeen
string ls_LinkedAt
string ls_DisplayName
string ls_AvatarUrl
integer li_HasMore
string ls_AfterCursor
string ls_BeforeCursor
string ls_Prev
string ls_V_Next
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "username"
loo_Http.Password = "password"
loo_QueryParams = create oleobject
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_QueryParams.UpdateString("page[after]","5e1606762556d93e9c176f69")
loo_QueryParams.UpdateString("page[before]","5e1606762556d93e9c176f69")
loo_QueryParams.UpdateInt("page[size]",10)
loo_Resp = loo_Http.QuickRequestParams("GET","https://domain.com/v2/apps/{{appId}}/users/:userIdOrExternalId/clients",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// 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
li_HasMore = loo_JResp.BoolOf("meta.hasMore")
ls_AfterCursor = loo_JResp.StringOf("meta.afterCursor")
ls_BeforeCursor = loo_JResp.StringOf("meta.beforeCursor")
ls_Prev = loo_JResp.StringOf("links.prev")
ls_V_Next = loo_JResp.StringOf("links.next")
i = 0
li_Count_i = loo_JResp.SizeOfArray("clients")
do while i < li_Count_i
loo_JResp.I = i
ls_Id = loo_JResp.StringOf("clients[i].id")
ls_V_type = loo_JResp.StringOf("clients[i].type")
ls_Status = loo_JResp.StringOf("clients[i].status")
ls_IntegrationId = loo_JResp.StringOf("clients[i].integrationId")
ls_ExternalId = loo_JResp.StringOf("clients[i].externalId")
ls_LastSeen = loo_JResp.StringOf("clients[i].lastSeen")
ls_LinkedAt = loo_JResp.StringOf("clients[i].linkedAt")
ls_DisplayName = loo_JResp.StringOf("clients[i].displayName")
ls_AvatarUrl = loo_JResp.StringOf("clients[i].avatarUrl")
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
