Chilkat Online Tools

Ruby / CleverTap API / Create Campaign API - Target Users by their Identities(SMS)

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

# 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": "mytaggroup",
#   "respect_frequency_caps": false,
#   "content": {
#     "body": "Smsbody"
#   }
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("to.FBID[0]","102029292929388")
json.UpdateString("to.FBID[1]","114342342453463")
json.UpdateString("to.GPID[0]","1928288389299292")
json.UpdateString("to.Email[0]","john@doe.com")
json.UpdateString("to.Email[1]","jane@doe.com")
json.UpdateString("to.Identity[0]","JohnDoe")
json.UpdateString("to.objectId[0]","_asdnkansdjknaskdjnasjkndja")
json.UpdateString("to.objectId[1]","-adffajjdfoaiaefiohnefwprjf")
json.UpdateString("tag_group","mytaggroup")
json.UpdateBool("respect_frequency_caps",false)
json.UpdateString("content.body","Smsbody")

http.SetRequestHeader("X-CleverTap-Passcode","{{passcode}}")
http.SetRequestHeader("X-CleverTap-Account-Id","{{id}}")
http.SetRequestHeader("Content-Type","{{type}}")

# resp is a CkHttpResponse
resp = http.PostJson3("https://api.clevertap.com/1/send/sms.json","{{type}}",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

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":"mytaggroup","respect_frequency_caps":false,"content":{"body":"Smsbody"}}'
https://api.clevertap.com/1/send/sms.json

Postman Collection Item JSON

{
  "name": "Create Campaign API - Target Users by their Identities(SMS)",
  "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": "{\"to\":{\"FBID\":[\"102029292929388\",\"114342342453463\"],\"GPID\":[\"1928288389299292\"],\"Email\":[\"john@doe.com\",\"jane@doe.com\"],\"Identity\":[\"JohnDoe\"],\"objectId\":[\"_asdnkansdjknaskdjnasjkndja\",\"-adffajjdfoaiaefiohnefwprjf\"]},\"tag_group\":\"mytaggroup\",\"respect_frequency_caps\":false,\"content\":{\"body\":\"Smsbody\"}}"
    },
    "url": {
      "raw": "https://api.clevertap.com/1/send/sms.json",
      "protocol": "https",
      "host": [
        "api",
        "clevertap",
        "com"
      ],
      "path": [
        "1",
        "send",
        "sms.json"
      ]
    }
  },
  "response": [
  ]
}