Метод GetAlphaNames Примените этот метод для получения списка созданных имен отправителя (альфа-имен). Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.
Точка подключения :
POST: https://api.exolve.ru/messaging/v1/GetAlphaNames
Авторизация Передайте следующие Заголовки HTTP для успешной авторизации.
Имя Тип Описание Authorization string API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения
Входные параметры Передайте пустой JSON.
Выходные параметры Параметр Тип Описание alpha_names array AlphaName список всех имен отправителя (альфа-имен)
AlphaName Параметр Тип Описание resource_id uint64 уникальный идентификатор имени отправителя (альфа-имени) name string имя отправителя (альфа-имя) status enum AlphaNameStatus статус имени отправителя (альфа-имени) operators array AlphaNameOperator статусы согласования имён отправителя (альфа-имён) с операторами activation_date string дата активации имени отправителя (альфа-имени) в формате RFC-3339 / ISO-8601
AlphaNameStatus Параметр Тип Описание 1 enum имя отправителя (альфа-имя) активно и готово к использованию 2 enum имя отправителя (альфа-имя) неактивно 3 enum имя отправителя (альфа-имя) отключено
AlphaNameOperator Параметр Тип Описание operator enum Operator имя оператора status enum ApprovalStatus статус согласования имя отправителя (альфа-имени) с оператором subscription_fee float абонентская плата
Operator Параметр Тип Описание 0 enum нет имени оператора 1 enum МТС 2 enum Мегафон 3 enum Билайн 4 enum Теле2 5 enum Смартс 6 enum Ростелеком 7 enum Прочие операторы РФ 8 enum СберМобайл
ApprovalStatus Параметр Тип Описание 0 enum статус согласования неизвестен 1 enum имя отправителя (альфа-имя) на согласовании у оператора 2 enum имя отправителя (альфа-имя) согласовано с оператором 3 enum имя отправителя (альфа-имя) отклонено оператором 4 enum имя отправителя (альфа-имя) отключено
Пример Входные параметры:
{}
Выходные параметры:
{
"alpha_names": [
{
"resource_id": "113441",
"name": "Test1",
"status": 2, // неактивно
"operators": [
{
"operator": 1, // МТС
"status": 1 // на согласовании
}
]
},
{
"resource_id": "113440",
"name": "Test2",
"status": 1, // активно
"operators": [
{
"operator": 1, // МТС
"status": 2, // согласовано
"subscription_fee": 2500
},
{
"operator": 2, // Мегафон
"status": 3 // отклонено
}
],
"activation_date": "2023-07-25T12:56:48.890632Z"
}
]
}