Get Contact Conversations
Get conversations associated to that contact.
Settings:
URL | https://online.99digital.co.il/api/v1/accounts/{account_id}/contacts/{contact_id}/conversations |
Method | JSON via GET |
Authorization:
Header Parameter | Description |
api_access_token | user API key |
The user API key provides access to endpoints based on the user permissions levels and can be obtained by visiting the profile page.
Path Parameters:
Parameter | Description | Required |
account_id | The numeric id of the account | yes |
contact_id | The numeric id of the contact | yes |
Response:
{
"payload": [
{
"meta": {},
"id": 0,
"messages": [],
"account_id": 0,
"additional_attributes": {},
"agent_last_seen_at": 0,
"assignee_last_seen_at": 0,
"can_reply": false,
"contact_last_seen_at": 0,
"custom_attributes": {},
"inbox_id": 0,
"labels": ["string"],
"muted": false,
"snoozed_until": 0,
"status": "resolved",
"created_at": 0,
"timestamp": 0,
"first_reply_created_at": 0,
"unread_count": 0,
"last_non_activity_message": {}
}
]
}
Response-Explain:
Parameter | Description |
payload | Array of objects (conversation) |
payload -> meta | Metadata about the conversation |
payload -> id | Contact numeric id |
payload -> account_id | Account numeric id |
payload -> inbox_id | Inbox numeric id |
payload -> status | The status of the conversation Enum: |
payload -> created_at | Time at which the conversation was created. Measured in seconds since the Unix epoch |
payload -> unread_count | The number of unread messages |
payload -> messages | Array of objects (message) |
payload -> agent_last_seen_at | The last time at which the agent was available. Measured in seconds since the Unix epoch |
payload -> assignee_last_seen_at | The last time at which the assignee (user) was available. Measured in seconds since the Unix epoch |
payload -> labels | Array of strings (label) |
payload -> additional_attributes | The object containing additional attributes related to the conversation |
payload -> custom_attributes | The object containing custom attributes for conversation (custom attributes key and value) |
payload -> first_reply_created_at | The time at which the first reply was sent. Measured in seconds since the Unix epoch |
payload -> last_non_activity_message | Object containing last non-activity message (incoming, outgoing, template) |
payload -> can_reply | Whether the conversation is currently within messaging window |
payload -> contact_last_seen_at | The last time a contact interacted with your service. Measured in seconds since the Unix epoch |
payload -> snoozed_until | The time at which previously snoozed conversation is reactivated. Measured in seconds since the Unix epoch |