RCS API

POST https://api.pingbix.ai/v1/rcs

This endpoint is used to send an RCS (Rich Communication Services) message using a predefined campaign and template. The message is sent via a specified bot ID and can be targeted to a valid RCS-enabled phone number.

Plain Text

Attributes

number Recipient's phone number (must be RCS-enabled and in international format). For example: +91XXXXXXXXXX
templateName Name of the message template to be used.
botId Identifier of the RCS bot used to send the message.
type Route Type. Use TRANS for Transactional, PROMO for Promotional.
campaignName (Optional) The RCS campaign name refers to the specific name or title given to a campaign conducted through RCS.

Request

POST https://api.pingbix.ai/v1/rcs 
curl -G /v1/rcs \
-H "apikey": "string" \
-H "Content-Type: application/json" \
-d '{
    "number": "+91XXXXXXXXXX",
    "campaignName": "api-test",
    "botId": "EXPOSE",
    "type": "TRANS",
    "templateName": "plane_text"
}'

Response

{
  "id": "58d63c02-XXXX-XXXX-XXXX-XXXXXb39453",
  "data": [
    {
      "recipient": "+91XXXXXXXXXX",
      "messageId": "58d63c02-XXXX-XXXX-XXXX-XXXXXb39453:1"
    }
  ],
  "totalCount": 1,
  "message": "Message Sent Successfully!",
  "error": null
}

Rich Text

Description

Rich Text in RCS refers to messages that go beyond simple plain text by allowing formatting and media enhancements such as Buttons with actions.

Attributes

number Recipient's phone number. Example: +91XXXXXXXXXX
templateName Name of the message template to be used.
botId Identifier of the RCS bot.
type Route Type. Use TRANS or PROMO.
campaignName (Optional) The RCS campaign name refers to the specific name or title given to a campaign conducted through RCS.

Request

POST https://api.pingbix.ai/v1/rcs 
curl -G /v1/rcs \
-H "apikey": "string" \
-H "Content-Type: application/json" \
-d '{
    "number": "+91XXXXXXXXXX",
    "campaignName": "api-test",
    "botId": "EXPOSE",
    "type": "TRANS",
    "templateName": "rich_text"
}'

Response

{
  "id": "58d63c02-XXXX-XXXX-XXXX-XXXXXb39453",
  "data": [
    {
      "recipient": "+91XXXXXXXXXX",
      "messageId": "58d63c02-XXXX-XXXX-XXXX-XXXXXb39453:1"
    }
  ],
  "totalCount": 1,
  "message": "Message Sent Successfully!",
  "error": null
}

Text with Variables

Description

This endpoint is for text templates with customizable parameters—simple integration, versatile customization.

Attributes

from Recipient's phone number. Example: +91XXXXXXXXXX
templateName Name of the message template.
botId Identifier of the RCS bot.
type Route Type. Use TRANS or PROMO.
content To build a message content object for RCS, typically include various fields such as param, fileUrl( images, video, and other media).
params If you have a registered template with placeholders and you need to submit parameter values in the same order as in the template, you can represent this as an array of values.
campaignName (Optional) The RCS campaign name refers to the specific name or title given to a campaign conducted through RCS.

Request

POST https://api.pingbix.ai/v1/rcs 
curl -G /v1/rcs \
-H "apikey": "string" \
-H "Content-Type: application/json" \
-d '{
    "campaignName": "rcs-api-sms",
    "botId": "EXPOSE",
    "type": "TRANS",
    "number": "+91XXXXXXXXXX",
    "templateName": "text_with_variables",
    "content": [
        {
            "params": [
                "Business",
                "API''s"
            ]
        }
    ]
}'

Response

{
  "id": "58d63c02-XXXX-XXXX-XXXX-XXXXXb39453",
  "data": [
    {
      "recipient": "+91XXXXXXXXXX",
      "messageId": "58d63c02-XXXX-XXXX-XXXX-XXXXXb39453:1"
    }
  ],
  "totalCount": 1,
  "message": "Message Sent Successfully!",
  "error": null
}

Standalone (No Image Change)

Attributes

number Recipient's phone number. Example: +91XXXXXXXXXX
templateName Name of the message template to be used.
botId Identifier of the RCS bot.
type Route Type. Use TRANS or PROMO.
campaignName (Optional) The RCS campaign name refers to the specific name or title given to a campaign conducted through RCS.

Request

POST https://api.pingbix.ai/v1/rcs 
curl -G /v1/rcs \
-H "apikey": "string" \
-H "Content-Type: application/json" \
-d '{
    "number": "+91XXXXXXXXXX",
    "campaignName": "api-test",
    "botId": "EXPOSE",
    "type": "TRANS",
    "templateName": "standalone"
}'

Response

{
  "id": "58d63c02-XXXX-XXXX-XXXX-XXXXXb39453",
  "data": [
    {
      "recipient": "+91XXXXXXXXXX",
      "messageId": "58d63c02-XXXX-XXXX-XXXX-XXXXXb39453:1"
    }
  ],
  "totalCount": 1,
  "message": "Message Sent Successfully!",
  "error": null
}

Standalone (With Image Change)

Description

This endpoint is for text templates with customizable parameters—simple integration, versatile customization.

Attributes

from Recipient's phone number. Example: +91XXXXXXXXXX
templateName Name of the message template.
botId Identifier of the RCS bot.
type Route Type. Use TRANS or PROMO.
content To build a message content object for RCS, typically include various fields such as param, fileUrl( images, video, and other media).
fileUrl Publicly accessible URL to the media file you want to send.
campaignName (Optional) The RCS campaign name refers to the specific name or title given to a campaign conducted through RCS.

Request

POST https://api.pingbix.ai/v1/rcs 
curl -G - /v1/rcs\
   -H 'apikey':'string'
   -H "Content-Type: application/json" \
   -d '{
         "campaignName": "rcs-api-sms",
         "botId": "EXPOSE",
         "type": "TRANS",
         "number": "+91XXXXXXXXXX",
         "templateName": "standalone",
         "content": [
               {
                 "fileUrl": "https://omni-whtaspp-media.s3.ap-south-1.amazonaws.com/uploads/1740046830337.jpg"
               }
         ]
       }'

Response

{
  "id": "58d63c02-XXXX-XXXX-XXXX-XXXXXb39453",
  "data": [
    {
      "recipient": "+91XXXXXXXXXX",
      "messageId": "58d63c02-XXXX-XXXX-XXXX-XXXXXb39453:1"
    }
  ],
  "totalCount": 1,
  "message": "Message Sent Successfully!",
  "error": null
}