GetCallListDetails

POST

https://api.voximplant.com/platform_api/GetCallListDetails

POST

/platform_api/GetCallListDetails

curl -X POST "https://api.voximplant.com/platform_api/GetCallListDetails?list_id=452&count=50&offset=0&output=csv&encoding=UTF-8&delimiter=%3B&batch_id=a3f1c9e2-7b4d-4f8a-9c2e-1d2f3b4a5c6d" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

200Example 1

{
  "result": [
    {
      "list_id": 452,
      "custom_data": "{\"first_name\":\"John\",\"phone\":\"+14155552671\",\"age\":\"34\",\"last_name\":\"Doe\"}",
      "start_execution_time": "2024-06-01 09:00:00",
      "finish_execution_time": "2024-06-01 17:00:00",
      "result_data": "Call completed successfully",
      "last_attempt": "2024-06-01 10:15:23",
      "attempts_left": 1,
      "status_id": 2,
      "status": "Processed",
      "task_id": 98765,
      "task_uuid": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f70"
    }
  ],
  "count": 1
}

Gets details of the specified call list. Returns a CSV file by default.

Allowed roles: Owner, Admin, Developer, Call list manager, sys.Admin read only.

Example request: Get all lists registered by user.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

list_idintegerRequired

The list ID

countintegerOptional

Maximum number of entries in the result

offsetintegerOptional

The first N records are skipped in the output

outputstringOptionalDefaults to csv

The output format. The following values available: json, csv, xls. The default value is csv

encodingstringOptional

Encoding of the output file. Default UTF-8

delimiterstringOptional

Separator values. The default value is ';'

batch_idstringOptional

Batch UUID to filter the tasks

Response

Successful response

resultlist of objectsOptional

Array of tasks for the roll call

countintegerOptional

The number of tasks