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
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.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'
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "author": {
-- "type": "business",
-- "displayName": "Steve",
-- "avatarUrl": "https://www.gravatar.com/image.jpg"
-- },
-- "content": {
-- "type": "text",
-- "text": "Hello!"
-- },
-- "metadata": {
-- "lang": "en-ca"
-- }
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'author.type', 'business'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'author.displayName', 'Steve'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'author.avatarUrl', 'https://www.gravatar.com/image.jpg'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'content.type', 'text'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'content.text', 'Hello!'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'metadata.lang', 'en-ca'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/', 'application/json', @json
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 @json
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.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 @json
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)
-- {
-- "messages": [
-- {
-- "id": "5f748c1a2b5315fc007e7977",
-- "received": "2020-09-30T13:46:02.733Z",
-- "author": {
-- "type": "business",
-- "displayName": "Steve",
-- "avatarUrl": "https://www.gravatar.com/image.jpg"
-- },
-- "content": {
-- "type": "text",
-- "text": "Hello!"
-- },
-- "metadata": {
-- "lang": "en-ca"
-- },
-- "source": {
-- "type": "api:conversations"
-- }
-- }
-- ]
-- }
-- 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 @received nvarchar(4000)
DECLARE @v_Type nvarchar(4000)
DECLARE @DisplayName nvarchar(4000)
DECLARE @AvatarUrl nvarchar(4000)
DECLARE @contentType nvarchar(4000)
DECLARE @Text nvarchar(4000)
DECLARE @Lang nvarchar(4000)
DECLARE @sourceType nvarchar(4000)
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'messages'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'messages[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @received OUT, 'messages[i].received'
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'messages[i].author.type'
EXEC sp_OAMethod @jResp, 'StringOf', @DisplayName OUT, 'messages[i].author.displayName'
EXEC sp_OAMethod @jResp, 'StringOf', @AvatarUrl OUT, 'messages[i].author.avatarUrl'
EXEC sp_OAMethod @jResp, 'StringOf', @contentType OUT, 'messages[i].content.type'
EXEC sp_OAMethod @jResp, 'StringOf', @Text OUT, 'messages[i].content.text'
EXEC sp_OAMethod @jResp, 'StringOf', @Lang OUT, 'messages[i].metadata.lang'
EXEC sp_OAMethod @jResp, 'StringOf', @sourceType OUT, 'messages[i].source.type'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X POST
-u 'username:password'
-H "Content-Type: application/json"
-d '{
"author": {
"type": "business",
"displayName": "Steve",
"avatarUrl": "https://www.gravatar.com/image.jpg"
},
"content": {
"type": "text",
"text": "Hello!"
},
"metadata": {
"lang": "en-ca"
}
}'
https://domain.com/
Postman Collection Item JSON
{
"name": "Post Message",
"_postman_id": "28e280a8-5ef8-4ca0-90fc-788603ddd036",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"author\": {\n \"type\": \"business\",\n \"displayName\": \"Steve\",\n \"avatarUrl\": \"https://www.gravatar.com/image.jpg\"\n },\n \"content\": {\n \"type\": \"text\",\n \"text\": \"Hello!\"\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n}"
},
"url": "{{url}}/v2/apps/{{appId}}/conversations/{{conversationId}}/messages",
"description": "Send a message in a particular conversation."
},
"response": [
{
"id": "f660acde-ae81-4787-b433-18bf650ddef6",
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer <token>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"author\": {\n \"type\": \"business\",\n \"displayName\": \"Steve\",\n \"avatarUrl\": \"https://www.gravatar.com/image.jpg\"\n },\n \"content\": {\n \"type\": \"text\",\n \"text\": \"Hello!\"\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n }\n}"
},
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/conversations/:conversationId/messages",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"conversations",
":conversationId",
"messages"
],
"variable": [
{
"key": "appId"
},
{
"key": "conversationId"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"messages\": [\n {\n \"id\": \"5f748c1a2b5315fc007e7977\",\n \"received\": \"2020-09-30T13:46:02.733Z\",\n \"author\": {\n \"type\": \"business\",\n \"displayName\": \"Steve\",\n \"avatarUrl\": \"https://www.gravatar.com/image.jpg\"\n },\n \"content\": {\n \"type\": \"text\",\n \"text\": \"Hello!\"\n },\n \"metadata\": {\n \"lang\": \"en-ca\"\n },\n \"source\": {\n \"type\": \"api:conversations\"\n }\n }\n ]\n}"
}
]
}
