Send SMS
curl --request POST \
--url https://api.cleartalk.ai/cleartalk-sms/send-sms \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"user_number": "+1234567890",
"agent_number": "+1234567890",
"agent_message": "Hello! How can I help you today?",
"request_data": {
"customer_id": "12345",
"order_number": "ORD-789"
}
}
'import requests
url = "https://api.cleartalk.ai/cleartalk-sms/send-sms"
payload = {
"user_number": "+1234567890",
"agent_number": "+1234567890",
"agent_message": "Hello! How can I help you today?",
"request_data": {
"customer_id": "12345",
"order_number": "ORD-789"
}
}
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({
user_number: '+1234567890',
agent_number: '+1234567890',
agent_message: 'Hello! How can I help you today?',
request_data: {customer_id: '12345', order_number: 'ORD-789'}
})
};
fetch('https://api.cleartalk.ai/cleartalk-sms/send-sms', 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/cleartalk-sms/send-sms",
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([
'user_number' => '+1234567890',
'agent_number' => '+1234567890',
'agent_message' => 'Hello! How can I help you today?',
'request_data' => [
'customer_id' => '12345',
'order_number' => 'ORD-789'
]
]),
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/cleartalk-sms/send-sms"
payload := strings.NewReader("{\n \"user_number\": \"+1234567890\",\n \"agent_number\": \"+1234567890\",\n \"agent_message\": \"Hello! How can I help you today?\",\n \"request_data\": {\n \"customer_id\": \"12345\",\n \"order_number\": \"ORD-789\"\n }\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/cleartalk-sms/send-sms")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_number\": \"+1234567890\",\n \"agent_number\": \"+1234567890\",\n \"agent_message\": \"Hello! How can I help you today?\",\n \"request_data\": {\n \"customer_id\": \"12345\",\n \"order_number\": \"ORD-789\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleartalk.ai/cleartalk-sms/send-sms")
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 \"user_number\": \"+1234567890\",\n \"agent_number\": \"+1234567890\",\n \"agent_message\": \"Hello! How can I help you today?\",\n \"request_data\": {\n \"customer_id\": \"12345\",\n \"order_number\": \"ORD-789\"\n }\n}"
response = http.request(request)
puts response.read_bodyClearTalk SMS
Send SMS
POST
/
cleartalk-sms
/
send-sms
Send SMS
curl --request POST \
--url https://api.cleartalk.ai/cleartalk-sms/send-sms \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"user_number": "+1234567890",
"agent_number": "+1234567890",
"agent_message": "Hello! How can I help you today?",
"request_data": {
"customer_id": "12345",
"order_number": "ORD-789"
}
}
'import requests
url = "https://api.cleartalk.ai/cleartalk-sms/send-sms"
payload = {
"user_number": "+1234567890",
"agent_number": "+1234567890",
"agent_message": "Hello! How can I help you today?",
"request_data": {
"customer_id": "12345",
"order_number": "ORD-789"
}
}
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({
user_number: '+1234567890',
agent_number: '+1234567890',
agent_message: 'Hello! How can I help you today?',
request_data: {customer_id: '12345', order_number: 'ORD-789'}
})
};
fetch('https://api.cleartalk.ai/cleartalk-sms/send-sms', 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/cleartalk-sms/send-sms",
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([
'user_number' => '+1234567890',
'agent_number' => '+1234567890',
'agent_message' => 'Hello! How can I help you today?',
'request_data' => [
'customer_id' => '12345',
'order_number' => 'ORD-789'
]
]),
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/cleartalk-sms/send-sms"
payload := strings.NewReader("{\n \"user_number\": \"+1234567890\",\n \"agent_number\": \"+1234567890\",\n \"agent_message\": \"Hello! How can I help you today?\",\n \"request_data\": {\n \"customer_id\": \"12345\",\n \"order_number\": \"ORD-789\"\n }\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/cleartalk-sms/send-sms")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_number\": \"+1234567890\",\n \"agent_number\": \"+1234567890\",\n \"agent_message\": \"Hello! How can I help you today?\",\n \"request_data\": {\n \"customer_id\": \"12345\",\n \"order_number\": \"ORD-789\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleartalk.ai/cleartalk-sms/send-sms")
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 \"user_number\": \"+1234567890\",\n \"agent_number\": \"+1234567890\",\n \"agent_message\": \"Hello! How can I help you today?\",\n \"request_data\": {\n \"customer_id\": \"12345\",\n \"order_number\": \"ORD-789\"\n }\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
apiKeyapiKey
API Key for authentication
Body
application/json
The user's phone number to send the message to
Example:
"+1234567890"
The agent's phone number to send the message from
Example:
"+1234567890"
The message to send to the user
Example:
"Hello! How can I help you today?"
Additional request data to be used in the conversation
Example:
{
"customer_id": "12345",
"order_number": "ORD-789"
}
Response
201 - undefined
⌘I
