Conversation Counts
Get new, unassigned and all Conversation counts.
Settings:
URL | https://online.99digital.co.il/api/v1/accounts/{account_id}/conversations/meta |
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 |
Query Parameters:
Parameter | type | Description | Required |
status | string | Filters conversations by status Enum: | no |
q | string | Filters conversations with messages containing the search term | no |
inbox_id | integer | Filters conversations belonging to an inbox by inbox_id | no |
team_id | integer | Filters conversations assigned to a team by team_id | no |
labels | array of strings | Filters conversations by labels | no |
Response:
{
"meta": {
"mine_count": 0,
"new_count": 0,
"assigned_count": 0,
"unassigned_count": 0,
"all_count": 0
}
}
Response-Explain:
Parameter | Description |
meta | An object containing the counts |
meta -> mine_count | Number of conversations that have been assigned to the user |
meta -> new_count | Number of new conversations |
meta -> assigned_count | Number of conversations that have been assigned |
meta -> unassigned_count | Number of unassigned conversations |
meta -> all_count | Number of all conversations |