Sign in

v1

latestOpenAPI 3.1.02026-07-2693628.3 KB
RCS Business Messaging

Send an RCS message

Sends a message from an RBM agent to a mobile device. The message can contain text, rich card, and suggestions. The message can also be revoked between the time that it is sent and the time that it is delivered.<br><br><a href="https://developer-aggregation.vibes.com/reference/rcs-for-business-api#message-payload-examples" target="_blank">See some example RCS message payloads here.</a>

post/{connect_customer_key}/agentMessages/{msisdn}

Path parameters

connect_customer_keystring required

Your unique customer key.

msisdnstring required

Target device's phone number in E.164 format.

Query parameters

agentIdstring required

Alphanumeric string identifying your agent. To get your agentId, speak to your Vibes business rep.

messageIdstring

An alphanumeric 36-character UUID identifying the message. You can set this to whatever UUID you like, but if it is left blank, it will be filled in by the system.

Request body

namestring

Do not set this field. It will be populated by the API when the operation returns.

sendTimestring

Do not set this field. It will be populated by the API when the operation returns.

messageTrafficType'MESSAGE_TRAFFIC_TYPE_UNSPECIFIED' | 'AUTHENTICATION' | 'TRANSACTION' | 'PROMOTION' | 'SERVICEREQUEST' | 'ACKNOWLEDGEMENT'
totalPayloadSizeBytesstring int64

Output only. The total payload size of the message in bytes.

carrierstring

Output only. The carrier information that the user's phone number belongs to, according to Google RCS backends.

expireTimestring

Optional. Timestamp in UTC when this message will be considered expired.

ttlstring

Optional. Time in seconds the message will live before it is automatically revoked.

Response

The message has been queued for delivery. A webhook will be sent to the agent when the message is delivered to the mobile device.

namestring

Do not set this field. It will be populated by the API when the operation returns.

sendTimestring

Do not set this field. It will be populated by the API when the operation returns.

messageTrafficType'MESSAGE_TRAFFIC_TYPE_UNSPECIFIED' | 'AUTHENTICATION' | 'TRANSACTION' | 'PROMOTION' | 'SERVICEREQUEST' | 'ACKNOWLEDGEMENT'
totalPayloadSizeBytesstring int64

Output only. The total payload size of the message in bytes.

carrierstring

Output only. The carrier information that the user's phone number belongs to, according to Google RCS backends.

expireTimestring

Optional. Timestamp in UTC when this message will be considered expired.

ttlstring

Optional. Time in seconds the message will live before it is automatically revoked.