GetInfo

Метод GetInfo

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

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

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

Авторизация

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

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

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

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

Параметр Тип Описание
id uint64 идентификатор рассылки

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

Параметр Тип Описание
campaign_info CampaignInfo информация о рассылки
schedule Schedule расписание рассылки по дням недели

CampaignInfo

Параметр Тип Описание
id uint64 идентификатор рассылки
name string наименование рассылки
scenario_id string идентификатор сценария
call_list CallListInfo информация о списке получателей

CallListInfo

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

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 рассылка завершена

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 в любом случае

ContactFileInfo

Параметр Тип Описание
name string имя файла
total uint64 количество контактов в файле
created_at string дата создания файла в формате RFC-3339 / ISO-8601

Schedule

Параметр Тип Описание
days CallIntervalDays настройка интервалов рассылки по дням недели

CallIntervalDays

Параметр Тип Описание
mon CallInterval интервал понедельника
tue CallInterval интервал вторника
wed CallInterval интервал среды
thu CallInterval интервал четверга
fri CallInterval интервал пятницы
sat CallInterval интервал субботы
sun CallInterval интервал воскресенья

CallInterval

Параметр Тип Описание
from From/To время начала рассылки
to From/To время завершения рассылки

From/To

Параметр Тип Описание
hours uint32 час интервала
minutes uint32 минута интервала
seconds uint32 секунда интервала
nanos uint32 наносекунда интервала

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

Код Статус Пример сообщения Описание
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 info from campaign by id = [id]: campaign not found в приложении не найдена рассылка с указанным ID
400 Bad Request invalid GetInfoRequest.Id: value must be greater than 0 поле ID и его значение отсутствуют в запросе
400 Bad Request invalid character ‘[character]’ looking for beginning of value невалидное значение в поле id
400 Bad Request invalid value for uint64 type: ‘[value]’ невалидное или пустое значение в поле id с типом uint64

Примеры

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

{
    "id": 129931120807677952
}

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

{
    "campaign_info": {
        "id": "129931120807677952",
        "name": "Каскадна рассылка",
        "scenario_id": "4cdf14bb-a23f-470b-a0a5-0e201cd5ca52",
        "call_list": {
            "id": "129931120799289344",
            "file_infos": [
                {
                    "name": "receivers.csv",
                    "total": "2",
                    "created_at": "2023-12-25T13:00:16.849Z"
                }
            ],
            "total": "2"
        },
        "type": "CAMPAIGN_TYPE_CASCADE",
        "status": "CAMPAIGN_STATUS_IS_RUN",
        "created_at": "2023-12-25T12:59:53.204100Z",
        "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"
                        }
                    }
                }
            ]
        }
    },
    "schedule": {
        "days": {
            "mon": {
                "intervals": [
                    {
                        "from": {
                            "hours": 9
                        },
                        "to": {
                            "hours": 18
                        }
                    }
                ]
            },
            "tue": {
                "intervals": [
                    {
                        "from": {
                            "hours": 9
                        },
                        "to": {
                            "hours": 18
                        }
                    }
                ]
            },
            "wed": {
                "intervals": [
                    {
                        "from": {
                            "hours": 9
                        },
                        "to": {
                            "hours": 18
                        }
                    }
                ]
            },
            "thu": {
                "intervals": [
                    {
                        "from": {
                            "hours": 9
                        },
                        "to": {
                            "hours": 18
                        }
                    }
                ]
            },
            "fri": {
                "intervals": [
                    {
                        "from": {
                            "hours": 9
                        },
                        "to": {
                            "hours": 18
                        }
                    }
                ]
            },
            "sat": {},
            "sun": {}
        }
    }
}