Engagement OTT Mobile-Originated Events
The Event Notification Service supports these event notification types and their corresponding payloads.
The events are supported only for WhatsApp Direct (Meta).
| Notification Event Category | Notification Event Type | Description |
|---|---|---|
| EngagementEvents | OttMobileOriginated | Indicates that the OTT message is mobile-originated. |
| Attribute | Type | Description |
|---|---|---|
| eventCategoryType | string | The taxonomy of the event |
| eid | string | Tenant Enterprise ID from which the event was produced |
| mid | string | Tenant Business Unit ID from which the event was produced |
| senderType | string | The type of sender. For example, WhatsApp, LINE and so on. Currently, the only supported value is WhatsApp. |
| messageType | string | The type of message. The supported message types are text and button. |
| channelId | string | The ID of the channel from which the message was sent by subscriber. For example, the business phone number. |
| messageId | string | WhatsApp generated message ID. |
| timestampUTC | number | UTC epoch time |
| mobileNumber | string | The subscriber's mobile number |
| contactId | string | The subscriber's contact ID |
| messageBody | Object | The body of the message. The maximum size of the message is 1024 characters. |
The payload includes metadata about the media type but not the media itself. For example, if the media is a document, the payload provides details such as the file name, MIME type, and other relevant attributes.
To download the media, use the Download rich media inbound messages API.
For information on supported media types, size limitations, and usage details, see Supported Media Types.