The Context object is equivalent to the task object documented in the POST /notify and GET /actions endpoints of our REST API. It is also described below for convenience.
Some fields, which are not documented below, might appear in actual objects. These fields are undocumented on purpose. Their use is unsupported and strongly discouraged.
| | |
|---|
| name | type | description |
| id | integer | A unique id associated with the current task (the message currently being processed by an Agent) |
| tags | list<Tag> | The list of tags associated with the current task. |
| url | string | An internal url that starts with https://alcmeon.com where this task can be viewed within Alcméon after authentication. |
| conversation_id | integer | A unique id associated with the conversation in which the current task is embedded. |
| state | string | one of: pending, assigned, answered, archived, archived-auto, help-requested, help-answered, on-hold. |
| message | Message | The content of the message being currently processed. |
| | |
|---|
| name | type | description |
| id | integer | A unique id associated with this tag. |
| name | TagLabel | The name of this tag. |
| value | TagValue | The value of this tag. |
| | |
|---|
| name | type | description |
| value | string | The human-readable label displayed on screen |
| | |
|---|
| name | type | description |
| id | integer | A unique id associated with this tag value. |
| value | TagLabel | The human-readable label associated with this tag value. |
| | |
|---|
| name | type | description |
| id | integer | A unique id associated with this message |
| is_private | boolean | Did the author of this message send us this message privately ? |
| content | string | For every channel, except Twitter, the textual content of this message. On Twitter, this content is empty. |
| external_id | string | A channel-specific globally unique id. |
| date | string | UTC+0, when the message was authored. |
| time | string | UTC+0, when the message was authored. |
| attachments | list<Attachment> | The list of attachments associated with this message |
| author | Author | The author of this message |
| | |
|---|
| name | type | description |
| id | integer | A unique id associated with the author. |
| name | string | The name of the author of a message. For example, on Facebook, this field contains the firstname+lastname. On Twitter, this field is empty. |
| | |
|---|
| name | type | description |
| id | integer | A unique internal id associated with this attachment |
| mime_type | string | The mime type of the attachment payload |
| data | string | The attachment payload, encoded as base64 |
| size | integer | The number of bytes of the decoded attachment payload |
