Trigger a standard texting campaign SMS
curl --request POST \
--url https://api.cleartalk.ai/callback/standardCampaignSms \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"contact_id": "I288bgrq0LlKLbW9tBng",
"campaign_id": "fc464efb-0725-4d7e-a7f3-3f7d30ec403a",
"first_name": "<string>",
"last_name": "<string>",
"full_name": "<string>",
"email": "<string>",
"phone": "<string>",
"tags": "<string>",
"country": "<string>",
"date_created": "<string>",
"company_name": "<string>",
"full_address": "<string>",
"contact_type": "<string>",
"location": {},
"workflow": {},
"triggerData": {},
"customData": {}
}
'import requests
url = "https://api.cleartalk.ai/callback/standardCampaignSms"
payload = {
"contact_id": "I288bgrq0LlKLbW9tBng",
"campaign_id": "fc464efb-0725-4d7e-a7f3-3f7d30ec403a",
"first_name": "<string>",
"last_name": "<string>",
"full_name": "<string>",
"email": "<string>",
"phone": "<string>",
"tags": "<string>",
"country": "<string>",
"date_created": "<string>",
"company_name": "<string>",
"full_address": "<string>",
"contact_type": "<string>",
"location": {},
"workflow": {},
"triggerData": {},
"customData": {}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact_id: 'I288bgrq0LlKLbW9tBng',
campaign_id: 'fc464efb-0725-4d7e-a7f3-3f7d30ec403a',
first_name: '<string>',
last_name: '<string>',
full_name: '<string>',
email: '<string>',
phone: '<string>',
tags: '<string>',
country: '<string>',
date_created: '<string>',
company_name: '<string>',
full_address: '<string>',
contact_type: '<string>',
location: {},
workflow: {},
triggerData: {},
customData: {}
})
};
fetch('https://api.cleartalk.ai/callback/standardCampaignSms', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cleartalk.ai/callback/standardCampaignSms",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contact_id' => 'I288bgrq0LlKLbW9tBng',
'campaign_id' => 'fc464efb-0725-4d7e-a7f3-3f7d30ec403a',
'first_name' => '<string>',
'last_name' => '<string>',
'full_name' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'tags' => '<string>',
'country' => '<string>',
'date_created' => '<string>',
'company_name' => '<string>',
'full_address' => '<string>',
'contact_type' => '<string>',
'location' => [
],
'workflow' => [
],
'triggerData' => [
],
'customData' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cleartalk.ai/callback/standardCampaignSms"
payload := strings.NewReader("{\n \"contact_id\": \"I288bgrq0LlKLbW9tBng\",\n \"campaign_id\": \"fc464efb-0725-4d7e-a7f3-3f7d30ec403a\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"tags\": \"<string>\",\n \"country\": \"<string>\",\n \"date_created\": \"<string>\",\n \"company_name\": \"<string>\",\n \"full_address\": \"<string>\",\n \"contact_type\": \"<string>\",\n \"location\": {},\n \"workflow\": {},\n \"triggerData\": {},\n \"customData\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cleartalk.ai/callback/standardCampaignSms")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contact_id\": \"I288bgrq0LlKLbW9tBng\",\n \"campaign_id\": \"fc464efb-0725-4d7e-a7f3-3f7d30ec403a\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"tags\": \"<string>\",\n \"country\": \"<string>\",\n \"date_created\": \"<string>\",\n \"company_name\": \"<string>\",\n \"full_address\": \"<string>\",\n \"contact_type\": \"<string>\",\n \"location\": {},\n \"workflow\": {},\n \"triggerData\": {},\n \"customData\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleartalk.ai/callback/standardCampaignSms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact_id\": \"I288bgrq0LlKLbW9tBng\",\n \"campaign_id\": \"fc464efb-0725-4d7e-a7f3-3f7d30ec403a\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"tags\": \"<string>\",\n \"country\": \"<string>\",\n \"date_created\": \"<string>\",\n \"company_name\": \"<string>\",\n \"full_address\": \"<string>\",\n \"contact_type\": \"<string>\",\n \"location\": {},\n \"workflow\": {},\n \"triggerData\": {},\n \"customData\": {}\n}"
response = http.request(request)
puts response.read_bodyCallback
Trigger a standard texting campaign SMS
POST
/
callback
/
standardCampaignSms
Trigger a standard texting campaign SMS
curl --request POST \
--url https://api.cleartalk.ai/callback/standardCampaignSms \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"contact_id": "I288bgrq0LlKLbW9tBng",
"campaign_id": "fc464efb-0725-4d7e-a7f3-3f7d30ec403a",
"first_name": "<string>",
"last_name": "<string>",
"full_name": "<string>",
"email": "<string>",
"phone": "<string>",
"tags": "<string>",
"country": "<string>",
"date_created": "<string>",
"company_name": "<string>",
"full_address": "<string>",
"contact_type": "<string>",
"location": {},
"workflow": {},
"triggerData": {},
"customData": {}
}
'import requests
url = "https://api.cleartalk.ai/callback/standardCampaignSms"
payload = {
"contact_id": "I288bgrq0LlKLbW9tBng",
"campaign_id": "fc464efb-0725-4d7e-a7f3-3f7d30ec403a",
"first_name": "<string>",
"last_name": "<string>",
"full_name": "<string>",
"email": "<string>",
"phone": "<string>",
"tags": "<string>",
"country": "<string>",
"date_created": "<string>",
"company_name": "<string>",
"full_address": "<string>",
"contact_type": "<string>",
"location": {},
"workflow": {},
"triggerData": {},
"customData": {}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact_id: 'I288bgrq0LlKLbW9tBng',
campaign_id: 'fc464efb-0725-4d7e-a7f3-3f7d30ec403a',
first_name: '<string>',
last_name: '<string>',
full_name: '<string>',
email: '<string>',
phone: '<string>',
tags: '<string>',
country: '<string>',
date_created: '<string>',
company_name: '<string>',
full_address: '<string>',
contact_type: '<string>',
location: {},
workflow: {},
triggerData: {},
customData: {}
})
};
fetch('https://api.cleartalk.ai/callback/standardCampaignSms', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cleartalk.ai/callback/standardCampaignSms",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contact_id' => 'I288bgrq0LlKLbW9tBng',
'campaign_id' => 'fc464efb-0725-4d7e-a7f3-3f7d30ec403a',
'first_name' => '<string>',
'last_name' => '<string>',
'full_name' => '<string>',
'email' => '<string>',
'phone' => '<string>',
'tags' => '<string>',
'country' => '<string>',
'date_created' => '<string>',
'company_name' => '<string>',
'full_address' => '<string>',
'contact_type' => '<string>',
'location' => [
],
'workflow' => [
],
'triggerData' => [
],
'customData' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cleartalk.ai/callback/standardCampaignSms"
payload := strings.NewReader("{\n \"contact_id\": \"I288bgrq0LlKLbW9tBng\",\n \"campaign_id\": \"fc464efb-0725-4d7e-a7f3-3f7d30ec403a\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"tags\": \"<string>\",\n \"country\": \"<string>\",\n \"date_created\": \"<string>\",\n \"company_name\": \"<string>\",\n \"full_address\": \"<string>\",\n \"contact_type\": \"<string>\",\n \"location\": {},\n \"workflow\": {},\n \"triggerData\": {},\n \"customData\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cleartalk.ai/callback/standardCampaignSms")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contact_id\": \"I288bgrq0LlKLbW9tBng\",\n \"campaign_id\": \"fc464efb-0725-4d7e-a7f3-3f7d30ec403a\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"tags\": \"<string>\",\n \"country\": \"<string>\",\n \"date_created\": \"<string>\",\n \"company_name\": \"<string>\",\n \"full_address\": \"<string>\",\n \"contact_type\": \"<string>\",\n \"location\": {},\n \"workflow\": {},\n \"triggerData\": {},\n \"customData\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleartalk.ai/callback/standardCampaignSms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact_id\": \"I288bgrq0LlKLbW9tBng\",\n \"campaign_id\": \"fc464efb-0725-4d7e-a7f3-3f7d30ec403a\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"full_name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"<string>\",\n \"tags\": \"<string>\",\n \"country\": \"<string>\",\n \"date_created\": \"<string>\",\n \"company_name\": \"<string>\",\n \"full_address\": \"<string>\",\n \"contact_type\": \"<string>\",\n \"location\": {},\n \"workflow\": {},\n \"triggerData\": {},\n \"customData\": {}\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
API Key for authentication
Body
application/json
GHL contact ID to text
Example:
"I288bgrq0LlKLbW9tBng"
Standard texting campaign ID (top-level for Format 1, or in customData for Format 2)
Example:
"fc464efb-0725-4d7e-a7f3-3f7d30ec403a"
Custom data object containing campaign_id and other fields (Format 2)
Response
200
Standard Campaign SMS triggered successfully
⌘I
