SQL Server / Infobip WhatsApp / Send WhatsApp template message
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
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "messages": [
-- {
-- "from": "{{senderNumber}}",
-- "to": "{{receiverNumber}}",
-- "messageId": "test-message-{{$randomInt}}",
-- "content": {
-- "templateName": "boarding_pass",
-- "templateData": {
-- "body": {
-- "placeholders": [
-- "123456789"
-- ]
-- },
-- "header": {
-- "type": "IMAGE",
-- "mediaUrl": "{{exampleImagePath}}"
-- }
-- },
-- "language": "en"
-- },
-- "callbackData": "Callback data"
-- }
-- ]
-- }
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'messages[0].from', '{{senderNumber}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'messages[0].to', '{{receiverNumber}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'messages[0].messageId', 'test-message-{{$randomInt}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'messages[0].content.templateName', 'boarding_pass'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'messages[0].content.templateData.body.placeholders[0]', '123456789'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'messages[0].content.templateData.header.type', 'IMAGE'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'messages[0].content.templateData.header.mediaUrl', '{{exampleImagePath}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'messages[0].content.language', 'en'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'messages[0].callbackData', 'Callback data'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', 'App {{INFOBIP_API_KEY}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/whatsapp/1/message/template', '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
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 @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": [
-- {
-- "to": "441134960001",
-- "messageCount": 1,
-- "messageId": "test-message-448",
-- "status": {
-- "groupId": 1,
-- "groupName": "PENDING",
-- "id": 7,
-- "name": "PENDING_ENROUTE",
-- "description": "Message sent to next instance",
-- "action": null
-- }
-- }
-- ],
-- "bulkId": null
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @v_to nvarchar(4000)
DECLARE @messageCount int
DECLARE @messageId nvarchar(4000)
DECLARE @GroupId int
DECLARE @GroupName nvarchar(4000)
DECLARE @Id int
DECLARE @Name nvarchar(4000)
DECLARE @Description nvarchar(4000)
DECLARE @Action nvarchar(4000)
DECLARE @bulkId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @bulkId OUT, 'bulkId'
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', @v_to OUT, 'messages[i].to'
EXEC sp_OAMethod @jResp, 'IntOf', @messageCount OUT, 'messages[i].messageCount'
EXEC sp_OAMethod @jResp, 'StringOf', @messageId OUT, 'messages[i].messageId'
EXEC sp_OAMethod @jResp, 'IntOf', @GroupId OUT, 'messages[i].status.groupId'
EXEC sp_OAMethod @jResp, 'StringOf', @GroupName OUT, 'messages[i].status.groupName'
EXEC sp_OAMethod @jResp, 'IntOf', @Id OUT, 'messages[i].status.id'
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'messages[i].status.name'
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'messages[i].status.description'
EXEC sp_OAMethod @jResp, 'StringOf', @Action OUT, 'messages[i].status.action'
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
-H "Authorization: App {{INFOBIP_API_KEY}}"
-H "Content-Type: application/json"
-d '{
"messages": [
{
"from": "{{senderNumber}}",
"to": "{{receiverNumber}}",
"messageId": "test-message-{{$randomInt}}",
"content": {
"templateName": "boarding_pass",
"templateData": {
"body": {
"placeholders": [
"123456789"
]
},
"header": {
"type": "IMAGE",
"mediaUrl": "{{exampleImagePath}}"
}
},
"language": "en"
},
"callbackData": "Callback data"
}
]
}'
https://domain.com/whatsapp/1/message/template
Postman Collection Item JSON
{
"name": "Send WhatsApp template message",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is 200\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"Message sent successfully\", function () {",
" var jsonData = pm.response.json();",
" pm.expect(jsonData.messages[0].status.description).to.eql(\"Message sent to next instance\");",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"messages\": [\n {\n \"from\": \"{{senderNumber}}\",\n \"to\": \"{{receiverNumber}}\",\n \"messageId\": \"test-message-{{$randomInt}}\",\n \"content\": {\n \"templateName\": \"boarding_pass\",\n \"templateData\": {\n \"body\": {\n \"placeholders\": [\n \"123456789\"\n ]\n },\n \"header\": {\n \"type\": \"IMAGE\",\n \"mediaUrl\": \"{{exampleImagePath}}\"\n }\n },\n \"language\": \"en\"\n },\n \"callbackData\": \"Callback data\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/whatsapp/1/message/template",
"host": [
"{{baseUrl}}"
],
"path": [
"whatsapp",
"1",
"message",
"template"
]
},
"description": "Send a single or multiple template messages to a one or more recipients. Template messages can be sent and delivered at anytime. Each template sent needs to be registered and pre-approved by WhatsApp."
},
"response": [
{
"name": "Template message \"boarding_pass\"",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"messages\": [\n {\n \"from\": \"{{senderNumber}}\",\n \"to\": \"{{receiverNumber}}\",\n \"messageId\": \"test-message-{{$randomInt}}\",\n \"content\": {\n \"templateName\": \"boarding_pass\",\n \"templateData\": {\n \"body\": {\n \"placeholders\": [\n \"123456789\"\n ]\n },\n \"header\": {\n \"type\": \"IMAGE\",\n \"mediaUrl\": \"{{exampleImagePath}}\"\n }\n },\n \"language\": \"en\"\n },\n \"callbackData\": \"Callback data\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/whatsapp/1/message/template",
"host": [
"{{baseUrl}}"
],
"path": [
"whatsapp",
"1",
"message",
"template"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Vary",
"value": "Origin"
},
{
"key": "Vary",
"value": "Access-Control-Request-Method"
},
{
"key": "Vary",
"value": "Access-Control-Request-Headers"
},
{
"key": "Date",
"value": "Mon, 08 Nov 2021 09:53:31 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Server",
"value": "SMS API"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "X-Request-Id",
"value": "1636365211773062836"
}
],
"cookie": [
],
"body": "{\n \"messages\": [\n {\n \"to\": \"441134960001\",\n \"messageCount\": 1,\n \"messageId\": \"test-message-448\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\",\n \"action\": null\n }\n }\n ],\n \"bulkId\": null\n}"
},
{
"name": "Template message \"invoice\"",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"messages\": [\n {\n \"from\": \"{{senderNumber}}\",\n \"to\": \"{{receiverNumber}}\",\n \"messageId\": \"test-message-{{$randomInt}}\",\n \"content\": {\n \"templateName\": \"invoice\",\n \"templateData\": {\n \"body\": {\n \"placeholders\": [\n \"User\",\n \"123456789\"\n ]\n },\n \"header\": {\n \"type\": \"DOCUMENT\",\n \"mediaUrl\": \"{{exampleDocumentPath}}\",\n \"filename\": \"ExampleDocumet.pdf\"\n }\n },\n \"language\": \"en\"\n },\n \"callbackData\": \"Callback data\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/whatsapp/1/message/template",
"host": [
"{{baseUrl}}"
],
"path": [
"whatsapp",
"1",
"message",
"template"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Vary",
"value": "Origin"
},
{
"key": "Vary",
"value": "Access-Control-Request-Method"
},
{
"key": "Vary",
"value": "Access-Control-Request-Headers"
},
{
"key": "Date",
"value": "Mon, 08 Nov 2021 10:08:28 GMT"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Server",
"value": "SMS API"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "X-Request-Id",
"value": "1636366108642122837"
}
],
"cookie": [
],
"body": "{\n \"messages\": [\n {\n \"to\": \"441134960001\",\n \"messageCount\": 1,\n \"messageId\": \"test-message-285\",\n \"status\": {\n \"groupId\": 1,\n \"groupName\": \"PENDING\",\n \"id\": 7,\n \"name\": \"PENDING_ENROUTE\",\n \"description\": \"Message sent to next instance\",\n \"action\": null\n }\n }\n ],\n \"bulkId\": null\n}"
}
]
}
