Send Template Message API
Use the Send Template Message API to send predefined RCS templates with dynamic variables through an RCS bot.
Endpoint details
| Field | Value |
|---|---|
| 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 template. |
| phone_no | string | Recipient phone number. |
| bot_name | string | RCS bot name. |
| extra | string | Additional value included in some template messages. |
| template | object | Template details including template name and variables. |
Template message types
Send a plain text template with dynamic variables.
Send a standalone rich card template with dynamic variables.
Send a carousel template with dynamic variables.
Request examples
Plain Text template message
Sends a templated message to a specified phone number using the RCS bot. This API allows dynamic insertion of variables into a predefined message template.
Request body
{
"type": "template",
"phone_no": "{phone}",
"bot_name": "XXXXx",
"template": {
"name": "variabletest",
"variables": {
"name": "RouteMobile",
"OTP": "6798",
"urllabel": "VisitUs",
"reply": "Excited",
"postback1": "reply",
"url": "products/enhanced-business-messaging/rcs-business-messaging",
"dialerlabel": "CallUs",
"postback2": "visits"
}
}
}Response
{
"status": "success",
"message_id": "abc123456789",
"details": "Template message sent successfully."
}Error responses
No error response example is provided for this operation.
Rich Card standalone template message
Send a templated message using the RCS bot. This API enables the injection of dynamic content into a pre-approved message template using variable fields.
Request body
{
"type": "template",
"phone_no": "{phone}",
"bot_name": "XXXXX",
"extra": "ABC",
"template": {
"name": "demo_testing",
"variables": {
"name": "varshini",
"url": "enhanced-business-messaging/rcs-business-messaging"
}
}
}Error responses
No error response example is provided for this operation.
Rich Card carousel template message
Send a templated message using the RCS bot. This API enables the injection of dynamic content into a pre-approved message template using variable fields.
Request body
{
"type": "template",
"phone_no": "{phone}",
"bot_name": "XXXXXXXX",
"extra": "OCEAN",
"template": {
"name": "variabletest",
"variables": {
"Welcomemsg": "WelcometoRouteMobile",
"OTP": "6798",
"url": "VisitUs",
"postback1": "postback",
"url1": "products/enhanced-business-messaging/rcs-business-messaging",
"dialer": "CallUs",
"postback2": "visits"
}
}
}Response
{
"status": "success",
"message_id": "msg_20250506123456",
"details": "Template message sent successfully."
}Error responses
No error response example is provided for this operation.
Updated 4 days ago