Apple Business Chat Hub Driver Attributes
The following is a list of attributes that ABC Hub Driver adds to the interaction.
Simple Text Message
| Attribute | Type | Description |
|---|---|---|
| _umsMediaType | String | Always "applebc" |
| _umsMediaTypeChat | String | Always "applebcsession" value |
| _umsChannel | String | Channel name |
| _umsChatPossible | String | Always "true" value |
| _umsMsgId | String | Message indentifier (Apple's data) |
| _umsMsgType | String | Always "text" value |
| _umsFromAddr | String | Unique identifier of Apple's user or "SYSTEM" for notification messages |
| _umsToAddr | String | Unique identifier of dialog (pair AppleUserId + businessId) |
| _umsConversationId | String | Unique identifier of dialog (pair AppleUserId + businessId) |
| _umsDriverDataWithAttachment | String | "False" for messages without attachment. "True" for messages with attachment. |
| _umsMsgPlainText | String | Text of message |
| _msg_PlainText | String | Text of message |
| Subject | String | Subject of message |
| _msg_CreatedAt | String | Timestamp for when message was received |
| _msg_MsgId | String | Message indentifier (Apple's data) |
| _msg_MsgType | String | Always "text" value |
| _msg_FromUserId | String | Unique identifier of Apple's user |
| _msg_ToAddr | String | Unique identifier of dialog (pair AppleUserId + businessId) |
| _msg_ProfileServiceName | String | Always "ABC" value |
| _msg_ProfileUserId_ABC | String | Unique identifier of Apple's user |
Attachment Message
| Attribute | Type | Description |
|---|---|---|
| _umsMediaType | String | Always "applebc" |
| _umsMediaTypeChat | String | Always "applebcsession" value |
| _umsChannel | String | Channel name |
| _umsChatPossible | String | Always "true" value |
| _umsMsgId | String | Message indentifier. Apple's data |
| _umsMsgType | String | Always "text" value |
| _umsFromAddr | String | Unique identifier of Apple's user or "SYSTEM" for notification messages |
| _umsToAddr | String | Unique identifier of dialog (pair AppleUserId + businessId) |
| _umsConversationId | String | Unique identifier of dialog (pair AppleUserId + businessId) |
| _umsDriverDataWithAttachment | String | "False" for messages without attachment. "True" for messages with attachment |
| _umsMsgPlainText | String | Text of message |
| _msg_PlainText | String | Text of message |
| Subject | String | Subject of message |
| _msg_CreatedAt | String | Timestamp of message receive moment |
| _msg_MsgId | String | Message indentifier. Apple's data |
| _msg_MsgType | String | Always "text" value |
| _msg_FromUserId | String | Unique identifier of Apple's user |
| _msg_ToAddr | String | Unique identifier of dialog (pair AppleUserId + businessId) |
| _msg_ProfileServiceName | String | Always "ABC" value |
| _msg_ProfileUserId_ABC | String | Unique identifier of Apple's user |
| _umsDriverDataWithAttachment | String | Always "true" value |
| _umsDriverData | Binary | Information about attachment. Attachment Id, contentType, size |
Sample Business Processes for Apple Business ChatUsing the Apple Business Chat Plugin for Workspace Desktop Edition
This page was last edited on May 1, 2019, at 16:52.
Comments or questions about this documentation? Contact us for support!
