Send Template Message API

Use the Send Template Message API to send predefined RCS templates with dynamic variables through an RCS bot.

Endpoint details

FieldValue
URLhttps://apis.rmlconnect.net/rcs/v1/message
MethodPOST
Content-Typeapplication/json
Authentication RequiredYes

Authentication

Pass a valid access token in the Authorization header.

Request headers

HeaderRequiredDescription
AuthorizationYesValid access token for authentication.
Content-TypeYesMust be application/json.

Request body parameters

FieldTypeDescription
typestringMessage type. Use template.
phone_nostringRecipient phone number.
bot_namestringRCS bot name.
extrastringAdditional value included in some template messages.
templateobjectTemplate details including template name and variables.

Template message types

Plain Text template message

Send a plain text template with dynamic variables.

Rich Card standalone template message

Send a standalone rich card template with dynamic variables.

Rich Card carousel template message

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.



Did this page help you?