Метод 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 информация о списке получателей event_timestamp EventTimestamp информация о дате и времени отправки, приостановки и завершения рассылки в UTC
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 Параметр Тип Описание 1 enum текстовые SMS 2 enum голосовые SMS 3 enum каскадная рассылка
CampaignStatus Параметр Тип Описание 1 enum черновик 2 enum рассылка остановлена пользователем 3 enum рассылка остановлена из-за нехватки баланса 4 enum рассылка в процессе выполнения 5 enum рассылка завершена
Channel Параметр Тип Описание sms Sms канал рассылки — текстовое SMS voice_message VoiceMessage канал рассылки — голосовое SMS cascade Cascade каскадная рассылка (последовательное уведомление абонентов в разных каналах)
Sms Параметр Тип Описание props SmsProps атрибуты сценария текстового SMS
SmsProps Параметр Тип Описание alpha_name string имя отправителя (альфа-имя), от которого отправляются текстовые SMS text string текст сообщения
VoiceMessage 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 Condition Параметр Тип Описание 1 enum звонок не принят/SMS не доставлено 2 enum звонок принят/SMS доставлено 3 enum в любом случае
ContactFileInfo Параметр Тип Описание name string имя файла total uint64 количество контактов в файле created_at string дата создания файла в формате RFC-3339 / ISO-8601
EventTimestamp Параметр Тип Описание start_at google.protobuf.Timestamp дата и время старта рассылки в UTC stop_at google.protobuf.Timestamp дата и время приостановки рассылки в UTC finish_at google.protobuf.Timestamp дата и время завершения рассылки в UTC
Schedule Параметр Тип Описание start_at CallIntervalDays настройка интервалов рассылки по дням недели
CallIntervalDays 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": "test12356",
"scenario_id": "5d8eb1f8-0bfa-49a8-9109-e383a5653c42",
"call_list": {
"id": "128511757563326464",
"file_infos": [
{
"name": "contacts.csv",
"total": "2",
"created_at": "2024-12-21T15:04:37.112Z"
}
],
"total": "2"
},
"type": 3,
"status": 1,
"created_at": "2024-12-21T14:59:50.637856Z",
"cascade_info": {
"elements": [
{
"voice_message": {
"voice_message_id": "366dbec4-c2ab-4a1c-993f-d1d221faec44",
"from": "79813340026"
},
"condition": "1",
"step": "1"
},
{
"sms": {
"alpha_name": "test_name",
"text": "Test",
"ttl": {
"seconds": "10",
"nanos": 0
}
},
"condition": "",
"step": "2"
}
]
},
"event_timestamp": {
"start_at": "2024-12-05T14:02:48.068046975Z",
"finish_at": "2024-12-05T14:03:20.425123760Z"
}
},
"schedule": {
"days": {
"mon": {
"intervals": [
{
"from": {
"hours": 12,
"minutes": 0,
"seconds": 0,
"nanos": 0
},
"to": {
"hours": 23,
"minutes": 30,
"seconds": 0,
"nanos": 0
}
}
]
},
}
}
}