Messaging · RCS
Sends an RCS message.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication
Headers
| Name | Type | Notes |
|---|---|---|
Idempotency-Key | string | Up to 255 charactersRetries with the same key return the original result. See Idempotency |
Request body
application/json, required
agentIdstringrequiredtostringrequiredtextstringUp to 3072 characters.
contentobjectOne of:
Option 1 (3 fields)
typestringrequiredOne of
text.textstringrequiredUp to 3072 characters.
suggestionsarray of objectUp to 11 items.
One of:
Option 1 (3 fields)
typestringrequiredOne of
reply.textstringrequiredUp to 25 characters.
postbackDatastring
Option 2 (4 fields)
typestringrequiredOne of
dial.textstringrequiredUp to 25 characters.
phoneNumberstringrequiredpostbackDatastring
Option 3 (6 fields)
typestringrequiredOne of
openUrl.textstringrequiredUp to 25 characters.
urlstring (URL)requiredapplicationstringOne of
BROWSER,WEBVIEW. DefaultBROWSER.webviewViewModestringOne of
FULL,HALF,TALL. DefaultFULL.postbackDatastring
Option 4 (7 fields)
typestringrequiredOne of
viewLocation.textstringrequiredUp to 25 characters.
latitudenumberlongitudenumberquerystringlabelstringpostbackDatastring
Option 5 (3 fields)
typestringrequiredOne of
shareLocation.textstringrequiredUp to 25 characters.
postbackDatastring
Option 6 (7 fields)
typestringrequiredOne of
calendarEvent.textstringrequiredUp to 25 characters.
startTimestring (date-time)requiredendTimestring (date-time)requiredtitlestringrequiredUp to 100 characters.
descriptionstringUp to 500 characters.
postbackDatastring
Option 2 (3 fields)
typestringrequiredOne of
media.mediaobjectrequired3 child fields
urlstring (URL)requiredthumbnailUrlstring (URL)heightstringOne of
SHORT,MEDIUM,TALL. DefaultMEDIUM.
suggestionsarray of objectUp to 11 items.
One of:
Option 1 (3 fields)
typestringrequiredOne of
reply.textstringrequiredUp to 25 characters.
postbackDatastring
Option 2 (4 fields)
typestringrequiredOne of
dial.textstringrequiredUp to 25 characters.
phoneNumberstringrequiredpostbackDatastring
Option 3 (6 fields)
typestringrequiredOne of
openUrl.textstringrequiredUp to 25 characters.
urlstring (URL)requiredapplicationstringOne of
BROWSER,WEBVIEW. DefaultBROWSER.webviewViewModestringOne of
FULL,HALF,TALL. DefaultFULL.postbackDatastring
Option 4 (7 fields)
typestringrequiredOne of
viewLocation.textstringrequiredUp to 25 characters.
latitudenumberlongitudenumberquerystringlabelstringpostbackDatastring
Option 5 (3 fields)
typestringrequiredOne of
shareLocation.textstringrequiredUp to 25 characters.
postbackDatastring
Option 6 (7 fields)
typestringrequiredOne of
calendarEvent.textstringrequiredUp to 25 characters.
startTimestring (date-time)requiredendTimestring (date-time)requiredtitlestringrequiredUp to 100 characters.
descriptionstringUp to 500 characters.
postbackDatastring
Option 3 (5 fields)
typestringrequiredOne of
card.cardobjectrequired4 child fields
titlestringUp to 200 characters.
descriptionstringUp to 2000 characters.
mediaobject3 child fields
urlstring (URL)requiredthumbnailUrlstring (URL)heightstringOne of
SHORT,MEDIUM,TALL. DefaultMEDIUM.
suggestionsarray of objectUp to 4 items.
One of:
Option 1 (3 fields)
typestringrequiredOne of
reply.textstringrequiredUp to 25 characters.
postbackDatastring
Option 2 (4 fields)
typestringrequiredOne of
dial.textstringrequiredUp to 25 characters.
phoneNumberstringrequiredpostbackDatastring
Option 3 (6 fields)
typestringrequiredOne of
openUrl.textstringrequiredUp to 25 characters.
urlstring (URL)requiredapplicationstringOne of
BROWSER,WEBVIEW. DefaultBROWSER.webviewViewModestringOne of
FULL,HALF,TALL. DefaultFULL.postbackDatastring
Option 4 (7 fields)
typestringrequiredOne of
viewLocation.textstringrequiredUp to 25 characters.
latitudenumberlongitudenumberquerystringlabelstringpostbackDatastring
Option 5 (3 fields)
typestringrequiredOne of
shareLocation.textstringrequiredUp to 25 characters.
postbackDatastring
Option 6 (7 fields)
typestringrequiredOne of
calendarEvent.textstringrequiredUp to 25 characters.
startTimestring (date-time)requiredendTimestring (date-time)requiredtitlestringrequiredUp to 100 characters.
descriptionstringUp to 500 characters.
postbackDatastring
orientationstringOne of
VERTICAL,HORIZONTAL. DefaultVERTICAL.thumbnailAlignmentstringOne of
LEFT,RIGHT. DefaultLEFT.suggestionsarray of objectUp to 11 items.
One of:
Option 1 (3 fields)
typestringrequiredOne of
reply.textstringrequiredUp to 25 characters.
postbackDatastring
Option 2 (4 fields)
typestringrequiredOne of
dial.textstringrequiredUp to 25 characters.
phoneNumberstringrequiredpostbackDatastring
Option 3 (6 fields)
typestringrequiredOne of
openUrl.textstringrequiredUp to 25 characters.
urlstring (URL)requiredapplicationstringOne of
BROWSER,WEBVIEW. DefaultBROWSER.webviewViewModestringOne of
FULL,HALF,TALL. DefaultFULL.postbackDatastring
Option 4 (7 fields)
typestringrequiredOne of
viewLocation.textstringrequiredUp to 25 characters.
latitudenumberlongitudenumberquerystringlabelstringpostbackDatastring
Option 5 (3 fields)
typestringrequiredOne of
shareLocation.textstringrequiredUp to 25 characters.
postbackDatastring
Option 6 (7 fields)
typestringrequiredOne of
calendarEvent.textstringrequiredUp to 25 characters.
startTimestring (date-time)requiredendTimestring (date-time)requiredtitlestringrequiredUp to 100 characters.
descriptionstringUp to 500 characters.
postbackDatastring
Option 4 (4 fields)
typestringrequiredOne of
carousel.cardsarray of objectrequiredAt least 2 items. Up to 10 items.
4 child fields
titlestringUp to 200 characters.
descriptionstringUp to 2000 characters.
mediaobject3 child fields
urlstring (URL)requiredthumbnailUrlstring (URL)heightstringOne of
SHORT,MEDIUM,TALL. DefaultMEDIUM.
suggestionsarray of objectUp to 4 items.
One of:
Option 1 (3 fields)
typestringrequiredOne of
reply.textstringrequiredUp to 25 characters.
postbackDatastring
Option 2 (4 fields)
typestringrequiredOne of
dial.textstringrequiredUp to 25 characters.
phoneNumberstringrequiredpostbackDatastring
Option 3 (6 fields)
typestringrequiredOne of
openUrl.textstringrequiredUp to 25 characters.
urlstring (URL)requiredapplicationstringOne of
BROWSER,WEBVIEW. DefaultBROWSER.webviewViewModestringOne of
FULL,HALF,TALL. DefaultFULL.postbackDatastring
Option 4 (7 fields)
typestringrequiredOne of
viewLocation.textstringrequiredUp to 25 characters.
latitudenumberlongitudenumberquerystringlabelstringpostbackDatastring
Option 5 (3 fields)
typestringrequiredOne of
shareLocation.textstringrequiredUp to 25 characters.
postbackDatastring
Option 6 (7 fields)
typestringrequiredOne of
calendarEvent.textstringrequiredUp to 25 characters.
startTimestring (date-time)requiredendTimestring (date-time)requiredtitlestringrequiredUp to 100 characters.
descriptionstringUp to 500 characters.
postbackDatastring
cardWidthstringOne of
SMALL,MEDIUM. DefaultMEDIUM.suggestionsarray of objectUp to 11 items.
One of:
Option 1 (3 fields)
typestringrequiredOne of
reply.textstringrequiredUp to 25 characters.
postbackDatastring
Option 2 (4 fields)
typestringrequiredOne of
dial.textstringrequiredUp to 25 characters.
phoneNumberstringrequiredpostbackDatastring
Option 3 (6 fields)
typestringrequiredOne of
openUrl.textstringrequiredUp to 25 characters.
urlstring (URL)requiredapplicationstringOne of
BROWSER,WEBVIEW. DefaultBROWSER.webviewViewModestringOne of
FULL,HALF,TALL. DefaultFULL.postbackDatastring
Option 4 (7 fields)
typestringrequiredOne of
viewLocation.textstringrequiredUp to 25 characters.
latitudenumberlongitudenumberquerystringlabelstringpostbackDatastring
Option 5 (3 fields)
typestringrequiredOne of
shareLocation.textstringrequiredUp to 25 characters.
postbackDatastring
Option 6 (7 fields)
typestringrequiredOne of
calendarEvent.textstringrequiredUp to 25 characters.
startTimestring (date-time)requiredendTimestring (date-time)requiredtitlestringrequiredUp to 100 characters.
descriptionstringUp to 500 characters.
postbackDatastring
fallbackTextstringUp to 3072 characters.
ttlSecondsintegerAt least 1.
Example
curl -X POST "https://api.pozy.ai/v1/rcs/messages" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"agentId": "6b99fbd950277956c14bd44d",
"to": "+14155550123"
}'import { randomUUID } from "node:crypto";
const res = await fetch("https://api.pozy.ai/v1/rcs/messages", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Idempotency-Key": randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
agentId: "6b99fbd950277956c14bd44d",
to: "+14155550123"
}),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.post(
"https://api.pozy.ai/v1/rcs/messages",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"agentId": "6b99fbd950277956c14bd44d",
"to": "+14155550123",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
idstringconversationIdstringstatusstringOne of
sent.
{
"id": "6bfebd43ddc270f6d2c56fc5",
"conversationId": "6e525f3820fc636aa96d2ee9",
"status": "sent"
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is read-only, scoped to other profiles, or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.