GetList

Метод GetList

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

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

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

Авторизация

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

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

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

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

Параметр Тип Описание
campaign_type enum CampaignType тип рассылки (канал рассылки)
campaign_id uint64 идентификатор рассылки
name string наименование рассылки
status enum CampaignStatus статус рассылки
date_from string дата создания рассылки в формате RFC-3339 / ISO-8601, от которой начинать выборку
date_to string дата создания рассылки в формате RFC-3339 / ISO-8601, до которой продолжать выборку

CampaignType

Параметр Тип Описание
CAMPAIGN_TYPE_SMS enum текстовые SMS
CAMPAIGN_TYPE_VOICE enum голосовые SMS
CAMPAIGN_TYPE_CASCADE enum каскадная рассылка

CampaignStatus

Параметр Тип Описание
CAMPAIGN_STATUS_DRAFT enum черновик
CAMPAIGN_STATUS_IS_STOP enum компания остановлена пользователем
CAMPAIGN_STATUS_IS_STOP_BALANCE enum компания остановлена из-за нехватки баланса
CAMPAIGN_STATUS_IS_RUN enum рассылка в процессе выполнения
CAMPAIGN_STATUS_IS_FINISHED enum рассылка завершена

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

Параметр Тип Описание
items CampaignItem список найденных рассылок

CampaignItem

Параметр Тип Описание
id uint64 идентификатор рассылки
name string наименование рассылки
scenario_id string идентификатор сценария
call_list_id uint64 идентификатор списка получателей
call_list_total uint64 количество записей в списке получателей
timezone boolean параметр учёта часового пояса. По умолчанию False - рассылка отправляется по московскому времени (UTC+3), True - учитывать часовой пояс, указанный в CallList
type enum CampaignType тип рассылки (канал рассылки)
status enum CampaignStatus статус рассылки
created_at дата создания рассылки в формате RFC-3339 / ISO-8601
oneof Channel один из каналов рассылки (текстовое SMS, голосовое SMS или каскадная рассылка)

Channel

Параметр Тип Описание
sms Sms канал рассылки - текстовое SMS
voice_message VoiceMessage канал рассылки - голосовое SMS
cascade Cascade каскадная рассылка (использование нескольких каналов для уведомления абонентов поочередно: текстовое или голосовое SMS)

Sms

Параметр Тип Описание
props SmsProps атрибуты сценария текстового SMS

SmsProps

Параметр Тип Описание
alpha_name string имя отправителя (альфа-имя), с которого отправляются текстовые SMS
text string текст сообщения

VoiceMessage

Параметр Тип Описание
props VoiceMessageProps атрибуты сценария голосового SMS

VoiceMessageProps

Параметр Тип Описание
voice_message_id string идентификатор ресурса голосового SMS
from string номер телефона Exolve, с которого отправляются голосовые SMS

Cascade

Параметр Тип Описание
elements CascadeElement структура каскадной рассылки. Один элемент - один канал рассылки (текстовое или голосовое SMS)

CascadeElement

Параметр Тип Описание
sms Sms канал рассылки - текстовое SMS
voice_message VoiceMessageChannel канал рассылки - голосовое SMS
condition enum Condition условие перехода к следующему каналу рассылки

SmsChannel

Параметр Тип Описание
props SmsProps атрибуты сценария текстового SMS
ttl string период времени, по истечении которого будет запрошен статус SMS (от 10 до 300 секунд)

VoiceMessageChannel

Параметр Тип Описание
props VoiceMessageProps атрибуты сценария голосового SMS

Condition

Параметр Тип Описание
1 enum звонок не принят/смс не доставлено
2 enum звонок принят/смс доставлено
3 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-ключ
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 в запросе пропущена запятая в одном из параметров

Примеры

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

{
    "date_from" : "2023-12-01T12:40:23.832213Z",
    "date_to" : "2023-12-28T15:40:23.832213Z"
}

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

{
    "items": [
        // Текстовая SMS рассылка
        {
            "id": "130366147371216896",
            "name": "SMS Campaign",
            "scenario_id": "e1b9ae25-f36c-44b8-a327-ac46d414e180",
            "call_list_id": "130366147266359296",
            "timezone": true,
            "type": "CAMPAIGN_TYPE_SMS",
            "status": "CAMPAIGN_STATUS_DRAFT",
            "created_at": "2023-12-26T17:48:31.619796Z",
            "sms": {
                "props": {
                    "alpha_name": "SHOP",
                    "text": "Приходите к нам!"
                }
            }
        },
        // Голосовая SMS рассылка
        {
            "id": "130334219200901120",
            "name": "Voice Message Campaign",
            "scenario_id": "bb33e01b-9ec3-4d44-955c-c4cac2d23971",
            "call_list_id": "130334219041517568",
            "timezone": true,
            "type": "CAMPAIGN_TYPE_VOICE",
            "status": "CAMPAIGN_STATUS_IS_STOP",
            "created_at": "2023-12-26T15:41:39.350391Z",
            "voice_message": {
                "props": {
                    "voice_message_id": "41117356-c9d5-4c94-8c62-68d7d2dac285",
                    "from": "79991112233"
                }
            }
        },
        // Каскадная рассылка
        {
            "id": "130369523110653952",
            "name": "Cascade",
            "scenario_id": "a466b60e-ca5a-4da8-b60c-bc9cb9e6fd8a",
            "call_list_id": "130369523102265344",
            "type": "CAMPAIGN_TYPE_CASCADE",
            "status": "CAMPAIGN_STATUS_IS_RUN",
            "created_at": "2023-12-26T18:01:56.458047Z",
            "cascade": {
                "elements": [
                    {
                        "sms": {
                            "props": {
                                "alpha_name": "Shop",
                                "text": "Скидка 10% на все товары!"
                            },
                            "ttl": "10s"
                        },
                        "condition": "1"
                    },
                    {
                        "voice_message": {
                            "props": {
                                "voice_message_id": "353b86e0-a62c-47d4-9b94-8dba32c922fc",
                                "from": "79998889900"
                            }
                        }
                    }
                ]
            }
        }
    ]
}