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 include the following keys:

Key	Default	Options	Description
export_type	json	json, csv	String
campaigns	null	(dynamic)	Array of campaign ids
incoming_numbers	null	(dynamic)	Array of incoming ids
users	null	(dynamic)	Array of user ids
tags	null	(dynamic)	Array of tag ids
call_dispositions	null	(dynamic)	Array of call disposition ids
direction	all	all 1 (inbound) 2 (outbound)	Direction of communication, either inbound or outbound
answer status	all	all live hold queued deadend answered unanswered missed abandoned in-progress failed voicemail recorded	Answer the status of a call-type communication
first_time_only	FALSE	true, false
contact_id	null	(dynamic)	Filter report for a specific contact
campaign_id	null	(dynamic)	FIlter report for a specific campaign
ring_group_id	null	(dynamic)	Filter report for a specific ring group
workflow_id	null	(dynamic)	Filter report for a specific workflow/ sequence
user_id	null	(dynamic)	Filter report for a specific user
broadcast_id	null	(dynamic)	Filter report for a specific broadcast
type	1	1 (call) 2 (text) 4 (rvm), 5 (email), 8 (fax), 12 (appointment), 13 (reminder), all	Filter report for a specific type of communication
exclude_contacts_visibility	FALSE	true, false
min_talk_time	0	(dynamic)	Filter report for call communication with a minimum talk time requirement
untagged_only	FALSE	true, false	Filter report communications with no tags
exclude_automated_communications	FALSE	true, false	Filter report excluding communications that are generated from automation (workflow/ sequence)
unread_only	FALSE	true, false	Filter report with unread communications only.
timezone	UTC	(World time zones)	Filter report with a specific timezone reference.
from_date	(current date-time minus 30 days)	(dynamic)	Filter report `from date`. (Y-m-d H:i:s)
to_date	(Current date-time)	(dynamic)	Filter report `to date`. (Y-m-d H:i:s)
transfer_type	null	1 (cold), 2 (conferencing), 3 (warm)	Filter report communications with specific transfer types. (effective only for call-type communications)
callback_status	null	1 (initiated), 2 (requested)
my_contact	FALSE	true, false	Filter report with only communication that is generated from contacts owned by the authenticated user
contact_owner	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]
}

📝Note: Please contact support or your CSM for further information. More private APIs with restrictions may be offered upon request for select enterprise accounts.

Communication Report API

Export Communications Report