GetList (купленные номера)

Метод GetList

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

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

POST: https://api.exolve.ru/number/customer/v1/GetList

Авторизация

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

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

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

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

Параметр Тип Описание
application_uuid string uuid приложения — для вывода номеров, купленных в конкретном приложении
type_id uint64 идентификатор типа номера
category_id uint64 идентификатор категории номера
region_id uint64 идентификатор региона номера
date_from string дата покупки номера в формате RFC-3339 / ISO-8601, от которой начинать выборку
date_to string дата покупки номера в формате RFC-3339 / ISO-8601, до которой продолжать выборку
search_filter string фильтр поиска по номеру
limit uint64 лимит выводимых строк
offset uint64 номер строки, с которой начинать выборку (начинается с 0)
sip_filter enum SipFilter наличие или отсуствие привязанного к номеру SIP-соединения

Список типов номеров (type_id)

Параметр ID типа
Мобильный (DEF) 1104
Городской (ABC) 1105
7-800 (KDU) 1106 (использовать только с регионом Россия)

Список категорий номеров (category_id)

Название ID категории номера для типа мобильный ID категории номера для типа городской ID категории номера для типа 7-800
Обычный 10000 10001 10002
Бронзовый 10010 10011 10012
Серебряный 10020 10021 10022
Золотой 10030 10031 10032
Платиновый 10040 10041 10042
Эксклюзивный 10050 10051 10052

Список регионов (region_id)

Название ID типа номера
Россия 10084
Магнитогорск 10186
Пермь 10181
Санкт-Петербург 10182
Москва 10230
Ростов-на-Дону 10231
Омск 10196
Новороссийск 10221
Екатеринбург 10190
Казань 10195
Сочи 10153
Самара 10192
Краснодар 10184
Нижний Новгород 10189
Новосибирск 10183
Красноярск 10191
Челябинск 10229
Тольятти 10227
Воронеж 10193

SipFilter

Параметр Тип Описание
0 enum фильтр по SIP-соединениям не применяется
1 enum нет привязанного SIP-соединения
2 enum есть привязанное SIP-соединение

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

Параметр Тип Описание
numbers array NumberElement список номеров с информацией по ним

NumberElement

Параметр Тип Описание
application_uuid string uuid приложения
number_name string номер
description string описание
type_name string наименование типа
region_name string наименование региона
application_name string наименование приложения
subscription_fee string ежемесячная абонентская плата
install_fee string единоразовая плата за подключение
create_date string дата покупки номера в формате RFC-3339 / ISO-8601
category_name string название категории

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

Код Статус Пример сообщения Описание
400 Bad Request “error”: “proto: syntax error (line 2:16): invalid value п” в одном из полей запроса невалидный формат
400 Bad Request “error”: “proto: syntax error (line 2:16): unexpected token ,”} пустое значение в одном из полей
401 Unauthorized Unauthorized невалидный API-ключ
401 Unauthorized malformed token API-ключ не задан
404 Not Found некорректный URL-адрес запроса

Примеры 

// Входные параметры
{
    "type_id": 1105,
    "region_id": 10230,
    "category_id": 10001,
    "application_uuid": "f32fbf38-b68b-405e-aa77-9aaee64c0ee8",
    "date_from": "2022-10-01T08:49:28.446495Z",
    "date_to":"2024-12-22T08:49:28.446495Z",
    "search_filter": "74991234567",
    "limit": 10,
    "offset": 0,
    "sip_filter": 1
}
// Выходные параметры
{
    "numbers": [
        {
            "number_name": "74991234567",
            "type_name": "ABC",
            "region_name": "Moscow",
            "application_name": "test_application",
            "subscription_fee": 200,
            "install_fee": 990,
            "create_date": "2024-02-22T08:35:10.471123Z",
            "application_uuid": "f32fbf38-b68b-405e-aa77-9aaee64c0ee8"
        }
    ],
    "total": 1
 
}

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