Endpoint
Headers
| Header | Value |
|---|---|
Accept | application/json |
Authorization | Bearer {API_TOKEN} |
Content-Type | application/json |
Body parameters
Approved RCS Sender ID.
Sender ID route. Accepted values:
transactional or promotional. Defaults to transactional.RCS content type. Accepted values:
text, standalone, or carousel.Text message body. Required when
template_type is text.When
true, Sling falls back to SMS if the recipient does not support RCS.Sender ID used for the SMS fallback when
fallback_sms is true. For example, Sling while your RCS sender is RCS.Interactive suggestion chip objects. See Suggestion object below.
Required when
template_type is standalone.Required when
template_type is carousel.Public HTTPS URL that receives delivery updates.
Custom message ID.
ISO datetime to schedule the message.
Recipient (provide exactly one)
Recipient phone number.
Saved contact ID.
Array of saved contact IDs.
Single group ID.
Array of group IDs.
Newline-separated raw phone numbers.
SMS fallback
Set
fallback_sms to true and Sling will re-send the message as a standard SMS if the recipient does not support RCS. Use fallback_sms_sender to set the SMS Sender ID for that fallback (for example, Sling when your RCS sender is RCS).Suggestion object
Usesuggestions to add interactive chips. Every suggestion object includes:
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | Suggestion type |
text | string | Yes | Label shown on the chip |
postback | string | Yes | Value sent back when the user taps the chip |
Suggestion types
reply
reply
| Field | Type | Required |
|---|---|---|
type | string | Yes, must be reply |
text | string | Yes |
postback | string | Yes |
url
url
| Field | Type | Required |
|---|---|---|
type | string | Yes, must be url |
text | string | Yes |
postback | string | Yes |
url | string | Yes |
dialer
dialer
| Field | Type | Required |
|---|---|---|
type | string | Yes, must be dialer |
text | string | Yes |
postback | string | Yes |
phone | string | Yes |
location_latlng
location_latlng
| Field | Type | Required |
|---|---|---|
type | string | Yes, must be location_latlng |
text | string | Yes |
postback | string | Yes |
lat | string | Yes |
lng | string | Yes |
label | string | Yes |
location_query
location_query
| Field | Type | Required |
|---|---|---|
type | string | Yes, must be location_query |
text | string | Yes |
postback | string | Yes |
query | string | Yes |
share_location
share_location
calendar_event
calendar_event
| Field | Type | Required |
|---|---|---|
type | string | Yes, must be calendar_event |
text | string | Yes |
postback | string | Yes |
datetime | string | Yes |
title | string | Yes |
description | string | Yes |
Response fields
"success" when the message is accepted.Unique message ID. Use it with Message Status.
Sender ID used for delivery.
Normalized recipient phone number.
Credits deducted for this message.
Error responses
| Status | Meaning |
|---|---|
400 | Missing or invalid request fields |
400 | Insufficient credit |
400 | This number is RCS disabled. You cannot send an RCS Message (when fallback is off) |
400 | Sender not approved for RCS |
