Skip to navigation

Send a single SMS text message to one recipient.

Authentication

All requests require an apiKey header containing your Conversive API key.

apiKey: <YOUR_API_KEY>

Pass the API key as a request header named apiKey, not as a Bearer token in the Authorization header.

Request

POST
/api/v2/message/send
curl -X POST https://api.beconversive.com/api/v2/message/send \
-H "apiKey: <apiKey>" \
-H "Content-Type: application/json" \
-d '{
"userPayload": {
"type": "api",
"apiKey": "YOUR_API_KEY"
},
"messageDetails": [
{
"recipient": [
{
"channelType": "sms",
"phone": "756384933"
}
],
"sender": {
"channelType": "sms",
"phone": "56894033"
},
"source": 8001,
"messageId": "sms-001",
"message": {
"type": "text",
"content": {
"messageText": "Text message"
}
}
}
]
}'

Request

userPayloadobjectRequired
messageDetailslist of objectsRequired

Response

Response

responseobjectOptional

Errors

Status CodeMeaning
400Bad Request — missing or invalid parameters
401Unauthorized — invalid or missing API key
403Forbidden — insufficient permissions
404Not Found — endpoint or resource not found
429Too Many Requests — rate limit exceeded
500Internal Server Error — contact support