Chilkat Online Tools

Node.js / Sunshine Conversations API / List Integrations

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);
    queryParams.UpdateString("filter[types]","android,ios");

    // resp: HttpResponse
    var resp = http.QuickRequestParams("GET","https://domain.com/v2/apps/{{appId}}/integrations",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)

    // {
    //   "integrations": [
    //     {
    //       "id": "5e4af71a81966cfff3ef6550",
    //       "type": "android",
    //       "status": "active",
    //       "displayName": "Android",
    //       "serverId": "<sender-id>",
    //       "canUserCreateMoreConversations": true
    //     }
    //   ],
    //   "meta": {
    //     "hasMore": true,
    //     "afterCursor": "5e4af71a81966cfff3ef6550",
    //     "beforeCursor": "5e4af71a81966cfff3ef6550"
    //   },
    //   "links": {
    //     "prev": "https://api.smooch.io/v2/apps/5e4af71a81966cfff3ef6551/integrations?page[before]=5e4af71a81966cfff3ef6550",
    //     "after": "https://api.smooch.io/v2/apps/5e4af71a81966cfff3ef6551/integrations?page[after]=5e4af71a81966cfff3ef6550"
    //   }
    // }

    // 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 v_type;
    var status;
    var displayName;
    var serverId;
    var canUserCreateMoreConversations;

    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 After = jResp.StringOf("links.after");
    var i = 0;
    var count_i = jResp.SizeOfArray("integrations");
    while (i < count_i) {
        jResp.I = i;
        id = jResp.StringOf("integrations[i].id");
        v_type = jResp.StringOf("integrations[i].type");
        status = jResp.StringOf("integrations[i].status");
        displayName = jResp.StringOf("integrations[i].displayName");
        serverId = jResp.StringOf("integrations[i].serverId");
        canUserCreateMoreConversations = jResp.BoolOf("integrations[i].canUserCreateMoreConversations");
        i = i+1;
    }


}

chilkatExample();

Curl Command

curl -G -d "page[after]=5e1606762556d93e9c176f69"
	-d "page[before]=5e1606762556d93e9c176f69"
	-d "page[size]=10"
	-d "filter[types]=android,ios"
	-u 'username:password'
https://domain.com/v2/apps/{{appId}}/integrations

Postman Collection Item JSON

{
  "name": "List Integrations",
  "_postman_id": "910e1daa-764e-4d53-a9a8-dc911aeffeb5",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{url}}/v2/apps/{{appId}}/integrations?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10&filter[types]=android,ios",
      "host": [
        "{{url}}"
      ],
      "path": [
        "v2",
        "apps",
        "{{appId}}",
        "integrations"
      ],
      "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."
        },
        {
          "key": "filter[types]",
          "value": "android,ios",
          "description": "Contains parameters for filtering the results."
        }
      ]
    },
    "description": "List available integrations. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits).\n```shell\n/v2/apps/:appId/integrations?page[after]=5e1606762556d93e9c176f69&page[size]=10&filter[types]=custom,web\n```\n"
  },
  "response": [
    {
      "id": "5cc09374-9a2f-4d9e-95fd-f5bb91aa63d6",
      "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/integrations?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10&filter[types]=android,ios",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "integrations"
          ],
          "query": [
            {
              "key": "page[after]",
              "value": "5e1606762556d93e9c176f69"
            },
            {
              "key": "page[before]",
              "value": "5e1606762556d93e9c176f69"
            },
            {
              "key": "page[size]",
              "value": "10"
            },
            {
              "key": "filter[types]",
              "value": "android,ios"
            }
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"integrations\": [\n  {\n   \"id\": \"5e4af71a81966cfff3ef6550\",\n   \"type\": \"android\",\n   \"status\": \"active\",\n   \"displayName\": \"Android\",\n   \"serverId\": \"<sender-id>\",\n   \"canUserCreateMoreConversations\": true\n  }\n ],\n \"meta\": {\n  \"hasMore\": true,\n  \"afterCursor\": \"5e4af71a81966cfff3ef6550\",\n  \"beforeCursor\": \"5e4af71a81966cfff3ef6550\"\n },\n \"links\": {\n  \"prev\": \"https://api.smooch.io/v2/apps/5e4af71a81966cfff3ef6551/integrations?page[before]=5e4af71a81966cfff3ef6550\",\n  \"after\": \"https://api.smooch.io/v2/apps/5e4af71a81966cfff3ef6551/integrations?page[after]=5e4af71a81966cfff3ef6550\"\n }\n}"
    }
  ]
}