Skip to main content
POST
Send sms

Authorizations

Authorization
string
header
required

HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).

Body

application/json
recipient
string
required

Recipient number in E.164 format. To send Whatsapp message include prefix "whatsapp:+421..." to both sender and recipient numbers.

message
string
required

Message body/content.

sender
string
required

Sender number in E.164 format. To send Whatsapp message include prefix "whatsapp:+421..." to both sender and recipient numbers.

country_code
string

Country code of recipient number.

images_by_url
string[]

Image to be send as MMS. Will be downloaded from URL. MAX 5MB. Can contain up to 5 urls.

images
file[]

Image sent as blob to be send as MMS. MAX 5MB. Can contain up to 5 images.

file_by_url
string

File to be send to Whatsapp. Will be downloaded from URL. MAX 16MB. To send Whatsapp message recipient and sender number must contain prefix "whatsapp:" example "whatsapp:+421...". Field message must be empty.

file
file

File sent as blob to be send to Whatsapp. MAX 16MB. To send Whatsapp message recipient and sender number must contain prefix "whatsapp:" example "whatsapp:+421...". Field message must be empty.

Response

Status of sms sending

responseData
object
required