Chilkat Online Tools

VB6 / Sunshine Conversations API / List Integrations

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 ChilkatHttp
Dim success As Long

http.BasicAuth = 1
http.Login = "username"
http.Password = "password"

Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateString("page[after]","5e1606762556d93e9c176f69")
success = queryParams.UpdateString("page[before]","5e1606762556d93e9c176f69")
success = queryParams.UpdateInt("page[size]",10)
success = queryParams.UpdateString("filter[types]","android,ios")

Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://domain.com/v2/apps/{{appId}}/integrations",queryParams)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

' 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

Dim id As String
Dim v_type As String
Dim status As String
Dim displayName As String
Dim serverId As String
Dim canUserCreateMoreConversations As Long

Dim HasMore As Long
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 After As String
After = jResp.StringOf("links.after")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("integrations")
Do 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
Loop

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