Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', 'username'
EXEC sp_OASetProperty @http, 'Password', 'password'
DECLARE @queryParams int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'page[after]', '5e1606762556d93e9c176f69'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'page[before]', '5e1606762556d93e9c176f69'
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'page[size]', 10
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'filter[userId]', 'incididunt ea proident in sit'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'filter[userExternalId]', 'occaecat sed'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://domain.com/v2/apps/{{appId}}/conversations', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "conversations": [
-- {
-- "id": "c93bb9c14dde8ffb94564eae",
-- "type": "personal",
-- "activeSwitchboardIntegration": {
-- "id": "5ef21b86e933b7355c11c604",
-- "name": "bot",
-- "integrationId": "5ef21b86e933b7355c11c605",
-- "integrationType": "zd:agentWorkspace"
-- },
-- "pendingSwitchboardIntegration": {
-- "id": "5ef21b86e933b7355c11c604",
-- "name": "bot",
-- "integrationId": "5ef21b86e933b7355c11c605",
-- "integrationType": "zd:agentWorkspace"
-- },
-- "isDefault": false,
-- "displayName": "dolo",
-- "description": "Conversation between Rogers and Carl.",
-- "iconUrl": "https://www.gravatar.com/image.jpg",
-- "metadata": {
-- "lang": "en-ca"
-- },
-- "businessLastRead": "2020-06-23T14:33:47.492Z",
-- "lastUpdatedAt": "2020-06-26T14:33:47.120Z"
-- },
-- {
-- "id": "c93bb9c14dde8ffb94564eae",
-- "type": "personal",
-- "activeSwitchboardIntegration": {
-- "id": "5ef21b86e933b7355c11c604",
-- "name": "bot",
-- "integrationId": "5ef21b86e933b7355c11c605",
-- "integrationType": "zd:agentWorkspace"
-- },
-- "pendingSwitchboardIntegration": {
-- "id": "5ef21b86e933b7355c11c604",
-- "name": "bot",
-- "integrationId": "5ef21b86e933b7355c11c605",
-- "integrationType": "zd:agentWorkspace"
-- },
-- "isDefault": false,
-- "displayName": "ut s",
-- "description": "Conversation between Rogers and Carl.",
-- "iconUrl": "https://www.gravatar.com/image.jpg",
-- "metadata": {
-- "lang": "en-ca"
-- },
-- "businessLastRead": "2020-06-23T14:33:47.492Z",
-- "lastUpdatedAt": "2020-06-26T14:33:47.120Z"
-- }
-- ],
-- "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
DECLARE @id nvarchar(4000)
DECLARE @v_type nvarchar(4000)
DECLARE @Id nvarchar(4000)
DECLARE @Name nvarchar(4000)
DECLARE @IntegrationId nvarchar(4000)
DECLARE @IntegrationType nvarchar(4000)
DECLARE @pendingSwitchboardIntegrationId nvarchar(4000)
DECLARE @pendingSwitchboardIntegrationName nvarchar(4000)
DECLARE @pendingSwitchboardIntegrationIntegrationId nvarchar(4000)
DECLARE @pendingSwitchboardIntegrationIntegrationType nvarchar(4000)
DECLARE @isDefault int
DECLARE @displayName nvarchar(4000)
DECLARE @description nvarchar(4000)
DECLARE @iconUrl nvarchar(4000)
DECLARE @Lang nvarchar(4000)
DECLARE @businessLastRead nvarchar(4000)
DECLARE @lastUpdatedAt nvarchar(4000)
DECLARE @HasMore int
EXEC sp_OAMethod @jResp, 'BoolOf', @HasMore OUT, 'meta.hasMore'
DECLARE @AfterCursor nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @AfterCursor OUT, 'meta.afterCursor'
DECLARE @BeforeCursor nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @BeforeCursor OUT, 'meta.beforeCursor'
DECLARE @Prev nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Prev OUT, 'links.prev'
DECLARE @v_Next nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Next OUT, 'links.next'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'conversations'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'conversations[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'conversations[i].type'
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'conversations[i].activeSwitchboardIntegration.id'
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'conversations[i].activeSwitchboardIntegration.name'
EXEC sp_OAMethod @jResp, 'StringOf', @IntegrationId OUT, 'conversations[i].activeSwitchboardIntegration.integrationId'
EXEC sp_OAMethod @jResp, 'StringOf', @IntegrationType OUT, 'conversations[i].activeSwitchboardIntegration.integrationType'
EXEC sp_OAMethod @jResp, 'StringOf', @pendingSwitchboardIntegrationId OUT, 'conversations[i].pendingSwitchboardIntegration.id'
EXEC sp_OAMethod @jResp, 'StringOf', @pendingSwitchboardIntegrationName OUT, 'conversations[i].pendingSwitchboardIntegration.name'
EXEC sp_OAMethod @jResp, 'StringOf', @pendingSwitchboardIntegrationIntegrationId OUT, 'conversations[i].pendingSwitchboardIntegration.integrationId'
EXEC sp_OAMethod @jResp, 'StringOf', @pendingSwitchboardIntegrationIntegrationType OUT, 'conversations[i].pendingSwitchboardIntegration.integrationType'
EXEC sp_OAMethod @jResp, 'BoolOf', @isDefault OUT, 'conversations[i].isDefault'
EXEC sp_OAMethod @jResp, 'StringOf', @displayName OUT, 'conversations[i].displayName'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'conversations[i].description'
EXEC sp_OAMethod @jResp, 'StringOf', @iconUrl OUT, 'conversations[i].iconUrl'
EXEC sp_OAMethod @jResp, 'StringOf', @Lang OUT, 'conversations[i].metadata.lang'
EXEC sp_OAMethod @jResp, 'StringOf', @businessLastRead OUT, 'conversations[i].businessLastRead'
EXEC sp_OAMethod @jResp, 'StringOf', @lastUpdatedAt OUT, 'conversations[i].lastUpdatedAt'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -G -d "page[after]=5e1606762556d93e9c176f69"
-d "page[before]=5e1606762556d93e9c176f69"
-d "page[size]=10"
-d "filter[userId]=incididunt%20ea%20proident%20in%20sit"
-d "filter[userExternalId]=occaecat%20sed"
-u 'username:password'
https://domain.com/v2/apps/{{appId}}/conversations
Postman Collection Item JSON
{
"name": "List Conversations",
"_postman_id": "90efc8c1-d5bf-4533-9c7e-89e994d67a11",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{url}}/v2/apps/{{appId}}/conversations?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10&filter[userId]=incididunt ea proident in sit&filter[userExternalId]=occaecat sed",
"host": [
"{{url}}"
],
"path": [
"v2",
"apps",
"{{appId}}",
"conversations"
],
"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[userId]",
"value": "incididunt ea proident in sit",
"description": "(Required) Contains parameters for filtering the results."
},
{
"key": "filter[userExternalId]",
"value": "occaecat sed",
"description": "(Required) Contains parameters for filtering the results."
}
]
},
"description": "Lists all conversations 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/:appId/conversations?filter[userId]=42589ad070d43be9b00ff7e5\n```\n"
},
"response": [
{
"id": "1cb978d1-7d9f-46e3-832b-bf0866adfc55",
"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?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10&filter[userId]=incididunt ea proident in sit&filter[userExternalId]=occaecat sed",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"conversations"
],
"query": [
{
"key": "page[after]",
"value": "5e1606762556d93e9c176f69"
},
{
"key": "page[before]",
"value": "5e1606762556d93e9c176f69"
},
{
"key": "page[size]",
"value": "10"
},
{
"key": "filter[userId]",
"value": "incididunt ea proident in sit"
},
{
"key": "filter[userExternalId]",
"value": "occaecat sed"
}
],
"variable": [
{
"key": "appId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"conversations\": [\n {\n \"id\": \"c93bb9c14dde8ffb94564eae\",\n \"type\": \"personal\",\n \"activeSwitchboardIntegration\": {\n \"id\": \"5ef21b86e933b7355c11c604\",\n \"name\": \"bot\",\n \"integrationId\": \"5ef21b86e933b7355c11c605\",\n \"integrationType\": \"zd:agentWorkspace\"\n },\n \"pendingSwitchboardIntegration\": {\n \"id\": \"5ef21b86e933b7355c11c604\",\n \"name\": \"bot\",\n \"integrationId\": \"5ef21b86e933b7355c11c605\",\n \"integrationType\": \"zd:agentWorkspace\"\n },\n \"isDefault\": false,\n \"displayName\": \"dolo\",\n \"description\": \"Conversation between Rogers and Carl.\",\n \"iconUrl\": \"https://www.gravatar.com/image.jpg\",\n \"metadata\": {\n \"lang\": \"en-ca\"\n },\n \"businessLastRead\": \"2020-06-23T14:33:47.492Z\",\n \"lastUpdatedAt\": \"2020-06-26T14:33:47.120Z\"\n },\n {\n \"id\": \"c93bb9c14dde8ffb94564eae\",\n \"type\": \"personal\",\n \"activeSwitchboardIntegration\": {\n \"id\": \"5ef21b86e933b7355c11c604\",\n \"name\": \"bot\",\n \"integrationId\": \"5ef21b86e933b7355c11c605\",\n \"integrationType\": \"zd:agentWorkspace\"\n },\n \"pendingSwitchboardIntegration\": {\n \"id\": \"5ef21b86e933b7355c11c604\",\n \"name\": \"bot\",\n \"integrationId\": \"5ef21b86e933b7355c11c605\",\n \"integrationType\": \"zd:agentWorkspace\"\n },\n \"isDefault\": false,\n \"displayName\": \"ut s\",\n \"description\": \"Conversation between Rogers and Carl.\",\n \"iconUrl\": \"https://www.gravatar.com/image.jpg\",\n \"metadata\": {\n \"lang\": \"en-ca\"\n },\n \"businessLastRead\": \"2020-06-23T14:33:47.492Z\",\n \"lastUpdatedAt\": \"2020-06-26T14:33:47.120Z\"\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": "6626d909-8a14-4f6b-ad72-53f862c5f11e",
"name": "User 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?page[after]=5e1606762556d93e9c176f69&page[before]=5e1606762556d93e9c176f69&page[size]=10&filter[userId]=incididunt ea proident in sit&filter[userExternalId]=occaecat sed",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"conversations"
],
"query": [
{
"key": "page[after]",
"value": "5e1606762556d93e9c176f69"
},
{
"key": "page[before]",
"value": "5e1606762556d93e9c176f69"
},
{
"key": "page[size]",
"value": "10"
},
{
"key": "filter[userId]",
"value": "incididunt ea proident in sit"
},
{
"key": "filter[userExternalId]",
"value": "occaecat sed"
}
],
"variable": [
{
"key": "appId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
