Send an RCS message

post

https://rbm.us.vibes.com/connectCustomers/{connect_customer_key}/agentMessages/{msisdn}

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.

See some example RCS message payloads here.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

connect_customer_key

string

required

Your unique customer key.

msisdn

string

required

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

Query Params

agentId

string

required

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

messageId

string

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.

Body Params

contentMessage

object

required

The content of the agent message.

messageTrafficType

string

enum

Defaults to MESSAGE_TRAFFIC_TYPE_UNSPECIFIED

Optional. The message traffic type.

Allowed:

expireTime

string

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

ttl

string

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

Responses

403

Forbidden agent. The agentId is either not valid, or it has not deployed on the provider.

422

Unprocessable entity. Specific data errors have occurred in the request. Additional details will be available in the content of the error.

Example - Invalid Phone Number. The phone number is not a valid mobile number, or is on a unsupported carrier.

429

Quota exceeded. You've either exceeded the number of calls allowed, or a downstream server is busy. Please try your request again later.

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