Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
http.put_BasicAuth(true)
http.put_Login("username")
http.put_Password("password")
queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("page[after]","5e1606762556d93e9c176f69")
queryParams.UpdateString("page[before]","5e1606762556d93e9c176f69")
queryParams.UpdateInt("page[size]",10)
queryParams.UpdateString("filter[types]","android,ios")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/v2/apps/{{appId}}/integrations",queryParams)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# 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
HasMore = jResp.BoolOf("meta.hasMore")
AfterCursor = jResp.stringOf("meta.afterCursor")
BeforeCursor = jResp.stringOf("meta.beforeCursor")
Prev = jResp.stringOf("links.prev")
After = jResp.stringOf("links.after")
i = 0
count_i = jResp.SizeOfArray("integrations")
while i < count_i
jResp.put_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
end
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}"
}
]
}
