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}}/conversations/{{conversationId}}/participants",$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)
; {
; "participants": [
; {
; "id": "c93bb9c14dde8ffb94564eae",
; "userId": "42589ad070d43be9b00ff7e5",
; "unreadCount": 0,
; "clientAssociations": [
; {
; "type": "telegram",
; "clientId": "42589ad070d43be9b00ff7e5"
; },
; {
; "type": "telegram",
; "clientId": "42589ad070d43be9b00ff7e5"
; }
; ],
; "userExternalId": "your-own-id",
; "lastRead": "2019-01-14T18:55:12.515Z"
; },
; {
; "id": "c93bb9c14dde8ffb94564eae",
; "userId": "42589ad070d43be9b00ff7e5",
; "unreadCount": 0,
; "clientAssociations": [
; {
; "type": "telegram",
; "clientId": "42589ad070d43be9b00ff7e5"
; },
; {
; "type": "telegram",
; "clientId": "42589ad070d43be9b00ff7e5"
; }
; ],
; "userExternalId": "your-own-id",
; "lastRead": "2019-01-14T18:55:12.515Z"
; }
; ],
; "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
Local $sId
Local $sUserId
Local $iUnreadCount
Local $sUserExternalId
Local $sLastRead
Local $iJ
Local $iCount_j
Local $sV_type
Local $sClientId
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("participants")
While $i < $iCount_i
$oJResp.I = $i
$sId = $oJResp.StringOf("participants[i].id")
$sUserId = $oJResp.StringOf("participants[i].userId")
$iUnreadCount = $oJResp.IntOf("participants[i].unreadCount")
$sUserExternalId = $oJResp.StringOf("participants[i].userExternalId")
$sLastRead = $oJResp.StringOf("participants[i].lastRead")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("participants[i].clientAssociations")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sV_type = $oJResp.StringOf("participants[i].clientAssociations[j].type")
$sClientId = $oJResp.StringOf("participants[i].clientAssociations[j].clientId")
$iJ = $iJ + 1
Wend
$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}}/conversations/{{conversationId}}/participants
Postman Collection Item JSON
{
"name": "List Participants",
"_postman_id": "4993ad39-b009-4428-a2ad-a05921581fba",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{url}}/v2/apps/{{appId}}/conversations/{{conversationId}}/participants?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10",
"host": [
"{{url}}"
],
"path": [
"v2",
"apps",
"{{appId}}",
"conversations",
"{{conversationId}}",
"participants"
],
"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."
}
]
},
"description": "Lists all the participants of a particular conversation. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits).\n\n```shell\n/v2/apps/:appId/conversations/:conversationId/participants?page[before]=26508c10541a4b0ff472e5e2\n```\n"
},
"response": [
{
"id": "0162eeaf-e260-4fc2-98c6-4f9ff97448ec",
"name": "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/:conversationId/participants?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"conversations",
":conversationId",
"participants"
],
"query": [
{
"key": "page[after]",
"value": "5e1606762556d93e9c176f69"
},
{
"key": "page[before]",
"value": "5e1606762556d93e9c176f69"
},
{
"key": "page[size]",
"value": "10"
}
],
"variable": [
{
"key": "appId"
},
{
"key": "conversationId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"id": "e81409d2-ae22-409f-9a28-cb54df48f2f0",
"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/:conversationId/participants?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"conversations",
":conversationId",
"participants"
],
"query": [
{
"key": "page[after]",
"value": "5e1606762556d93e9c176f69"
},
{
"key": "page[before]",
"value": "5e1606762556d93e9c176f69"
},
{
"key": "page[size]",
"value": "10"
}
],
"variable": [
{
"key": "appId"
},
{
"key": "conversationId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"participants\": [\n {\n \"id\": \"c93bb9c14dde8ffb94564eae\",\n \"userId\": \"42589ad070d43be9b00ff7e5\",\n \"unreadCount\": 0,\n \"clientAssociations\": [\n {\n \"type\": \"telegram\",\n \"clientId\": \"42589ad070d43be9b00ff7e5\"\n },\n {\n \"type\": \"telegram\",\n \"clientId\": \"42589ad070d43be9b00ff7e5\"\n }\n ],\n \"userExternalId\": \"your-own-id\",\n \"lastRead\": \"2019-01-14T18:55:12.515Z\"\n },\n {\n \"id\": \"c93bb9c14dde8ffb94564eae\",\n \"userId\": \"42589ad070d43be9b00ff7e5\",\n \"unreadCount\": 0,\n \"clientAssociations\": [\n {\n \"type\": \"telegram\",\n \"clientId\": \"42589ad070d43be9b00ff7e5\"\n },\n {\n \"type\": \"telegram\",\n \"clientId\": \"42589ad070d43be9b00ff7e5\"\n }\n ],\n \"userExternalId\": \"your-own-id\",\n \"lastRead\": \"2019-01-14T18:55:12.515Z\"\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}"
}
]
}
