Fallback to WhatsApp

Use this API to send an RCS text message with WhatsApp fallback when RCS delivery is unavailable.

Endpoint details

Field	Value
Endpoint URL	https://apis.rmlconnect.net/rcs/v1/message
Method	`POST`
Content-Type	`application/json`
Authentication Required	Yes

Authentication

Pass a valid access token in the Authorization header.

Request headers

Header	Required	Description
Authorization	Yes	Valid access token for authentication.
Content-Type	Yes	Must be `application/json`.

Request body parameters

Field	Type	Description
type	string	Message type. Use `text`.
phone_no	string	Recipient phone number.
bot_name	string	RCS bot name.
text	string	Text message sent through RCS.
extra	string	Additional custom value.
fallback_channel	string	Fallback channel. Use `whatsapp`.
whatsapp	object	WhatsApp fallback message details.
whatsapp.text	string	Text sent through WhatsApp if RCS is unavailable.

If the primary RCS channel is unavailable, the message can fall back to WhatsApp using the fallback_channel and whatsapp.text fields.

Request body

{
  "type": "text",
  "phone_no": "{phone}",
  "bot_name": "XXXXXXXX",
  "text": "Hello",
  "extra": "mumbai",
  "fallback_channel": "whatsapp",
  "whatsapp": {
    "text": "hello"
  }
}

Response

{
  "message": "Message request has been created",
  "id": "9035789a-2a6f-11f0-874a-0a58a9feac021"
}

Error responses

No error response example is provided for this API.