Bulk Data Export API
The API enables exporting the entire conversation data for the given filter criteria. By executing this API, the conversation data that is processed is fetched and exported to a shared location. Currently, any historical data within an hour period is allowed to be exported.
Track the status of the current job and proceed only if it has been completed or failed. To know more about the current status of the data export job, click here.
Endpoint
URL: https://<<hostname>>/export/uzng/v1/convdata/schedule
Method: POST
curl --location 'https://<<hostname>>/export/uzng/v1/convdata/schedule' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 'iGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkxYejBQYWVFRERuS3dfcjdkU2s2UyJ9.eyJodHRwczovL2FwaS51bmlwaG9yZS5jb20vcm9sZXMiOlsiYWRtaW4iLCJzdXBlcmFkbWluIiwiU3VwZXIgQWRtaW5pc3RyYXRvciJdLCJodHRwczovL2FwaS51bmlwaG9yZS5jb20vdGVuYW50IjoiMTViYjEwN2UtMGM1Yi00NGJlLTg0ZTEtNWYyNzYxMTE1ODNhIiwiaHR0cHM6Ly9hcGkudW5pcGhvcmUuY29tL29yZ19pZCI6Im9yZ19FQlVLRmVlWHFvbXdpYU8xIiwiaXNzIjoiaHR0cHM6Ly9kZXYtZzJqNW11MnoudXMuYXV0aDAuY29tLyIsInN1YiI6InRKYXZQUlcyYWlNcVBYdlluNXhVM3VuNGh4QjhVTlVSQGNsaWVudHMiLCJhdWQiOiJhcGkudW5pcGhvcmUuY29tIiwiaWF0IjoxNzQyODg0NjEwLCJleHAiOjE3NDI5NzEwMTAsInNjb3BlIjoicmVhZDp0ZW5hbnRzIHJlYWQ6dXNlcnMgd3JpdGU6dXNlcnMiLCJndHkiOiJjbGllbnQtY3JlZGVudGlhbHMiLCJhenAiOiJ0SmF2UFJXMmFpTXFQWHZZbjV4VTN1bjRoeEI4VU5VUiIsInBlcm1pc3Npb25zIjpbInJlYWQ6dGVuYW50cyIsInJlYWQ6dXNlcnMiLCJ3cml0ZTp1c2VycyJdfQ.LMqT5NxVM8OAKlCW_4bGJFYzq4_CIfmuwDHgraMUSU4vFrS4rx8xz7JiRxfh15CZ7ekSDzkJdSFgFIN4Q4sEG5l2NhtI7GErzcPruhMxBOEH0ykXXy6qlkgYezniDS49qlFjBkrzSr7LCK9NQyWF7w1HJiVgQBhOOJsh5sncNIqjCeJintGk1G5H9AMQV_oNWstTsvk5hJtznc7Rq5t5N_VKJhUtcysL13LIO-8oyGE2Zkhb53IrQYLh6rapBOlNBHd7G6G6M4dA7apSC9HWocyH74EVQqYtYgsvBgyJnmUMDcPmQzIbAco' \
--data '{
"startDate": "2025-01-01 00:00:00",
"endDate": "2025-01-01 01:00:00",
"direction": "",
"organizationNodeId": ""
}'Header Parameter
Authorization - Bearer <Token>
Note
To obtain an authorization token, click here.
Request Parameter
Parameter Name | Datatype | Description | Required/ Optional |
|---|---|---|---|
startDate | Date | Fetch data from this date. Format: yyyy-MM-dd HH:mm:ss The difference between startDate and endDate should be less than or equal to one hour. | Required |
endDate | Date | Fetch data until this date. Format: yyyy-MM-dd HH:mm:ss The difference between startDate and endDate should be less than or equal to one hour. | Required |
direction | String | The call direction can be either Inbound or Outbound. | Optional |
organizationNodeId | String | Fetch data for the given Organization name. | Optional |
Sample Request
{
"startDate": "2025-01-01 00:00:00",
"endDate": "2025-03-18 00:00:00",
"direction": "",
"organizationNodeId": ""
}Sample Response
{ "code": 201,
"message": "export is scheduled successfully",
"data": {
"jobId": "73c5950e-a8b1-a3d2-1bca49d946c6"
}
}Response and Error Codes
Response Code | Condition | Message | Description |
|---|---|---|---|
201 | Created | Export is scheduled successfully | The data has been exported, and a job ID is created. |
400 | Bad Request | StartDate and EndDate are mandatory fields | Ensure Start Date and End Date are provided. |
500 | Internal Server Error | Error occurred while scheduling the export job | Retry after some time. |