Inbound TEXT message from end user

wbhk

inboundTextMessage

Sent when the end user replies to your agent with a plain text message. eventType is MESSAGE and messageContent.messageType is TEXT.

Text messages are also evaluated for opt-out / opt-in / help keywords. When the message matches an opt-out keyword (e.g. STOP, UNSUBSCRIBE, CANCEL, PARAR, ...), isOptOut is true.

Payload

The envelope for all inbound message and notification callbacks.

When eventType is MESSAGE, messageContent is populated and notificationType is null.
When eventType is NOTIFICATION, notificationType is populated and messageContent is null.

agentId

string

required

The RCS agent id the event is associated with.

agentDisplayName

string

required

The display name of the RCS agent.

contactNumber

string

required

The end user's phone number in E.164 format. This is the raw, unhashed number.

eventType

string

enum

required

Discriminates whether the callback payload is an inbound message or a notification.

Allowed:

messageContent

InboundMessageContent | null

The inbound message content. Present only for MESSAGE events; null for NOTIFICATION events.

notificationType

EndUserNotificationType | null

The notification kind. Present only for NOTIFICATION events; null for MESSAGE events.

outboundId

string | null

Correlates the event back to the originating outbound message (extracted from the outbound message metadata). null when not applicable, such as unsolicited inbound messages.

isOptOut

boolean

required

Defaults to false

true when an inbound TEXT message matched an opt-out keyword (e.g. STOP, UNSUBSCRIBE, CANCEL). Always false for notifications and non-opt-out messages.

correlateId

string | null

The correlateId value supplied on the originating send request, if any. null when not provided.

conversationMetadata

ConversationMetadata | null

Metadata echoed from the conversation when present. Omitted from the payload entirely when there is none.

Responses

200

Callback acknowledged.

4XX

Permanent failure. Enrich will not retry.

5XX

Transient failure. Enrich retries up to 4 times, 5s apart.

Loading…