Sign in
latestOpenAPI 3.1.1Proprietary – Contact us for usage terms2026-08-20173183551.4 KB

9da73dd2f99e

campaigns

List contacts in a campaign's call queue

Retrieves the paginated list of phone numbers (contacts) in a campaign's call queue. Each entry includes the phone number, associated metadata (json_csv_infos: firstname, lastname, company, custom fields), call status (pending, called, answered, failed), retry count, and call timestamps. Results are paginated using limit_count and limit_offset.

Permission: No specific permission required. A valid API key is sufficient.

get/campaigns/call/{campaignscalllistuuid}/numbers

Path parameters

campaignscalllistuuidstring uuid required

The UUID of the campaign (e.g., 1a7a5639-3818-4b0e-9285-f6b3795f8db4). Use GET /campaigns/call to discover campaign UUIDs.

Query parameters

limit_countinteger

Maximum number of results to return per page. Default: server-defined.

limit_offsetinteger

Number of results to skip for pagination. Default: 0.

Response

Successful operation

campaign_calllist_uuidstring uuid

Unique identifier for the object

team_idinteger

Team identifier

user_idinteger

User identifier

namestring

The name of the campaign CALL List

campaign_tagsinteger[]

tags of the campaign

users_listinteger[]

The list of users

groups_listinteger[]

The list of groups

fifo_left_to_callinteger

The number of numbers left to call

update_datestring date-time
creation_datestring date-time
deletion_datestring date-time
max_retryinteger

The max retry attempts for numbers in the campaign CALL List

retry_timeinteger

Optional time in seconds to wait before retrying a number

ivr_idinteger

Optional id of the ivr

start_datestring date-time

Optional start date of the campaign

campaign_count_numbersinteger
campaign_count_active_numbersinteger
campaign_count_usersinteger
campaign_count_groupsinteger
is_privateboolean

true if the campaign call is private

is_runningboolean

true if the campaign call is currently running

stop_reasonstring

the reason why the campaign call has been stopped

limit_offset_settedinteger
limit_count_settedinteger
total_numbers_list_countinteger
numbers_list_leninteger

Example response

{
  "campaign_calllist_uuid": "b55f949b-c49b-4354-b10a-c8c4cdbd8690",
  "team_id": 123123,
  "user_id": 234234,
  "name": "My campaign CALL List",
  "fifo_left_to_call": 8,
  "update_date": "2018-08-12T12:12:40.53Z",
  "creation_date": "2018-08-12T12:12:40.53Z",
  "deletion_date": "2018-08-12T12:12:40.53Z",
  "max_retry": 3,
  "retry_time": 200,
  "ivr_id": 200,
  "start_date": "2018-08-12T12:12:40.53Z",
  "campaign_count_numbers": 50,
  "campaign_count_active_numbers": 10,
  "campaign_count_users": 5,
  "campaign_count_groups": 7,
  "stop_reason": "no more numbers to call",
  "script": {
    "script_uuid": "1a7a5639-3818-4b0e-9285-f6b3795f8db4",
    "generic_uuid": "1a7a5639-3818-4b0e-9285-f6b3795f8db4",
    "name": "My script",
    "is_enabled": true
  },
  "limit_count_setted": 1,
  "total_numbers_list_count": 8,
  "numbers_list": [
    {
      "number_id": 123123,
      "campaign_calllist_uuid": "b55f949b-c49b-4354-b10a-c8c4cdbd8690",
      "to_number_format": {
        "raw": 184800000,
        "country_code": "33",
        "country": "FR",
        "e164": "+33184800000",
        "international": "+33 1 84 80 00 00",
        "international_alt": "33184800000",
        "national": "01 84 80 00 00",
        "national_alt": "0184800000",
        "rfc3966": "tel:+33-1-84-80-00-00"
      },
      "max_retry": 3,
      "done_date": "2018-08-14T11:13:41.53Z",
      "creation_date": "2018-08-12T12:12:40.53Z",
      "scheduled_callback_date": "2018-08-12T12:12:40.53Z",
      "call_by_user_id": 123123,
      "call_id": 123123,
      "json_csv_infos": "{\"company\": \"Ringover\", \"firstname\": \"John\", \"lastname\": \"Doe\", \"social_data\": [{\"country\": \"FR\"}, {\"city\": \"Paris\"}]}"
    }
  ],
  "numbers_list_len": 1
}