Chilkat Online Tools

Node.js / Sunshine Conversations API / List Participants

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var http = new chilkat.Http();
    var success;

    http.BasicAuth = true;
    http.Login = "username";
    http.Password = "password";

    var queryParams = new chilkat.JsonObject();
    queryParams.UpdateString("page[after]","5e1606762556d93e9c176f69");
    queryParams.UpdateString("page[before]","5e1606762556d93e9c176f69");
    queryParams.UpdateInt("page[size]",10);

    // resp: HttpResponse
    var resp = http.QuickRequestParams("GET","https://domain.com/v2/apps/{{appId}}/conversations/{{conversationId}}/participants",queryParams);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = resp.StatusCode;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(resp.Header);
        console.log("Failed.");

        return;
    }

    // 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

    var id;
    var userId;
    var unreadCount;
    var userExternalId;
    var lastRead;
    var j;
    var count_j;
    var v_type;
    var clientId;

    var HasMore = jResp.BoolOf("meta.hasMore");
    var AfterCursor = jResp.StringOf("meta.afterCursor");
    var BeforeCursor = jResp.StringOf("meta.beforeCursor");
    var Prev = jResp.StringOf("links.prev");
    var v_Next = jResp.StringOf("links.next");
    var i = 0;
    var 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;
        }

        i = i+1;
    }


}

chilkatExample();

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}"
    }
  ]
}