SQL Server / CleverTap API / Create Campaign API - Target Users by their Identities(WEB PUSH)
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
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "to": {
-- "FBID": [
-- "102029292929388",
-- "114342342453463"
-- ],
-- "GPID": [
-- "1928288389299292"
-- ],
-- "Email": [
-- "john@doe.com",
-- "jane@doe.com"
-- ],
-- "Identity": [
-- "JohnDoe"
-- ],
-- "objectId": [
-- "_asdnkansdjknaskdjnasjkndja",
-- "-adffajjdfoaiaefiohnefwprjf"
-- ]
-- },
-- "tag_group": "my tag group",
-- "respect_frequency_caps": false,
-- "content": {
-- "title": "Hi!",
-- "body": "How are you doing today?",
-- "platform_specific": {
-- "chrome": {
-- "image": "https://www.exampleImage.com",
-- "icon": "https://www.exampleIcon.com",
-- "deep_link": "http://www.example.com",
-- "ttl": 10,
-- "require_interaction": true,
-- "cta_title1": "title",
-- "cta_link1": "http://www.example2.com",
-- "cta_iconlink1": "https://www.exampleIcon2.com"
-- }
-- }
-- }
-- }
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, 'to.FBID[0]', '102029292929388'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'to.FBID[1]', '114342342453463'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'to.GPID[0]', '1928288389299292'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'to.Email[0]', 'john@doe.com'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'to.Email[1]', 'jane@doe.com'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'to.Identity[0]', 'JohnDoe'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'to.objectId[0]', '_asdnkansdjknaskdjnasjkndja'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'to.objectId[1]', '-adffajjdfoaiaefiohnefwprjf'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'tag_group', 'my tag group'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'respect_frequency_caps', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'content.title', 'Hi!'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'content.body', 'How are you doing today?'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'content.platform_specific.chrome.image', 'https://www.exampleImage.com'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'content.platform_specific.chrome.icon', 'https://www.exampleIcon.com'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'content.platform_specific.chrome.deep_link', 'http://www.example.com'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'content.platform_specific.chrome.ttl', 10
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'content.platform_specific.chrome.require_interaction', 1
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'content.platform_specific.chrome.cta_title1', 'title'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'content.platform_specific.chrome.cta_link1', 'http://www.example2.com'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'content.platform_specific.chrome.cta_iconlink1', 'https://www.exampleIcon2.com'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-CleverTap-Passcode', '{{passcode}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-CleverTap-Account-Id', '{{id}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', '{{type}}'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://api.clevertap.com/1/send/webpush.json', '{{type}}', @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
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
PRINT @iTmp0
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
END
GO
Curl Command
curl -X POST
-H "X-CleverTap-Account-Id: {{id}}"
-H "X-CleverTap-Passcode: {{passcode}}"
-H "Content-Type: {{type}}"
-d '{
"to": {
"FBID": [
"102029292929388",
"114342342453463"
],
"GPID": [
"1928288389299292"
],
"Email": [
"john@doe.com",
"jane@doe.com"
],
"Identity": [
"JohnDoe"
],
"objectId": [
"_asdnkansdjknaskdjnasjkndja",
"-adffajjdfoaiaefiohnefwprjf"
]
},
"tag_group": "my tag group",
"respect_frequency_caps": false,
"content": {
"title": "Hi!",
"body": "How are you doing today?",
"platform_specific": {
"chrome": {
"image": "https://www.exampleImage.com",
"icon":"https://www.exampleIcon.com",
"deep_link": "http://www.example.com",
"ttl":10,
"require_interaction":true,
"cta_title1":"title",
"cta_link1":"http://www.example2.com",
"cta_iconlink1":"https://www.exampleIcon2.com"
}
}
}
}'
https://api.clevertap.com/1/send/webpush.json
Postman Collection Item JSON
{
"name": "Create Campaign API - Target Users by their Identities(WEB PUSH)",
"request": {
"method": "POST",
"header": [
{
"key": "X-CleverTap-Account-Id",
"value": "{{id}}"
},
{
"key": "X-CleverTap-Passcode",
"value": "{{passcode}}"
},
{
"key": "Content-Type",
"value": "{{type}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"to\": {\n \"FBID\": [\n \"102029292929388\",\n \"114342342453463\"\n ],\n \"GPID\": [\n \"1928288389299292\"\n ],\n \"Email\": [\n \"john@doe.com\",\n \"jane@doe.com\"\n ],\n \"Identity\": [\n \"JohnDoe\"\n ],\n \"objectId\": [\n \"_asdnkansdjknaskdjnasjkndja\",\n \"-adffajjdfoaiaefiohnefwprjf\"\n ]\n },\n \"tag_group\": \"my tag group\",\n \"respect_frequency_caps\": false,\n \"content\": {\n \"title\": \"Hi!\",\n \"body\": \"How are you doing today?\",\n \"platform_specific\": {\n \"chrome\": {\n \"image\": \"https://www.exampleImage.com\",\n \"icon\":\"https://www.exampleIcon.com\",\n \"deep_link\": \"http://www.example.com\",\n \"ttl\":10,\n \"require_interaction\":true,\n \"cta_title1\":\"title\",\n \"cta_link1\":\"http://www.example2.com\",\n \"cta_iconlink1\":\"https://www.exampleIcon2.com\"\n }\n }\n }\n}"
},
"url": {
"raw": "https://api.clevertap.com/1/send/webpush.json",
"protocol": "https",
"host": [
"api",
"clevertap",
"com"
],
"path": [
"1",
"send",
"webpush.json"
]
}
},
"response": [
]
}
