Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
http.BasicAuth = True
http.Login = "username"
http.Password = "password"
Dim queryParams As New Chilkat.JsonObject
success = queryParams.UpdateString("page[after]","5e1606762556d93e9c176f69")
success = queryParams.UpdateString("page[before]","5e1606762556d93e9c176f69")
success = queryParams.UpdateInt("page[size]",10)
Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/v2/apps/{{appId}}/conversations/{{conversationId}}/participants",queryParams)
If (http.LastMethodSuccess = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())
Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
System.DebugLog("Response Header:")
System.DebugLog(resp.Header)
System.DebugLog("Failed.")
Return
End If
// 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
Dim id As String
Dim userId As String
Dim unreadCount As Int32
Dim userExternalId As String
Dim lastRead As String
Dim j As Int32
Dim count_j As Int32
Dim v_type As String
Dim clientId As String
Dim HasMore As Boolean
HasMore = jResp.BoolOf("meta.hasMore")
Dim AfterCursor As String
AfterCursor = jResp.StringOf("meta.afterCursor")
Dim BeforeCursor As String
BeforeCursor = jResp.StringOf("meta.beforeCursor")
Dim Prev As String
Prev = jResp.StringOf("links.prev")
Dim v_Next As String
v_Next = jResp.StringOf("links.next")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("participants")
While i < count_i
jResp.I = i
id = jResp.StringOf("participants[i].id")
userId = jResp.StringOf("participants[i].userId")
unreadCount = jResp.IntOf("participants[i].unreadCount")
userExternalId = jResp.StringOf("participants[i].userExternalId")
lastRead = jResp.StringOf("participants[i].lastRead")
j = 0
count_j = jResp.SizeOfArray("participants[i].clientAssociations")
While j < count_j
jResp.J = j
v_type = jResp.StringOf("participants[i].clientAssociations[j].type")
clientId = jResp.StringOf("participants[i].clientAssociations[j].clientId")
j = j + 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}"
}
]
}
