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)
success = queryParams.UpdateString("filter[serviceAccountId]","laborum consectetur id")
Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/v2/apps",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)
// {
// "apps": [
// {
// "id": "5d8cff3cd55b040010928b5b",
// "displayName": "ipsu",
// "settings": {
// "conversationRetentionSeconds": 55645305,
// "maskCreditCardNumbers": true,
// "useAnimalNames": true,
// "echoPostback": false,
// "ignoreAutoConversationStart": false,
// "multiConvoEnabled": false,
// "attachmentsAccess": "public",
// "attachmentsTokenExpirationSeconds": 64028
// },
// "metadata": {
// "lang": "en-ca"
// }
// },
// {
// "id": "5d8cff3cd55b040010928b5b",
// "displayName": "Exce",
// "settings": {
// "conversationRetentionSeconds": 1491566,
// "maskCreditCardNumbers": false,
// "useAnimalNames": true,
// "echoPostback": true,
// "ignoreAutoConversationStart": true,
// "multiConvoEnabled": false,
// "attachmentsAccess": "public",
// "attachmentsTokenExpirationSeconds": 64028
// },
// "metadata": {
// "lang": "en-ca"
// }
// }
// ],
// "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 displayName As String
Dim ConversationRetentionSeconds As Int32
Dim MaskCreditCardNumbers As Boolean
Dim UseAnimalNames As Boolean
Dim EchoPostback As Boolean
Dim IgnoreAutoConversationStart As Boolean
Dim MultiConvoEnabled As Boolean
Dim AttachmentsAccess As String
Dim AttachmentsTokenExpirationSeconds As Int32
Dim Lang 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("apps")
While i < count_i
jResp.I = i
id = jResp.StringOf("apps[i].id")
displayName = jResp.StringOf("apps[i].displayName")
ConversationRetentionSeconds = jResp.IntOf("apps[i].settings.conversationRetentionSeconds")
MaskCreditCardNumbers = jResp.BoolOf("apps[i].settings.maskCreditCardNumbers")
UseAnimalNames = jResp.BoolOf("apps[i].settings.useAnimalNames")
EchoPostback = jResp.BoolOf("apps[i].settings.echoPostback")
IgnoreAutoConversationStart = jResp.BoolOf("apps[i].settings.ignoreAutoConversationStart")
MultiConvoEnabled = jResp.BoolOf("apps[i].settings.multiConvoEnabled")
AttachmentsAccess = jResp.StringOf("apps[i].settings.attachmentsAccess")
AttachmentsTokenExpirationSeconds = jResp.IntOf("apps[i].settings.attachmentsTokenExpirationSeconds")
Lang = jResp.StringOf("apps[i].metadata.lang")
i = i + 1
Wend
Curl Command
curl -G -d "page[after]=5e1606762556d93e9c176f69"
-d "page[before]=5e1606762556d93e9c176f69"
-d "page[size]=10"
-d "filter[serviceAccountId]=laborum%20consectetur%20id"
-u 'username:password'
https://domain.com/v2/apps
Postman Collection Item JSON
{
"name": "List Apps",
"_postman_id": "9e945a28-9ef0-4a15-92ad-f6b39c1223ce",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{url}}/v2/apps?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10&filter[serviceAccountId]=laborum consectetur id",
"host": [
"{{url}}"
],
"path": [
"v2",
"apps"
],
"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[serviceAccountId]",
"value": "laborum consectetur id",
"description": "Contains parameters for filtering the results."
}
]
},
"description": "Lists all apps that a user is part of. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits). \n```shell\n/v2/apps?page[after]=5e1606762556d93e9c176f69&page[size]=10\n```\n"
},
"response": [
{
"id": "20d18287-f52c-47f5-b6c5-ff8ecd484eeb",
"name": "Can supply only one of page[after] or page[before], not both",
"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?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10&filter[serviceAccountId]=laborum consectetur id",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps"
],
"query": [
{
"key": "page[after]",
"value": "5e1606762556d93e9c176f69"
},
{
"key": "page[before]",
"value": "5e1606762556d93e9c176f69"
},
{
"key": "page[size]",
"value": "10"
},
{
"key": "filter[serviceAccountId]",
"value": "laborum consectetur id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"id": "8bc21ad8-9781-42a8-8e87-e25a48c04d58",
"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?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10&filter[serviceAccountId]=laborum consectetur id",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps"
],
"query": [
{
"key": "page[after]",
"value": "5e1606762556d93e9c176f69"
},
{
"key": "page[before]",
"value": "5e1606762556d93e9c176f69"
},
{
"key": "page[size]",
"value": "10"
},
{
"key": "filter[serviceAccountId]",
"value": "laborum consectetur id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"apps\": [\n {\n \"id\": \"5d8cff3cd55b040010928b5b\",\n \"displayName\": \"ipsu\",\n \"settings\": {\n \"conversationRetentionSeconds\": 55645305,\n \"maskCreditCardNumbers\": true,\n \"useAnimalNames\": true,\n \"echoPostback\": false,\n \"ignoreAutoConversationStart\": false,\n \"multiConvoEnabled\": false,\n \"attachmentsAccess\": \"public\",\n \"attachmentsTokenExpirationSeconds\": 64028\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n },\n {\n \"id\": \"5d8cff3cd55b040010928b5b\",\n \"displayName\": \"Exce\",\n \"settings\": {\n \"conversationRetentionSeconds\": 1491566,\n \"maskCreditCardNumbers\": false,\n \"useAnimalNames\": true,\n \"echoPostback\": true,\n \"ignoreAutoConversationStart\": true,\n \"multiConvoEnabled\": false,\n \"attachmentsAccess\": \"public\",\n \"attachmentsTokenExpirationSeconds\": 64028\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\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}"
},
{
"id": "f3936c25-49e4-421f-9fb2-c6b58a66a999",
"name": "The serviceAccountId provided does not match supplied credentials",
"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?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10&filter[serviceAccountId]=laborum consectetur id",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps"
],
"query": [
{
"key": "page[after]",
"value": "5e1606762556d93e9c176f69"
},
{
"key": "page[before]",
"value": "5e1606762556d93e9c176f69"
},
{
"key": "page[size]",
"value": "10"
},
{
"key": "filter[serviceAccountId]",
"value": "laborum consectetur id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
