infoOverview
About this API
keySecurity
Authentication
Include your API credential in the request header. Keep credentials on the server and never expose them in client-side applications.
Locationheader
Field name
Authorization: Bearer <TOKEN>Example value
YOUR_ACCESS_TOKENuploadInput
Request Body
Send a application/json payload. Replace placeholder values with data from your integration.
Top-Level Fields
NameTypeRequirementDescription
tostringNot specifiedRequest value for to.categorystringNot specifiedRequest value for category.correlationIdstringNot specifiedRequest value for correlationId.messagePayloadobjectNot specifiedRequest value for messagePayload.{
"to": "917972086759",
"category": "promotional",
"correlationId": "jayant1938",
"messagePayload": {
"templateType": "carousel",
"richCardCarouselDetails": {
"cardWidth": "MEDIUM_WIDTH",
"cardsList": [
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Laptop Pro Series",
"cardDescription": "High-performance laptop for professionals with advanced graphics and all-day battery life.",
"suggestionsList": [
{
"urlAction": "https://google.com",
"typeOfAction": "url_action",
"suggestionText": "From ₹89,999",
"suggestionPostback": "laptop_pro_configure"
}
]
},
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Tablet Ultra",
"cardDescription": "Versatile tablet with premium display, perfect for creativity and productivity tasks.",
"suggestionsList": [
{
"urlAction": "https://store.example.com/tablet-ultra",
"typeOfAction": "url_action",
"suggestionText": "From ₹54,999",
"suggestionPostback": "tablet_ultra_purchase"
}
]
},
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Smartwatch Elite",
"cardDescription": "Advanced health monitoring, GPS, and smart features in a premium design.",
"suggestionsList": [
{
"urlAction": "https://store.example.com/smartwatch-elite",
"typeOfAction": "url_action",
"suggestionText": "₹24,999",
"suggestionPostback": "smartwatch_elite_shop"
}
]
}
],
"mediaHeight": "MEDIUM"
}
}
}{
"type": "object",
"properties": {
"to": {
"type": "string"
},
"category": {
"type": "string"
},
"correlationId": {
"type": "string"
},
"messagePayload": {
"type": "object",
"properties": {
"templateType": {
"type": "string"
},
"richCardCarouselDetails": {
"type": "object",
"properties": {
"cardWidth": {
"type": "string"
},
"cardsList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cardMedia": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"cardTitle": {
"type": "string"
},
"cardDescription": {
"type": "string"
},
"suggestionsList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"urlAction": {
"type": "string"
},
"typeOfAction": {
"type": "string"
},
"suggestionText": {
"type": "string"
},
"suggestionPostback": {
"type": "string"
}
}
}
}
}
}
},
"mediaHeight": {
"type": "string"
}
}
}
}
}
}
}androidRCS Messaging Sandbox
Test this RCS message
Edit the documented request body and send it to a simulated Android RCS conversation. No real message or API request is sent.
9:41signal_cellular_altwifibattery_full
arrow_back
1S
1SPOC RCSVerified business
videocamcallmore_vertToday
RCS chat with 1SPOC RCS
Ready to preview FreeFlow | Carousel.9:41
add
RCS messagemood
photo_cameracodeIntegration
Code Examples
Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.
shield_lockCredentials protectedAdd secrets only in your secure server environment.
curl --request POST 'https://api.example.com/rcs/api/v1/send-freeflow-message' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"to": "917972086759",
"category": "promotional",
"correlationId": "jayant1938",
"messagePayload": {
"templateType": "carousel",
"richCardCarouselDetails": {
"cardWidth": "MEDIUM_WIDTH",
"cardsList": [
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Laptop Pro Series",
"cardDescription": "High-performance laptop for professionals with advanced graphics and all-day battery life.",
"suggestionsList": [
{
"urlAction": "https://google.com",
"typeOfAction": "url_action",
"suggestionText": "From ₹89,999",
"suggestionPostback": "laptop_pro_configure"
}
]
},
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Tablet Ultra",
"cardDescription": "Versatile tablet with premium display, perfect for creativity and productivity tasks.",
"suggestionsList": [
{
"urlAction": "https://store.example.com/tablet-ultra",
"typeOfAction": "url_action",
"suggestionText": "From ₹54,999",
"suggestionPostback": "tablet_ultra_purchase"
}
]
},
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Smartwatch Elite",
"cardDescription": "Advanced health monitoring, GPS, and smart features in a premium design.",
"suggestionsList": [
{
"urlAction": "https://store.example.com/smartwatch-elite",
"typeOfAction": "url_action",
"suggestionText": "₹24,999",
"suggestionPostback": "smartwatch_elite_shop"
}
]
}
],
"mediaHeight": "MEDIUM"
}
}
}'const response = await fetch('https://api.example.com/rcs/api/v1/send-freeflow-message', {
method: 'POST',
headers: {
"Authorization": "Bearer <TOKEN>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"to": "917972086759",
"category": "promotional",
"correlationId": "jayant1938",
"messagePayload": {
"templateType": "carousel",
"richCardCarouselDetails": {
"cardWidth": "MEDIUM_WIDTH",
"cardsList": [
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Laptop Pro Series",
"cardDescription": "High-performance laptop for professionals with advanced graphics and all-day battery life.",
"suggestionsList": [
{
"urlAction": "https://google.com",
"typeOfAction": "url_action",
"suggestionText": "From ₹89,999",
"suggestionPostback": "laptop_pro_configure"
}
]
},
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Tablet Ultra",
"cardDescription": "Versatile tablet with premium display, perfect for creativity and productivity tasks.",
"suggestionsList": [
{
"urlAction": "https://store.example.com/tablet-ultra",
"typeOfAction": "url_action",
"suggestionText": "From ₹54,999",
"suggestionPostback": "tablet_ultra_purchase"
}
]
},
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Smartwatch Elite",
"cardDescription": "Advanced health monitoring, GPS, and smart features in a premium design.",
"suggestionsList": [
{
"urlAction": "https://store.example.com/smartwatch-elite",
"typeOfAction": "url_action",
"suggestionText": "₹24,999",
"suggestionPostback": "smartwatch_elite_shop"
}
]
}
],
"mediaHeight": "MEDIUM"
}
}
})
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);const response = await fetch('https://api.example.com/rcs/api/v1/send-freeflow-message', {
method: 'POST',
headers: {
"Authorization": "Bearer <TOKEN>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"to": "917972086759",
"category": "promotional",
"correlationId": "jayant1938",
"messagePayload": {
"templateType": "carousel",
"richCardCarouselDetails": {
"cardWidth": "MEDIUM_WIDTH",
"cardsList": [
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Laptop Pro Series",
"cardDescription": "High-performance laptop for professionals with advanced graphics and all-day battery life.",
"suggestionsList": [
{
"urlAction": "https://google.com",
"typeOfAction": "url_action",
"suggestionText": "From ₹89,999",
"suggestionPostback": "laptop_pro_configure"
}
]
},
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Tablet Ultra",
"cardDescription": "Versatile tablet with premium display, perfect for creativity and productivity tasks.",
"suggestionsList": [
{
"urlAction": "https://store.example.com/tablet-ultra",
"typeOfAction": "url_action",
"suggestionText": "From ₹54,999",
"suggestionPostback": "tablet_ultra_purchase"
}
]
},
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Smartwatch Elite",
"cardDescription": "Advanced health monitoring, GPS, and smart features in a premium design.",
"suggestionsList": [
{
"urlAction": "https://store.example.com/smartwatch-elite",
"typeOfAction": "url_action",
"suggestionText": "₹24,999",
"suggestionPostback": "smartwatch_elite_shop"
}
]
}
],
"mediaHeight": "MEDIUM"
}
}
})
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);import json
import requests
url = 'https://api.example.com/rcs/api/v1/send-freeflow-message'
headers = {
"Authorization": "Bearer <TOKEN>",
"Content-Type": "application/json"
}
payload = json.loads(r'''{
"to": "917972086759",
"category": "promotional",
"correlationId": "jayant1938",
"messagePayload": {
"templateType": "carousel",
"richCardCarouselDetails": {
"cardWidth": "MEDIUM_WIDTH",
"cardsList": [
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Laptop Pro Series",
"cardDescription": "High-performance laptop for professionals with advanced graphics and all-day battery life.",
"suggestionsList": [
{
"urlAction": "https://google.com",
"typeOfAction": "url_action",
"suggestionText": "From ₹89,999",
"suggestionPostback": "laptop_pro_configure"
}
]
},
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Tablet Ultra",
"cardDescription": "Versatile tablet with premium display, perfect for creativity and productivity tasks.",
"suggestionsList": [
{
"urlAction": "https://store.example.com/tablet-ultra",
"typeOfAction": "url_action",
"suggestionText": "From ₹54,999",
"suggestionPostback": "tablet_ultra_purchase"
}
]
},
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Smartwatch Elite",
"cardDescription": "Advanced health monitoring, GPS, and smart features in a premium design.",
"suggestionsList": [
{
"urlAction": "https://store.example.com/smartwatch-elite",
"typeOfAction": "url_action",
"suggestionText": "₹24,999",
"suggestionPostback": "smartwatch_elite_shop"
}
]
}
],
"mediaHeight": "MEDIUM"
}
}
}''')
response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
var client = HttpClient.newHttpClient();
String body = """
{
"to": "917972086759",
"category": "promotional",
"correlationId": "jayant1938",
"messagePayload": {
"templateType": "carousel",
"richCardCarouselDetails": {
"cardWidth": "MEDIUM_WIDTH",
"cardsList": [
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Laptop Pro Series",
"cardDescription": "High-performance laptop for professionals with advanced graphics and all-day battery life.",
"suggestionsList": [
{
"urlAction": "https://google.com",
"typeOfAction": "url_action",
"suggestionText": "From ₹89,999",
"suggestionPostback": "laptop_pro_configure"
}
]
},
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Tablet Ultra",
"cardDescription": "Versatile tablet with premium display, perfect for creativity and productivity tasks.",
"suggestionsList": [
{
"urlAction": "https://store.example.com/tablet-ultra",
"typeOfAction": "url_action",
"suggestionText": "From ₹54,999",
"suggestionPostback": "tablet_ultra_purchase"
}
]
},
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Smartwatch Elite",
"cardDescription": "Advanced health monitoring, GPS, and smart features in a premium design.",
"suggestionsList": [
{
"urlAction": "https://store.example.com/smartwatch-elite",
"typeOfAction": "url_action",
"suggestionText": "₹24,999",
"suggestionPostback": "smartwatch_elite_shop"
}
]
}
],
"mediaHeight": "MEDIUM"
}
}
}
""";
var request = HttpRequest.newBuilder(URI.create("https://api.example.com/rcs/api/v1/send-freeflow-message"))
.header("Authorization", "Bearer <TOKEN>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString(body))
.build();
var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());<?php
$curl = curl_init();
$payload = '{
"to": "917972086759",
"category": "promotional",
"correlationId": "jayant1938",
"messagePayload": {
"templateType": "carousel",
"richCardCarouselDetails": {
"cardWidth": "MEDIUM_WIDTH",
"cardsList": [
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Laptop Pro Series",
"cardDescription": "High-performance laptop for professionals with advanced graphics and all-day battery life.",
"suggestionsList": [
{
"urlAction": "https://google.com",
"typeOfAction": "url_action",
"suggestionText": "From ₹89,999",
"suggestionPostback": "laptop_pro_configure"
}
]
},
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Tablet Ultra",
"cardDescription": "Versatile tablet with premium display, perfect for creativity and productivity tasks.",
"suggestionsList": [
{
"urlAction": "https://store.example.com/tablet-ultra",
"typeOfAction": "url_action",
"suggestionText": "From ₹54,999",
"suggestionPostback": "tablet_ultra_purchase"
}
]
},
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Smartwatch Elite",
"cardDescription": "Advanced health monitoring, GPS, and smart features in a premium design.",
"suggestionsList": [
{
"urlAction": "https://store.example.com/smartwatch-elite",
"typeOfAction": "url_action",
"suggestionText": "₹24,999",
"suggestionPostback": "smartwatch_elite_shop"
}
]
}
],
"mediaHeight": "MEDIUM"
}
}
}';
curl_setopt_array($curl, [
CURLOPT_URL => 'https://api.example.com/rcs/api/v1/send-freeflow-message',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => ["Authorization: Bearer <TOKEN>","Content-Type: application/json"],
CURLOPT_POSTFIELDS => $payload,
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = AuthenticationHeaderValue.Parse("Bearer <TOKEN>");
var json = """
{
"to": "917972086759",
"category": "promotional",
"correlationId": "jayant1938",
"messagePayload": {
"templateType": "carousel",
"richCardCarouselDetails": {
"cardWidth": "MEDIUM_WIDTH",
"cardsList": [
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Laptop Pro Series",
"cardDescription": "High-performance laptop for professionals with advanced graphics and all-day battery life.",
"suggestionsList": [
{
"urlAction": "https://google.com",
"typeOfAction": "url_action",
"suggestionText": "From ₹89,999",
"suggestionPostback": "laptop_pro_configure"
}
]
},
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Tablet Ultra",
"cardDescription": "Versatile tablet with premium display, perfect for creativity and productivity tasks.",
"suggestionsList": [
{
"urlAction": "https://store.example.com/tablet-ultra",
"typeOfAction": "url_action",
"suggestionText": "From ₹54,999",
"suggestionPostback": "tablet_ultra_purchase"
}
]
},
{
"cardMedia": {
"url": "https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg",
"type": "image"
},
"cardTitle": "Smartwatch Elite",
"cardDescription": "Advanced health monitoring, GPS, and smart features in a premium design.",
"suggestionsList": [
{
"urlAction": "https://store.example.com/smartwatch-elite",
"typeOfAction": "url_action",
"suggestionText": "₹24,999",
"suggestionPostback": "smartwatch_elite_shop"
}
]
}
],
"mediaHeight": "MEDIUM"
}
}
}
""";
using var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.example.com/rcs/api/v1/send-freeflow-message", content);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());package main
import (
"fmt"
"io"
"net/http"
"bytes"
)
func main() {
request, err := http.NewRequest("POST", "https://api.example.com/rcs/api/v1/send-freeflow-message", bytes.NewBufferString("{\n \"to\": \"917972086759\",\n \"category\": \"promotional\",\n \"correlationId\": \"jayant1938\",\n \"messagePayload\": {\n \"templateType\": \"carousel\",\n \"richCardCarouselDetails\": {\n \"cardWidth\": \"MEDIUM_WIDTH\",\n \"cardsList\": [\n {\n \"cardMedia\": {\n \"url\": \"https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg\",\n \"type\": \"image\"\n },\n \"cardTitle\": \"Laptop Pro Series\",\n \"cardDescription\": \"High-performance laptop for professionals with advanced graphics and all-day battery life.\",\n \"suggestionsList\": [\n {\n \"urlAction\": \"https://google.com\",\n \"typeOfAction\": \"url_action\",\n \"suggestionText\": \"From ₹89,999\",\n \"suggestionPostback\": \"laptop_pro_configure\"\n }\n ]\n },\n {\n \"cardMedia\": {\n \"url\": \"https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg\",\n \"type\": \"image\"\n },\n \"cardTitle\": \"Tablet Ultra\",\n \"cardDescription\": \"Versatile tablet with premium display, perfect for creativity and productivity tasks.\",\n \"suggestionsList\": [\n {\n \"urlAction\": \"https://store.example.com/tablet-ultra\",\n \"typeOfAction\": \"url_action\",\n \"suggestionText\": \"From ₹54,999\",\n \"suggestionPostback\": \"tablet_ultra_purchase\"\n }\n ]\n },\n {\n \"cardMedia\": {\n \"url\": \"https://images.pexels.com/photos/1366942/pexels-photo-1366942.jpeg\",\n \"type\": \"image\"\n },\n \"cardTitle\": \"Smartwatch Elite\",\n \"cardDescription\": \"Advanced health monitoring, GPS, and smart features in a premium design.\",\n \"suggestionsList\": [\n {\n \"urlAction\": \"https://store.example.com/smartwatch-elite\",\n \"typeOfAction\": \"url_action\",\n \"suggestionText\": \"₹24,999\",\n \"suggestionPostback\": \"smartwatch_elite_shop\"\n }\n ]\n }\n ],\n \"mediaHeight\": \"MEDIUM\"\n }\n }\n}"))
if err != nil { panic(err) }
request.Header.Set("Content-Type", "application/json")
request.Header.Set("Accept", "application/json")
request.Header.Set("Authorization", "Bearer <TOKEN>")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
data, err := io.ReadAll(response.Body)
if err != nil { panic(err) }
if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
fmt.Println(string(data))
}downloadOutput
Response
A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.
{}{}ruleHTTP Responses
Status Codes
200Successful response