Bulk Upload Campaign

Use Bulk Upload Campaign APIs to send RCS text or template messages to many recipients through a batch upload process.

Endpoint details

Field	Value
Endpoint URL	https://apis.rmlconnect.net/rcs/v1/bulk_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`.

Campaign types

Bulk text campaign

Send a text message campaign using a recipient or variable file URL.

Bulk template campaign

Send a template message campaign with variables using a batch upload process.

Request examples

Bulk Upload for a Text Message

Trigger a text message campaign through a chatbot. The payload includes campaign metadata, message content, and an optional file URL such as a CSV with dynamic variables or a recipient list.

Request body parameters

Field	Type	Description
type	string	Message type. Use `text`.
country_code	string	Country code for the recipients.
campaign_name	string	Campaign name.
file_url	string	Public file URL, such as a CSV with variables or recipients.
bot_name	string	RCS bot name.
text	string	Text message content.

Request body

{
  "type": "text",
  "country_code": "+32",
  "campaign_name": "PXSTest",
  "file_url": "https://node-media-uploader.s3.ap-south-1.amazonaws.com/17398887stestingvars.csv",
  "bot_name": "xxxxxxxx",
  "text": "Hello,testingfromRoute"
}

Response

The request has been received successfully.

Error response

No error response example is provided for this operation.

Bulk Upload for a Template Message

Send template messages to many recipients simultaneously using a batch upload process. Use this for personalized and interactive messages at scale.

Request body parameters

Field	Type	Description
type	string	Message type. Use `template`.
country_code	string	Country code for the recipients.
campaign_name	string	Campaign name.
file_url	string	Public file URL, such as a CSV with variables or recipients.
bot_name	string	RCS bot name.
template	object	Template details including template name and variables.

Request body

{
  "type": "template",
  "country_code": "+91",
  "campaign_name": "PXSTest",
  "file_url": "https://node-media-uploader.s3.ap-south-1.amazonaws.com/1739888723705rcstestingvars.csv",
  "bot_name": "RouteOTP",
  "template": {
    "name": "valetst",
    "variables": {
      "name": "RouteMobile",
      "OTP": "6798",
      "urllabel": "VisitUs",
      "reply": "Excited",
      "postback1": "reply",
      "url": "products/enhanced-business-messaging/rcs-business-messaging",
      "dialerlabel": "CallUs",
      "postback2": "visits"
    }
  }
}

Response

{
  "message": "Message request has been created",
  "id": "9f8d32c0-1f60-11f0-8d0c-0a58a9fedgrc02"
}

Error response

No error response example is provided for this operation.