Export Communications Report
To use the communication export API, perform a GET REQUEST
on the following endpoint:
GET/api/v1/reports/communications
Headers in Communications Report API includes the following keys:
Key | Default | Options | Description |
| json | json, csv | String |
| null | (dynamic) | Array of campaign ids |
| null | (dynamic) | Array of incoming ids |
| null | (dynamic) | Array of user ids |
| null | (dynamic) | Array of tag ids |
| null | (dynamic) | Array of call disposition ids |
| all | all | Direction of communication either inbound or outbound |
| all | all | Answer status of a call type communication |
| FALSE | true, false | |
| null | (dynamic) | Filter report for a specific contact |
| null | (dynamic) | FIlter report for a specific campaign |
| null | (dynamic) | Filter report for a specific ring group |
| null | (dynamic) | Filter report for a specific workflow/ sequence |
| null | (dynamic) | Filter report for a specific user |
| null | (dynamic) | Filter report for a specific broadcast |
| 1 | 1 (call) | Filter report for a specific type of communication |
| FALSE | true, false | |
| 0 | (dynamic) | Filter report for call communication with a minimum talk time requirement |
| FALSE | true, false | Filter report communications with no tags |
| FALSE | true, false | Filter report excluding communications that are generated from automation (workflow/ sequence) |
| FALSE | true, false | Filter report with unread communications only. |
| UTC | (World time zones) | Filter report with a specific timezone reference. |
| (current date-time minus 30 days) | (dynamic) | Filter report `from date`. |
| (Current date-time) | (dynamic) | Filter report `to date`. |
| null | 1 (cold), | Filter report communications with specific transfer types. (effective only for call type communications) |
| null | 1 (initiated), | |
| FALSE | true, false | Filter report with only communication that are generated from contacts owned by the authenticated user |
| null | (dynamic) | Filter report communications generated from contacts that are owned by the users specified (array of user ids) |
Example request:
{
"export_type": "json",
"campaigns": [3,6,9],
"incoming_numbers": [2,4,6],
"users": [12,15,18],
"tags": [8,10,12,14],
"call_dispositions": [21,24,27,30],
"direction": 2,
"answer_status": "hold",
"first_time_only": true,
"contact_id": 4935,
"campaign_id": 13,
"ring_group_id": 2,
"workflow_id": 5,
"user_id": 54,
"broadcast_id": 3,
"type": "all",
"exclude_contacts_visibility": true,
"min_talk_time": 3600,
"untagged_only": true,
"exclude_automated_communications": true,
"unread_only": true,
"timezone": "Asia/Manila",
"from_date": "2022-01-15 18:30:55",
"to_date": "2022-02-15 23:30:00",
"transfer_type": 3,
"callback_status": 2,
"my_contact": true,
"contact_owner": [3,6]
}