Send an RCS event

post

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

Sends an event from a Vibes customer RBM agent to a user.

Agent events include read receipts or "typing" notifications. If Vibes RBM can't reach the user, the Vibes RBM platform returns 404 NOT_FOUND. Unlike agent messages, agent events cannot be revoked after sending.

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.

eventId

string

An alphanumeric string identifying the event. You can set this to whatever you like, but if it is left blank, it will be filled in by the system.

Body Params

name

string

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

eventType

string

enum

required

Allowed:

messageId

string

If you are sending a read receipt event, the alphanumeric identifier of the message the read receipt is associated with.

sendTime

string

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

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 request has succeeded.