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

get
Ping

https://api-<region>.renda.io/communication/ping
Heartbeat Check
Request
Response
Request
Headers
x-api-key
required
string
Renda API Key
Response
200: OK
Cake successfully retrieved.
[
{
"type": "Success",
"message": "Renda.io ping successful"
}
]
403: Forbidden
Could not find a cake matching this query.
{
"message": "Unsupported API request. Please refer to Renda
documentation for more details documentation.renda.io"
}

post
Send SMS

https://api-<region>.renda.io/communication/sendSMS
Request
Response
Request
Headers
x-api-key
required
string
Form Data Parameters
number
required
string
Valid Mobile number +441234567890 00441234567890 <country code> + <mobile number>
message
required
string
SMS Text
senderName
optional
string
Sender Name 3-11 chars if alphanumeric 3-15 chars if numeric Spaces and special characters are not allowed
Response
200: OK
{
"messageid": "612733016353393435",
"status": "SENT"
}
400: Bad Request
//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
}
403: Forbidden
{
"message": "Unsupported API request. Please refer to Renda
documentation for more details https://documentation.renda.io"
}