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[types]', 'android,ios'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://domain.com/v2/apps/{{appId}}/integrations', @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)
-- {
-- "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
DECLARE @id nvarchar(4000)
DECLARE @v_type nvarchar(4000)
DECLARE @status nvarchar(4000)
DECLARE @displayName nvarchar(4000)
DECLARE @serverId nvarchar(4000)
DECLARE @canUserCreateMoreConversations int
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 @After nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @After OUT, 'links.after'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'integrations'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'integrations[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'integrations[i].type'
EXEC sp_OAMethod @jResp, 'StringOf', @status OUT, 'integrations[i].status'
EXEC sp_OAMethod @jResp, 'StringOf', @displayName OUT, 'integrations[i].displayName'
EXEC sp_OAMethod @jResp, 'StringOf', @serverId OUT, 'integrations[i].serverId'
EXEC sp_OAMethod @jResp, 'BoolOf', @canUserCreateMoreConversations OUT, 'integrations[i].canUserCreateMoreConversations'
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[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}"
}
]
}
