GetAttributes (переадресация, запись)

Метод GetAttributes

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

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

POST: https://api.exolve.ru/number/v1/GetAttributes

Авторизация

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

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

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

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

Параметр Тип Описание
number_code uint64 код номера

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

Параметр Тип Описание
number_resource_id uint64 код номера
status_name string наименование статуса
attributes NumberAttributes атрибуты номера, информация о настройке

NumberAttributes

Параметр Тип Описание
call_record boolean True если функция записи звонка включена. False если функция записи звонка отключена
call_forwarding_type enum ForwardingType тип переадресации
call_forwarding_number enum ForwardingNumber настройки номера, на который происходит переадресация
call_forwarding_ipcr enum ForwardingIpcr URL, на который происходит переадресация

ForwardingType

Параметр Тип Описание
CALL_FORWARDING_TYPE_NUMBER = 2 string переадресация на номер
CALL_FORWARDING_TYPE_IPCR = 3 string переадресация на URL
CALL_FORWARDING_TYPE_UNSPECIFIED = 0 string переадресация не определена

ForwardingNumber

Параметр Тип Описание
redirect_type int64 тип переадресации: 1 - одиночная, 2 - последовательная, 3 - параллельная
call_control CallControl управление входящим вызовом
event_url string URL для отправки уведомлений о ходе звонка
event_extended boolean True для получения расширенных уведомлений. False для получения стандартного набора уведомлений
file_to_a string аудиосообщение звонящему абоненту
file_to_b string аудиосообщение принимающему абоненту
answer boolean True для проигрывания аудиосообщения в предответном состоянии. False для проигрывания аудиосообщения в ответном состоянии (False по умолчанию)
masking boolean True для скрытия номер звонящего абонента. False для показа оригинального номера звонящего абонента
display_number string номер Exolve, который видит звонящий абоненту при вызове

CallControl

Параметр Тип Описание
period string период переадресации входящего вызова
period_description string описание периода переадресации вызова
timeout uint32 время ожидания ответа в секундах
active boolean True для переадресации вызова на redirect_number, False для сброса вызова
name string символьное имя номера для переадресации вызова
redirect_number string номер для переадресации
dtmf string добавочный номер

ForwardingIpcr

Параметр Тип Описание
url string URL, на который происходит переадресация
reserve string номер, на который происходит переадресация, если URL не доступен

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

Код Статус Пример сообщения Описание
500 Internal Server Error Application [ID] does not own resource [number] указанный в поле number_code номер не принадлежит указанному приложению или не верно задан формат номера
400 Bad Request proto: syntax error (line 2:20): invalid value п значение в поле number_code не валидно
400 Bad Request proto: (line 3:1): invalid value for uint64 type: } не задано значение в поле number_code

Примеры

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

{
    "number_code": 74996487174
}

Выходные параметры для номера с переадресацией на номер:

{
    "number_resource_id": "94004",
    "status_name": "Active",
    "attributes": {
        "call_record": false,
        "call_forwarding_type": 2,
        "call_forwarding_number": {
            "redirect_type": 1,
            "call_control":[
                {
                    "period": "always",
                    "period_description": "всегда переадресовывать",
                    "timeout": "16",
                    "active": true,
                    "name": "звонит клиент",
                    "redirect_number": "74996480184",
                    "dtmf": "896"
                }
            ],
           "event_url": "https://example.com/",
           "event_extended": true,
           "file_to_a": "12345",
           "file_to_b": "54321",
           "answer": true,
           "masking": true,
           "display_number": "74995557890"
        }
    }
}

Входные параметры для переадресации на URL:

{
    "number_resource_id": "51802",
    "status_name": "",
    "attributes": {
        "call_record": true,
        "call_forwarding_type": "CALL_FORWARDING_TYPE_IPCR",
        "call_forwarding_ipcr": {
            "url": "http://example.com",
            "reserve": "74996482846"
        }
    }
}

Содержание статьи