Authentication

All requests require HTTP Basic Authentication using your username and password.

Tips

• Optional fields (like callbackURL and failover objects) can be left out for simpler requests.
• Use choices in cards and carousels to make messages interactive.
• Fallback objects (smsFailover, mmsFailover) help ensure message delivery if RCS is unavailable.

Send RCS Texts

Send a simple text message to a recipient.

To do this:

• Send a POST request to /v5/messages.
• Include sender, recipient, and your message text.
• Optionally, add a callback URL for delivery status and SMS failover info.

RCS Text Elements

Example

json

{
  "messageType": "RCS_TEXT",
  "source": "12345",
  "destination": "67890",
  "messageText": "Hello from RCS!",
  "callbackURL": "https://yourapp.com/callback",
  "smsFailover": {
    "enabled": true,
    "failoverSource": "54321",
    "fallbackText": "SMS fallback message"
  }
}

Send RCS Media Messages

Send an image, video, or other media file.

To do this:

• Send a POST request to /v5/messages.
• Provide sender, recipient, and the following required fields: mediaUrl, thumbnailUrl, filenameOverride
• Optionally, add a callback URL and MMS failover info.

RCS Media Message Elements

Example

json

{
  "messageType": "RCS_MEDIA",
  "source": "12345",
  "destination": "67890",
  "mediaUrl": "https://yourapp.com/image.jpg",
  "thumbnailUrl": "https://yourapp.com/thumb.jpg",
  "filenameOverride": "picture.jpg",
  "callbackURL": "https://yourapp.com/callback",
  "mmsFailover": {
    "enabled": true,
    "failoverSource": "54321",
    "fallbackText": "MMS fallback message",
    "mediaUrl": "https://yourapp.com/fallback.jpg",
    "subject": "Fallback Subject"
  }
}

Send RCS Card Message

Send a rich card with images, text, and interactive choices.

To do this:

• Send a POST request to /v5/messages.
• Include sender, recipient, card title, description, and image URLs.
• Add choices for user interaction (10 choices max).
• Optionally, add a callback URL and MMS failover info.

RCS Card Message Elements

Example

json

{
  "messageType": "RCS_CARD",
  "source": "12345",
  "destination": "67890",
  "title": "Welcome Card",
  "description": "This is a rich card message.",
  "height": "MEDIUM",
  "mediaUrl": "https://yourapp.com/card.jpg",
  "thumbnailUrl": "https://yourapp.com/card-thumb.jpg",
  "filenameOverride": "card.jpg",
  "callbackURL": "https://yourapp.com/callback",
  "choices": [
    {
      "title": "Option 1",
      "description": "First choice",
      "postbackData": "choice1"
    },
    {
      "title": "Option 2",
      "description": "Second choice",
      "postbackData": "choice2"
    }
  ],
  "mmsFailover": {
    "enabled": true,
    "failoverSource": "54321",
    "fallbackText": "Fallback card message",
    "mediaUrl": "https://yourapp.com/fallback-card.jpg",
    "subject": "Fallback Card"
  }
}

Send RCS Carousel Message

Send a carousel of multiple cards, each with images and choices.

To do this:

• Send a POST request to /v5/messages.
• Include sender, recipient, and an array of cards (10 cards max).
• Each card can have its own title, description, images, and choices.
• Optionally, add a callback URL and MMS failover info.

RCS Carousel Message Elements

Example

json

{
  "messageType": "RCS_CAROUSEL",
  "source": "12345",
  "destination": "67890",
  "cards": [
    {
      "title": "Card 1",
      "description": "First card in carousel.",
      "height": "MEDIUM",
      "mediaUrl": "https://yourapp.com/card1.jpg",
      "thumbnailUrl": "https://yourapp.com/card1-thumb.jpg",
      "filenameOverride": "card1.jpg",
      "choices": [
        {
          "title": "Option 1",
          "description": "First choice",
          "postbackData": "choice1"
        }
      ]
    },
    {
      "title": "Card 2",
      "description": "Second card in carousel.",
      "height": "MEDIUM",
      "mediaUrl": "https://yourapp.com/card2.jpg",
      "thumbnailUrl": "https://yourapp.com/card2-thumb.jpg",
      "filenameOverride": "card2.jpg",
      "choices": [
        {
          "title": "Option 2",
          "description": "Second choice",
          "postbackData": "choice2"
        }
      ]
    }
  ],
  "callbackURL": "https://yourapp.com/callback",
  "mmsFailover": {
    "enabled": true,
    "failoverSource": "54321",
    "fallbackText": "Fallback carousel message",
    "mediaUrl": "https://yourapp.com/fallback-carousel.jpg",
    "subject": "Fallback Carousel"
  }
}