Telnyx_Test

Send an RCS message

POST

/messsages/rcs

RCS messaging

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/messsages/rcs' \
--header 'Content-Type: application/json' \
--data-raw '{
    "agent_id": "Agent007",
    "agent_message": {
        "content_message": {
            "content_info": {
                "file_url": "https://example.com/elephant.jpg",
                "force_refresh": true,
                "thumbnail_url": "string"
            },
            "rich_card": {
                "carousel_card": {
                    "card_contents": [
                        {
                            "description": "string",
                            "media": {
                                "content_info": {
                                    "file_url": "https://example.com/elephant.jpg",
                                    "force_refresh": true,
                                    "thumbnail_url": "string"
                                },
                                "height": "HEIGHT_UNSPECIFIED"
                            },
                            "suggestions": [
                                {
                                    "action": {
                                        "create_calendar_event_action": {
                                            "description": "string",
                                            "end_time": "2024-10-02T15:02:31Z",
                                            "start_time": "2024-10-02T15:01:23Z",
                                            "title": "string"
                                        },
                                        "dial_action": {
                                            "phone_number": "+13125551234"
                                        },
                                        "fallback_url": "string",
                                        "open_url_action": {
                                            "application": "OPEN_URL_APPLICATION_UNSPECIFIED",
                                            "description": "string",
                                            "url": "http://example.com",
                                            "webview_view_mode": "WEBVIEW_VIEW_MODE_UNSPECIFIED"
                                        },
                                        "postback_data": "string",
                                        "share_location_action": {},
                                        "text": "Hello world",
                                        "view_location_action": {
                                            "label": "string",
                                            "lat_long": {
                                                "latitude": 41.8,
                                                "longitude": -87.6
                                            },
                                            "query": "string"
                                        }
                                    },
                                    "reply": {
                                        "postback_data": "string",
                                        "text": "string"
                                    }
                                }
                            ],
                            "title": "Elephant"
                        }
                    ],
                    "card_width": "CARD_WIDTH_UNSPECIFIED"
                },
                "standalone_card": {
                    "card_content": {
                        "description": "string",
                        "media": {
                            "content_info": {
                                "file_url": "https://example.com/elephant.jpg",
                                "force_refresh": true,
                                "thumbnail_url": "string"
                            },
                            "height": "HEIGHT_UNSPECIFIED"
                        },
                        "suggestions": [
                            {
                                "action": {
                                    "create_calendar_event_action": {
                                        "description": "string",
                                        "end_time": "2024-10-02T15:02:31Z",
                                        "start_time": "2024-10-02T15:01:23Z",
                                        "title": "string"
                                    },
                                    "dial_action": {
                                        "phone_number": "+13125551234"
                                    },
                                    "fallback_url": "string",
                                    "open_url_action": {
                                        "application": "OPEN_URL_APPLICATION_UNSPECIFIED",
                                        "description": "string",
                                        "url": "http://example.com",
                                        "webview_view_mode": "WEBVIEW_VIEW_MODE_UNSPECIFIED"
                                    },
                                    "postback_data": "string",
                                    "share_location_action": {},
                                    "text": "Hello world",
                                    "view_location_action": {
                                        "label": "string",
                                        "lat_long": {
                                            "latitude": 41.8,
                                            "longitude": -87.6
                                        },
                                        "query": "string"
                                    }
                                },
                                "reply": {
                                    "postback_data": "string",
                                    "text": "string"
                                }
                            }
                        ],
                        "title": "Elephant"
                    },
                    "card_orientation": "CARD_ORIENTATION_UNSPECIFIED",
                    "thumbnail_image_alignment": "THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED"
                }
            },
            "suggestions": [
                {
                    "action": {
                        "create_calendar_event_action": {
                            "description": "string",
                            "end_time": "2024-10-02T15:02:31Z",
                            "start_time": "2024-10-02T15:01:23Z",
                            "title": "string"
                        },
                        "dial_action": {
                            "phone_number": "+13125551234"
                        },
                        "fallback_url": "string",
                        "open_url_action": {
                            "application": "OPEN_URL_APPLICATION_UNSPECIFIED",
                            "description": "string",
                            "url": "http://example.com",
                            "webview_view_mode": "WEBVIEW_VIEW_MODE_UNSPECIFIED"
                        },
                        "postback_data": "string",
                        "share_location_action": {},
                        "text": "Hello world",
                        "view_location_action": {
                            "label": "string",
                            "lat_long": {
                                "latitude": 41.8,
                                "longitude": -87.6
                            },
                            "query": "string"
                        }
                    },
                    "reply": {
                        "postback_data": "string",
                        "text": "string"
                    }
                }
            ],
            "text": "Hello world!"
        },
        "event": {
            "event_type": "TYPE_UNSPECIFIED"
        },
        "expire_time": "2024-10-02T15:01:23Z",
        "ttl": "10.5s"
    },
    "messaging_profile_id": "string",
    "mms_fallback": {
        "from": "+13125551234",
        "media_urls": [
            "string"
        ],
        "subject": "Test Message",
        "text": "Hello world!"
    },
    "sms_fallback": {
        "from": "+13125551234",
        "text": "Hello world!"
    },
    "to": "+13125551234",
    "type": "RCS",
    "webhook_url": "string"
}'

Response Example

200 - Example 1

{
    "data": {
        "body": {
            "content_message": {
                "content_info": {
                    "file_url": "https://example.com/elephant.jpg",
                    "force_refresh": true,
                    "thumbnail_url": "string"
                },
                "rich_card": {
                    "carousel_card": {
                        "card_contents": [
                            {
                                "description": "string",
                                "media": {
                                    "content_info": {
                                        "file_url": "https://example.com/elephant.jpg",
                                        "force_refresh": true,
                                        "thumbnail_url": "string"
                                    },
                                    "height": "HEIGHT_UNSPECIFIED"
                                },
                                "suggestions": [
                                    {
                                        "action": {
                                            "create_calendar_event_action": {
                                                "description": "string",
                                                "end_time": "2024-10-02T15:02:31Z",
                                                "start_time": "2024-10-02T15:01:23Z",
                                                "title": "string"
                                            },
                                            "dial_action": {
                                                "phone_number": "+13125551234"
                                            },
                                            "fallback_url": "string",
                                            "open_url_action": {
                                                "application": "OPEN_URL_APPLICATION_UNSPECIFIED",
                                                "description": "string",
                                                "url": "http://example.com",
                                                "webview_view_mode": "WEBVIEW_VIEW_MODE_UNSPECIFIED"
                                            },
                                            "postback_data": "string",
                                            "share_location_action": {},
                                            "text": "Hello world",
                                            "view_location_action": {
                                                "label": "string",
                                                "lat_long": {
                                                    "latitude": 41.8,
                                                    "longitude": -87.6
                                                },
                                                "query": "string"
                                            }
                                        },
                                        "reply": {
                                            "postback_data": "string",
                                            "text": "string"
                                        }
                                    }
                                ],
                                "title": "Elephant"
                            }
                        ],
                        "card_width": "CARD_WIDTH_UNSPECIFIED"
                    },
                    "standalone_card": {
                        "card_content": {
                            "description": "string",
                            "media": {
                                "content_info": {
                                    "file_url": "https://example.com/elephant.jpg",
                                    "force_refresh": true,
                                    "thumbnail_url": "string"
                                },
                                "height": "HEIGHT_UNSPECIFIED"
                            },
                            "suggestions": [
                                {
                                    "action": {
                                        "create_calendar_event_action": {
                                            "description": "string",
                                            "end_time": "2024-10-02T15:02:31Z",
                                            "start_time": "2024-10-02T15:01:23Z",
                                            "title": "string"
                                        },
                                        "dial_action": {
                                            "phone_number": "+13125551234"
                                        },
                                        "fallback_url": "string",
                                        "open_url_action": {
                                            "application": "OPEN_URL_APPLICATION_UNSPECIFIED",
                                            "description": "string",
                                            "url": "http://example.com",
                                            "webview_view_mode": "WEBVIEW_VIEW_MODE_UNSPECIFIED"
                                        },
                                        "postback_data": "string",
                                        "share_location_action": {},
                                        "text": "Hello world",
                                        "view_location_action": {
                                            "label": "string",
                                            "lat_long": {
                                                "latitude": 41.8,
                                                "longitude": -87.6
                                            },
                                            "query": "string"
                                        }
                                    },
                                    "reply": {
                                        "postback_data": "string",
                                        "text": "string"
                                    }
                                }
                            ],
                            "title": "Elephant"
                        },
                        "card_orientation": "CARD_ORIENTATION_UNSPECIFIED",
                        "thumbnail_image_alignment": "THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED"
                    }
                },
                "suggestions": [
                    {
                        "action": {
                            "create_calendar_event_action": {
                                "description": "string",
                                "end_time": "2024-10-02T15:02:31Z",
                                "start_time": "2024-10-02T15:01:23Z",
                                "title": "string"
                            },
                            "dial_action": {
                                "phone_number": "+13125551234"
                            },
                            "fallback_url": "string",
                            "open_url_action": {
                                "application": "OPEN_URL_APPLICATION_UNSPECIFIED",
                                "description": "string",
                                "url": "http://example.com",
                                "webview_view_mode": "WEBVIEW_VIEW_MODE_UNSPECIFIED"
                            },
                            "postback_data": "string",
                            "share_location_action": {},
                            "text": "Hello world",
                            "view_location_action": {
                                "label": "string",
                                "lat_long": {
                                    "latitude": 41.8,
                                    "longitude": -87.6
                                },
                                "query": "string"
                            }
                        },
                        "reply": {
                            "postback_data": "string",
                            "text": "string"
                        }
                    }
                ],
                "text": "Hello world!"
            },
            "event": {
                "event_type": "TYPE_UNSPECIFIED"
            },
            "expire_time": "2024-10-02T15:01:23Z",
            "ttl": "10.5s"
        },
        "direction": "outbound",
        "encoding": "utf-8",
        "from": {
            "agent_id": "Agent007",
            "agent_name": "Test Agent",
            "carrier": "Telnyx"
        },
        "id": "4031938e-60e4-4235-a8dd-0b1c55a23e7a",
        "messaging_profile_id": "4001781e-626f-4a41-a914-b1b682150f94",
        "organization_id": "9f61d8e1-7687-4d6d-9cae-9ff682985983",
        "received_at": "2019-08-24T14:15:22Z",
        "record_type": "message",
        "to": [
            {
                "carrier": "Verizon Wireless",
                "line_type": "Wireless",
                "phone_number": "+13125551234",
                "status": "queued"
            }
        ],
        "type": "RCS"
    }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

agent_id

string

required

RCS Agent ID

Example:

Agent007

agent_message

object (RCSAgentMessage)

required

content_message

object (RCSContentMessage)

optional

event

object (RCSEvent)

optional

RCS Event to send to the recipient

expire_time

string <date-time>

optional

Timestamp in UTC of when this message is considered expired

Example:

2024-10-02T15:01:23Z

ttl

string

optional

Duration in seconds ending with 's'

Example:

10.5s

messaging_profile_id

string

required

A valid messaging profile ID

mms_fallback

object (MMSFallback)

optional

from

string

optional

Phone number in +E.164 format

Example:

+13125551234

media_urls

array[string]

optional

List of media URLs

subject

string

optional

Subject of the message

Example:

Test Message

text

string

optional

Text

Example:

Hello world!

sms_fallback

object (SMSFallback)

optional

from

string

optional

Phone number in +E.164 format

Example:

+13125551234

text

string

optional

Text (maximum 3072 characters)

Example:

Hello world!

string

required

Phone number in +E.164 format

Example:

+13125551234

type

enum<string>

optional

Message type - must be set to "RCS"

Allowed value:

RCS

Example:

RCS

webhook_url

string <url>

optional

The URL where webhooks related to this message will be sent.

Examples

Responses

🟢200OK

application/json

Successful operation

Body

data

object

optional

body

object (RCSAgentMessage)

optional

direction

string

optional

Example:

outbound

encoding

string

optional

Example:

utf-8

from

object (RCSFrom)

optional

string

optional

message ID

Example:

4031938e-60e4-4235-a8dd-0b1c55a23e7a

messaging_profile_id

string

optional

Example:

4001781e-626f-4a41-a914-b1b682150f94

organization_id

string

optional

Example:

9f61d8e1-7687-4d6d-9cae-9ff682985983

received_at

string <date-time>

optional

record_type

string

optional

Example:

message

array[object (RCSToItem) {4}]

optional

type

string

optional

Example:

RCS

🔴500Server Error

Modified at 2025-06-16 19:14:41

List messaging URL domains

List all RCS agents