Метод GetCallList

Примените этот метод для получения информации о списке контактов. Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/campaign/v1/GetCallList

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Имя	Тип	Описание
Authorization	string	API-ключ приложения с `Bearer` перед ним. Пример: `Bearer e*s0`, где `e*s0` замените на API-ключ вашего приложения

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Параметр	Тип	Описание
campaign_id	uint64	идентификатор рассылки
call_list_id	uint64	идентификатор списка получателей
limit	uint32	лимит выводимых данных (3000 по умолчанию)
offset	uint32	номер строки, с которой начинается выборка (начинается с 0)

Выходные параметры

Параметр	Тип	Описание
campaign_id	uint64	идентификатор рассылки
campaign_id	string	наименование рассылки
call_list_id	uint64	идентификатор списка получателей
call_list_total	uint64	количество записей в списке получателей
file_name	string	имя файла со списком контактов
file_upload_at	string	дата загрузки файла в формате RFC-3339 / ISO-8601
call_list_items	CallListItem	информация о получателях

CallListItem

Параметр	Тип	Описание
to	string	номер получателя
timezone	uint32	часовой пояс получателя
status	enum CallListStatus	статус списка контактов
created_at	string	дата создания списка контактов
updated_at	string	дата обновления списка контактов

CallListStatus

Параметр	Тип	Описание
1	enum	черновик
2	enum	в процессе выполнения
3	enum	остановлена пользователем
4	enum	в очереди
5	enum	начата
6	enum	закончена
7	enum	неуспешна
8	enum	недостаточно средств для выполнения коммуникации
9	enum	ошибка отправки на сервисе
10	enum	отменена пользователем

Возможные ошибки

Код	Статус	Пример сообщения	Описание
404	Not Found	Not Found	некорректный URL-адрес запроса
401	Unauthorized	invalid token	невалидный API-ключ
400	Bad Request	token is empty	в запросе не передан API-ключ
400	Bad Request	couldn’t parse incoming jwt token: couldn’t parse token: invalid character ‘[character]’ looking for beginning of value	невалидный API-ключ
404	Not Found	couldn’t get campaign by id = [campaign_id], app = ‘[app_id]’ : campaign not found	рассылка по заданным параметрам не найдена
400	Bad Request	invalid GetCallListRequest.CampaignId: value must be greater than 0	поле `campaign_id` и его значение отсутствуют в запросе
400	Bad Request	invalid GetCallListRequest.CallListId: value must be greater than 0	поле `call_list_id` и его значение отсутствуют в запросе
400	Bad Request	invalid character ‘[character]’ looking for beginning of value	невалидное или пустое значение в одном из полей
400	Bad Request	invalid value for uint64 type: ‘[value]’	невалидное или пустое значение в одном из полей с типом `uint64`
400	Bad Request	invalid character " after object key:value pair	в запросе пропущена запятая в одном из параметров

Примеры

Входные параметры:

{
    "campaign_id": 128484451264724992,
    "call_list_id": 130334219041517568,
    "limit":10
}

Выходные параметры:

{
    "campaign_id": "130334219200901120",
    "campaign_name": "test",
    "call_list_id": "130334219041517568",
    "call_list_total": "2",
    "file_name": "contacts.csv",
    "file_upload_at": "2023-12-28T11:25:38.428Z",
    "call_list_items": [
        {
            "to": "79991112233",
            "timezone": 2,
            "status": "1",
            "created_at": "2023-12-28T11:25:49.428275Z",
            "updated_at": "1970-01-01T00:00:00Z"
        },
        {
            "to": "79994445566",
            "timezone": 5,
            "status": "1",
            "created_at": "2023-12-28T11:25:49.428337Z",
            "updated_at": "1970-01-01T00:00:00Z"
        }
    ],
    "limit": 10
}