User message

wbhk

userMessage

The end user has sent a message, file, location, or response to your RCS agent.

Payload

An HTTP POST body that contains event data serialized in JSON format.

An event delivering a message that the user sent to the agent.

agentId

string

The agent's unique identifier.

sendTime

string

Timestamp (RFC 3339) at which the webhook event was sent.

senderPhoneNumber

string

User device phone number in E.164 format.

messageId

string

Unique identifier of the message.

text

string

Text body of the message, when the user sent text.

userFile

object

A file attachment sent by the user.

location

object

A geographic location shared by the user, expressed as latitude/longitude.

suggestionResponse

object

The user's response to a suggested reply or action.

richMessageClassification

object

Billing classification for a user message.

googleCarrier

string

Carrier reported by Google for the sender.

Headers

X-Vibes-Eventclass

string

required

An HTTP header that indicates what type of event class the callback is. Options are ServerEvent, UserEvent, or UserMessage.

X-Vibes-Signature

string

required

An HTTP header that contains a BASE64 encoded HMAC SHA512 signature.

Response

200

Return 200 to acknowledge receipt of the webhook.