Skip to main content
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"
  }
}
'

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Body

application/json
​
user_number
string
required

The user's phone number to send the message to

Example:

"+1234567890"

​
agent_number
string
required

The agent's phone number to send the message from

Example:

"+1234567890"

​
agent_message
string
required

The message to send to the user

Example:

"Hello! How can I help you today?"

​
request_data
object
required

Additional request data to be used in the conversation

Example:
{
  "customer_id": "12345",
  "order_number": "ORD-789"
}

Response

201 - undefined