rcs_business_messaging_api

RCS API Documentation

Send message API, template creation for text, rich card, carousel, and multipart templates, and the full template lifecycle — everything you need to integrate RCS Business Messaging.

1. RCS Send Message API

API Endpoint

POST https://api.accelbiz.in/api/v1/Rcs/sendmessage

Headers

Header	Value	Required	Description
Authorization	Bearer {{User-Access-Token}}	Required	API authentication token
Content-Type	application/json	Required	Request body format

Request Body Schema

Basic Example

{
  "botid": "WbQoJX62v0SK9ZU2",
  "templatename": "Diwali_Sahil",
  "destination": ["+911234567890"]
}

Full Schema

{
  "botid": "string (required)",
  "templatename": "string (required)",
  "destination": ["array of phone numbers (required)"],
  "var": {
    "property1": "string (optional)",
    "property2": "string (optional)"
  },
  "callbackdata": "string (optional)"
}

Parameters Description

Field	Type	Required	Description
botid	string	Required	Unique identifier of your RCS bot/agent
templatename	string	Required	Name of approved RCS template (must match exactly)
destination	array	Required	List of mobile numbers in E.164 format (e.g., +918097431434)
var	object	Optional	Template variables (dynamic content for template)
callbackdata	string	Optional	Data returned in callback webhook

Responses

Success Response

[
  {
    "status": "SUCCESS",
    "message": "Success",
    "callback_data": "string"
  }
]

Failure — Template Not Found

[
  {
    "status": "FAILURE",
    "message": "RCS template not found: <templatename>",
    "callback_data": "string"
  }
]

Failure — Bot Not Found

[
  {
    "status": "FAILURE",
    "message": "Agent/Bot not found: <botid>",
    "callback_data": "string"
  }
]

cURL Example

terminal

curl -X POST "https://api.accelbiz.in/api/v1/Rcs/sendmessage" \
  -H "Authorization: Bearer {{User-Access-Token}}" \
  -H "Content-Type: application/json" \
  -d '{
    "botid": "WbQoJX62v0SK9ZU2",
    "templatename": "Diwali_Sahil",
    "destination": ["+918097431434"]
  }'

2. RCS Get Template API

API Endpoint

POST https://api.accelbiz.in/api/v1/rcs/getTemplate

Query Parameters

Parameter	Type	Required	Description
botid	string	Required	Unique identifier of your RCS bot/agent
TemplateName	string	Required	Name of the template to retrieve

Headers

Header	Value	Required	Description
Authorization	Bearer {{User-Access-Token}}	Required	API authentication token

cURL Example

terminal

curl -X POST \
  "https://api.accelbiz.in/api/v1/rcs/getTemplate?botid=WbQoJX62v0SK9ZU2&TemplateName=Diwali_Sahil" \
  -H "Authorization: Bearer {{User-Access-Token}}"

Response Examples

Success Response (Template Found)

{
  "success": true,
  "message": "Template found!",
  "data": {
    "AgentId": "WbQoJX62v0SK9ZU2",
    "TemplateName": "Diwali_Sahil",
    "TemplateStatus": "Approve",
    "Component": {}
  }
}

Error — Template Not Found

{
  "success": false,
  "message": "Template Not found!"
}

Error — Invalid Agent/Bot ID

{
  "message": "Invalid AgentId for this user"
}

3. RCS Delete Template API

API Endpoint

POST https://api.accelbiz.in/api/v1/rcs/deletetemplate

Query Parameters

Parameter	Type	Required	Description
botid	string	Required	Unique identifier of your RCS bot/agent
rcstemplatename	string	Required	Name of the template to delete

Headers

Header	Value	Required	Description
Authorization	Bearer {{User-Access-Token}}	Required	API authentication token

cURL Example

terminal

curl -X POST \
  "https://api.accelbiz.in/api/v1/rcs/deletetemplate?botid=WbQoJX62v0SK9ZU2&rcstemplatename=test_21229" \
  -H "Authorization: Bearer {{User-Access-Token}}"

Success Response

{
  "success": true,
  "message": "Templates deleted successfully."
}

Error Response

{
  "success": false,
  "message": "Error occurred while deleting templates!"
}

Error — Invalid Agent ID

{
  "message": "Invalid AgentId for this user"
}

4. RCS Create Template API

API Endpoint

POST https://api.accelbiz.in/api/v1/rcs/createtemplate

Headers

Header	Value	Required	Description
Authorization	Bearer {{User-Access-Token}}	Required	API authentication token
Content-Type	application/json	Required	Request body format

4.1 Text Message Template

This API is used to submit a Text Message template for review and approval.

Request Body Schema

{
  "botId": "WbQoJX62v0SK9ZU2",
  "template_data": {
    "name": "test_template",
    "type": "text",
    "textMessage": "Dear [name], time to participate in lucky draw and win prizes",
    "suggestions": [
      { "suggestionType": "reply", "text": "Click to Win [promo_name]", "postbackData": "click_reply" },
      { "suggestionType": "url_action", "url": "https://brandx.onelink.me/", "text": "Answer and Win [promo_name]", "postbackData": "url_click" },
      { "suggestionType": "dial_action", "phone": "+919702012345", "text": "Call Now [promo_name]", "postbackData": "call_now" }
    ]
  }
}

Text Template Parameters

Parameter	Mandatory	Description	Max Length
name	Yes	Template name (alphanumeric + underscore)	25
type	Yes	Must be "text" for text templates	—
textMessage	Yes	Template message with variables in [brackets]	2500
suggestions	No	Array of suggestion objects	—

4.2 Rich Card Standalone Template

This API is used to submit a Rich Card standalone Message template for review and approval.

Request Body Schema

{
  "botId": "WbQoJX62v0SK9ZU2",
  "template_data": {
    "name": "test_rich_card",
    "type": "richcard",
    "orientation": "VERTICAL",
    "height": "MEDIUM",
    "standaloneCard": {
      "cardTitle": "Keep calm & BAT on!",
      "cardDescription": "Dear [name], time to participate in lucky draw and win prizes",
      "mediaUrl": "https://brand.com/Ad.mp4",
      "thumbnailUrl": "https://brand.com/Ad_snap.png",
      "suggestions": [
        { "suggestionType": "reply", "text": "Avail offer [offer_name]", "postbackData": "offer_reply" },
        { "suggestionType": "url_action", "url": "https://brand.com/", "text": "Buy Now at [offer_name]", "postbackData": "shop_url" }
      ]
    }
  }
}

Rich Card Template Parameters

Parameter	Description	Options
type	Must be "richcard"	"richcard"
orientation	Card orientation	"VERTICAL", "HORIZONTAL"
height	Card height (for VERTICAL)	"SHORT", "MEDIUM"
alignment	For HORIZONTAL orientation	"LEFT", "RIGHT"
cardTitle	Card title	Max 200 chars
cardDescription	Card description	Max 2000 chars
mediaUrl	Media file URL	Max 2048 chars
thumbnailUrl	Thumbnail URL (for video)	Max 2048 chars

4.3 Rich Card Carousel Template

This API is used to submit a Rich Card Carousel Message template for approval.

Request Body Schema

{
  "botId": "WbQoJX62v0SK9ZU2",
  "template_data": {
    "name": "test_carousel",
    "type": "carousel",
    "height": "SHORT",
    "width": "MEDIUM",
    "carouselCard": [
      {
        "cardTitle": "New watches",
        "cardDescription": "Dear [name] brand new watches for less price",
        "mediaUrl": "https://brand.com/media/watches.mp4",
        "thumbnailUrl": "https://brand.com/media/watches.jpeg",
        "suggestions": [
          { "suggestionType": "url_action", "url": "https://brand.com/", "text": "Buy Now at [offer_name]", "postbackData": "shop_url" }
        ]
      },
      {
        "cardTitle": "New perfumes",
        "cardDescription": "Dear [name], Choose from brand new perfumes.",
        "mediaUrl": "https://brand.com/media/[image]",
        "suggestions": [
          { "suggestionType": "dial_action", "phone": "+919702012345", "text": "Call now to avail [offer_name]", "postbackData": "call_click" }
        ]
      }
    ]
  }
}

Carousel Template Parameters

Parameter	Description	Options
type	Must be "carousel"	"carousel"
height	Card height	"SHORT", "MEDIUM"
width	Card width	"SMALL", "MEDIUM"
carouselCard	Array of card objects	2–10 cards

4.4 Text+File Multipart Template

This API is used to submit multiple RCS (text+file) templates for approval. Currently only PDF files are supported (max 10MB).

Request Body Schema

{
  "botId": "WbQoJX62v0SK9ZU2",
  "template_data": {
    "name": "test_multipart",
    "type": "multipart",
    "order": "text,file",
    "textMessage": "Dear [name], time to participate in lucky draw and win prizes",
    "mediaUrl": "https://www.brand.com/message/shop_offer.pdf",
    "suggestions": [
      { "suggestionType": "reply", "text": "Click to Win [promo_name]", "postbackData": "click_reply" }
    ]
  }
}

Multipart Template Parameters

Parameter	Description	Options
type	Must be "multipart"	"multipart"
order	Message order	"text,file" or "file,text"
mediaUrl	File URL (PDF)	Max 2048 chars

4.5 Template Type Codes (Alots Mapping)

Alots Type	VI RBM Type	Description	Use Case
"1"	"text"	STANDARD	Simple text-only messages
"2"	"carousel"	MULTI_CARD	Carousel with multiple cards
"3"	"richcard"	RICH_CARD	Single card with rich media
—	"multipart"	TEXT+FILE	Text message with file attachment

4.6 Suggestion Types

Type	Alots Field	VI RBM Field	Description
Reply	"reply"	"reply"	Reply button
URL Action	"url_action"	"url_action"	URL button
Dial Action	"dial_action"	"dialer_action"	Call button
Phone Field	"phone"	"phoneNumber"	Phone number for dial action

4.7 Success Response Format

{
  "status": "success",
  "templateName": "test_212309",
  "templateType": "3",
  "reqTime": "2025-12-03 15:54:54"
}

4.8 Error Responses

Template Already Exists

{
  "success": false,
  "message": "Vodafone API failed: {\"reqTime\":\"2025-12-03 10:20:49\",\"error\":{\"code\":400,\"message\":\"Template with name [test_21219] and bot [WbQoJX62v0SK9ZU2] already exists\",\"status\":\"BAD_REQUEST\"}}"
}

Invalid Agent/Bot ID

{
  "message": "Invalid AgentId for this user"
}

Server Error

{
  "statusCode": 500,
  "message": "An unexpected error occurred.",
  "path": "/api/v1/rcs/createtemplate",
  "details": null
}

Media File Errors

{
  "erid": "a7704574-7766-4edc-9895-f551bb2b5c89",
  "reqTime": "2026-04-22 19:52:03",
  "error": { "code": 400, "message": "Invalid template name", "status": "BAD_REQUEST" }
}

4.9 Complete cURL Examples

Text Template Example

terminal

curl -X POST "https://api.accelbiz.in/api/v1/rcs/createtemplate" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {{User-Access-Token}}" \
  -d '{
    "botId": "WbQoJX62v0SK9ZU2",
    "template_data": {
      "name": "Order_Confirm_20251203",
      "type": "1",
      "textMessage": "Hi [CustomerName], your order #[OrderNumber] worth ₹[Amount] is confirmed! Delivery expected by [Date].",
      "suggestions": [
        { "suggestionType": "reply", "text": "Track Order", "postbackData": "TRACK_ORDER" },
        { "suggestionType": "url_action", "text": "View Invoice", "url": "https://store.com/invoice/[OrderNumber]" },
        { "suggestionType": "dial_action", "text": "Call Support", "phone": "+911800123456" }
      ]
    }
  }'

Rich Card Template Example

terminal

curl -X POST "https://api.accelbiz.in/api/v1/rcs/createtemplate" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {{User-Access-Token}}" \
  -d '{
    "botId": "WbQoJX62v0SK9ZU2",
    "template_data": {
      "name": "Promo_Card_20251203",
      "type": "3",
      "orientation": "VERTICAL",
      "height": "MEDIUM",
      "standaloneCard": {
        "cardTitle": "Special Diwali Offer!",
        "cardDescription": "Hi [CustomerName], get [Discount]% off on all products. Use code: [PromoCode]. Valid till [ExpiryDate]!",
        "mediaUrl": "https://brand.com/diwali-offer.jpg",
        "suggestions": [
          { "suggestionType": "url_action", "text": "Shop Now", "url": "https://store.com/sale" }
        ]
      }
    }
  }'

Carousel Template Example

terminal

curl -X POST "https://api.accelbiz.in/api/v1/rcs/createtemplate" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {{User-Access-Token}}" \
  -d '{
    "botId": "WbQoJX62v0SK9ZU2",
    "template_data": {
      "name": "Product_Catalog_20251203",
      "type": "2",
      "height": "SHORT",
      "width": "MEDIUM",
      "carouselCard": [
        {
          "cardTitle": "Smart Watches",
          "cardDescription": "Latest smart watches with health tracking. Starting at ₹[Price1]",
          "mediaUrl": "https://brand.com/watches.jpg",
          "suggestions": [
            { "suggestionType": "url_action", "text": "View Watches", "url": "https://store.com/watches" }
          ]
        },
        {
          "cardTitle": "Wireless Earbuds",
          "cardDescription": "Noise cancelling earbuds with 30hr battery. Only ₹[Price2]",
          "mediaUrl": "https://brand.com/earbuds.jpg",
          "suggestions": [
            { "suggestionType": "url_action", "text": "View Earbuds", "url": "https://store.com/earbuds" }
          ]
        }
      ]
    }
  }'

4.10 Variable Format

Use square brackets for dynamic content:

"textMessage": "Hello [CustomerName], your order #[OrderID] is ready for pickup at [StoreLocation]."

4.11 Media Guidelines

Supported Formats

Images: JPEG, PNG (max 5MB)
Videos: MP4 (max 15MB, max 30 seconds)
Documents: PDF (max 10MB, multipart only)

Aspect Ratios

Vertical Cards: 2:3, 3:4, 9:16
Horizontal Cards: 16:9, 4:3, 2:1
Carousel: 1:1, 4:3, 16:9

Media Upload Options

URL Method: Provide public URLs via mediaUrl and thumbnailUrl
File Upload: Use multipart form data (for VI RBM API)
Hybrid: File upload for media + URL for thumbnail