Qikberry API Docs
SMSRCS Business Messaging
SMSRCS Business Messaging
Qikberry.AI
App
  1. Messages
  • RCS Introduction
  • Messages Support
  • Messages
    • Text
      POST
    • Media
      POST
    • Text Suggestions
      POST
    • Stand Alone Card
      POST
    • Carousel Card
      POST
  • Webhooks
    • Receiving Messages via Webhook
  • Help and Support
    • Getting Help: FAQs
  1. Messages

Stand Alone Card

POST
https://rest.qikberry.ai/v1/rcs/messages
A Stand Alone Rich Card is a visually enhanced message format in RCS Business Messaging that allows brands to send card may contain the following:
A. Media (image, GIF, or video)
B. Title text
C. Description text
D. Suggested replies and actions.
Rich cards create a more engaging and interactive user experience than simple SMS or RCS text messages.
A rich card can contain all of the listed items, but a card must contain at least an image or video to be valid.
A rich card can contain a maximum of four suggested actions or suggested replies.

Rich cards components#

[A] Media
Rich cards can include various media such as images, GIFs, and videos.
Supported image types:
JPEG/JPG
GIF
PNG
Supported video types:
H.263
M4V
MP4
MPEG
MPEG-4
WebM
Note: Poor-quality or oddly-sized images may appear distorted depending on device and carrier.
[B] Title
The title of a rich card acts like a headline designed to capture the user's attention and quickly convey the purpose of your message. Keep it concise, informative and within 200 characters.
[C] Description
The rich card description provides essential supporting information. It expands on the title, highlights key benefits, and encourages user action with a clear call to action. Descriptions can be up to 2,000 characters in length.
[D] Suggested replies and actions
Suggested replies help users interact with your agent in ways that it can easily respond to. Suggested replies can be up to 25 characters long.
suggested-replies.png
Suggested actions allow an agent to hook into native device actions and they provide a tightly integrated experience for the user. When relevant, suggested actions can make it easy to call customer support or find a location on the map.
Limit the number of suggested actions and suggested replies to what is useful to the user in a given context.
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://rest.qikberry.ai/v1/rcs/messages' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "to": "<MOBILE>",
    "agentID": "<AGENT_ID>",
    "message": {
        "templateId": "<TEMPLATE_ID>",
        "templateParams": {
            "media": {
                "contentInfo": {
                    "fileUrl": "<FILE_URL>",
                    "fileName": "<FILE_TYPE>",
                    "mimeType": "<MIME_TYPE>"
                }
            }
        }
    }
}'
Response Response Example
200 - Success
{
    "message": "1 numbers accepted",
    "data": [
        {
            "messageId": "a8XXXXXX-1bXX-4XXd-b5XX-5dXXXXXX:1",
            "mobile": "+9198XXXXXXXXX",
            "charges": 0.05
        }
    ]
}

Request

Header Params
Authorization
string 
required
Example:
Bearer <ACCESS_TOKEN>
Content-Type
string 
required
Example:
application/json
Body Params application/json
to
string 
required
agentID
string 
required
message
object 
required
templateId
string 
required
templateParams
object 
required
Examples

Responses

🟢200Success
application/json
Body
message
string 
required
data
array [object {3}] 
required
messageId
string 
optional
mobile
string 
optional
charges
number 
optional
🟠400Bad Request
🟠401Unauthorized
Previous
Text Suggestions
Next
Carousel Card
Built with