Communication
The communication API enables text message delivery. Authentication systems can be quickly build using a combination of TOTP API and Communication API to authenticate and onboard users
Ping
GET https://api-<region>.renda.io/communication/ping
Heartbeat Check
Headers
Name
Type
Description
x-api-key
string
Renda API Key
[
{
"type": "Success",
"message": "Renda.io ping successful"
}
]{
"message": "Unsupported API request. Please refer to Renda
documentation for more details documentation.renda.io"
}Send SMS
POST https://api-<region>.renda.io/communication/sendSMS
Headers
Name
Type
Description
x-api-key
string
Request Body
Name
Type
Description
number
string
Valid Mobile number +441234567890 00441234567890 <country code> + <mobile number>
message
string
SMS Text
senderName
string
Sender Name 3-11 chars if alphanumeric 3-15 chars if numeric Spaces and special characters are not allowed
{
"messageid": "612733016353393435",
"status": "SENT"
}//When invalid mobile number and message is provided
[
{
"type": "Error",
"message": "Invalid mobile number"
},
{
"type": "Error",
"message": "Invalid message content"
}
]
//When Invalid destination number is provided
{
"status": "error",
"errorCode": 4004,
"message": "Invalid destination number.",
"permanent": true
}{
"message": "Unsupported API request. Please refer to Renda
documentation for more details https://documentation.renda.io"
}Last updated
Was this helpful?