GetFree

Метод GetFree

Примените метод GetFree для получения списка номеров, доступных для покупки

Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:

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

Авторизация

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

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

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

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

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

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

Маска

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

NumberElement

NumberOptions

Примеры

Пример получения свободных номеров для региона «Москва», категории «Обычный», тип «Мобильный»:

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

{
    "type_id": 1104,
    "region_id": 10230,
    "category_id": 10000,
    "random": true,
    "limit": 1
}

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

{
    "numbers": [
        {
            "number_code": "79300655934",
            "type_name": "DEF",
            "region_name": "Moscow",
            "category_name": "REGULAR",
            "subscription_fee": 150,
            "install_fee": 590,
            "number_options": {
                "incoming_calls": true,
                "outgoing_calls": true,
                "incoming_sms": true,
                "outgoing_sms": true
            }
        }
    ]
}

Пример получения свободных номеров для региона «Санкт-Петербург», категории «Бронзовый», тип «Городской»:

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

{
    "type_id": 1105,
    "region_id": 10182,
    "category_id": 10011,
    "random": true,
    "mask": "781221*",
    "limit": 1
}

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

{
    "numbers": [
        {
            "number_code": "78122135222",
            "type_name": "ABC",
            "region_name": "St. Petersburg",
            "category_name": "BRONZE",
            "subscription_fee": 200,
            "install_fee": 1000,
            "number_options": {
                "incoming_calls": true,
                "outgoing_calls": true,
                "incoming_sms": false,
                "outgoing_sms": false
            }
        }
    ]
}

Пример получения свободных номеров для региона «Россия», категории «Серебряный», тип «Федеральный»:

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

{
    "type_id": 1106,
    "region_id": 10084,
    "category_id": 10022,
    "random": true,
    "limit": 1
}

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

{
    "numbers": [
        {
            "number_code": "78003333729",
            "type_name": "KDU",
            "region_name": "Russia",
            "category_name": "SILVER",
            "subscription_fee": 3500,
            "install_fee": 50000,
            "number_options": {
                "incoming_calls": true,
                "outgoing_calls": false,
                "incoming_sms": false,
                "outgoing_sms": false
            }
        }
    ]
}

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