Chilkat Online Tools

Python / CleverTap API / Create Campaign API - Target Users by their Identities(WEB PUSH)

Back to Collection Items

import sys
import chilkat2

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

http = chilkat2.Http()

# 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"
#       }
#     }
#   }
# }

json = chilkat2.JsonObject()
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","my tag group")
json.UpdateBool("respect_frequency_caps",False)
json.UpdateString("content.title","Hi!")
json.UpdateString("content.body","How are you doing today?")
json.UpdateString("content.platform_specific.chrome.image","https://www.exampleImage.com")
json.UpdateString("content.platform_specific.chrome.icon","https://www.exampleIcon.com")
json.UpdateString("content.platform_specific.chrome.deep_link","http://www.example.com")
json.UpdateInt("content.platform_specific.chrome.ttl",10)
json.UpdateBool("content.platform_specific.chrome.require_interaction",True)
json.UpdateString("content.platform_specific.chrome.cta_title1","title")
json.UpdateString("content.platform_specific.chrome.cta_link1","http://www.example2.com")
json.UpdateString("content.platform_specific.chrome.cta_iconlink1","https://www.exampleIcon2.com")

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/webpush.json","{{type}}",json)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

print(str(resp.StatusCode))
print(resp.BodyStr)

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": [
  ]
}