Управление номерами

Примечание

Описание находится в разработке.

Поиск свободных номеров

Наименование метода в API: number/search. Список передаваемых параметров:

Параметр Описание Пример
number_type („mobile“,“city“) mobile
code Код города 495
type Тип номера (простой, золотой и т.д.) 0
mask Маска для поиска номера 100%
limit Ограничить рамер выборки 10
offset Пропустить определённое кол-во строк 0
owner_type („business“, „personal“) business

В случае успеха возвращается массив номеров со следующими параметрами:

Параметр Описание Пример
phone_number Номер телефона (без кода города) 1330101
city_code Код города 495
full_number Номер телефона (с кодом города) 4951330101
number_type Тип номера (простой, золотой и т.д.) 0
buy_price Цена покупки номера 900
period_price Абонентская плата за номер 150

Пример:

Запрос:
curl -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"jsonrpc":"2.0", "method":"number/search", "id":"1", "params":{"city_code":495, "limit":1}}' \
     -X POST https://api.plusofon.ru

Ответ:
{"jsonrpc":"2.0", "id":"1", "result":[{"phone_number":1330101, ...}], "error":null}

Покупка номера

Наименование метода в API: number/buy. Список передаваемых параметров:

Параметр Описание Пример
number Номер телефона (с кодом города) 4951330101
owner_type Тип покупаемого номера(„business“, „personal“) personal

Метод возвращает одно из следующих значений:

Значение Описание
1 Номер успешно куплен
-1 Номер не найден
-2 Недостаточно средств для покупки номера

Пример:

Запрос:
curl -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"jsonrpc":"2.0", "method":"number/buy", "id":"1", "params":{"number":"4951330101"}}' \
     -X POST https://api.plusofon.ru

Ответ:
{"jsonrpc":"2.0", "id":"1", "result":1, "error":null}

Типы номеров

Значение Описание
0 Простой
5 Бронзовый
1 Серебряный
2 Золотой
3 Платиновый
4 Эксклюзивный

Удаление номера

Наименование метода в API: number/delete. Список передаваемых параметров:

Параметр Описание Пример
number Номер телефона 74951330101

Метод возвращает одно из следующих значений (или ошибку если входные параметры не прошли валидацию):

Значение Описание
1 Номер удален
-1 Во время удаления возникла ошибка

Резервирование номера

Наименование метода в API: number/reserve. Список передаваемых параметров:

Параметр Описание Пример
number Номер телефона 74951330101
owner_type Тип покупаемого номера(„business“, „personal“) personal

Метод возвращает одно из следующих значений (или ошибку если входные параметры не прошли валидацию):

Значение Описание
1 Номер зарезервирован
-1 Во время резервирования возникла ошибка

Получение списка зарезервированных номеров

Наименование метода в API: number/get-reserved. Список передаваемых параметров:

отсутствуют

Метод возвращает массив со следующими полями или -1 если список зарезервированных номеров пуст:

Значение Описание
number Номер телефона
customer_id Id Клиента
reserved_to Timestamp до которого зарезервирован номер
-1 Нет номеров

Переадресации на устройство

Наименование метода в API: number/forward-to-device. Список передаваемых параметров:

Параметр Описание Пример
number Номер на котором устанавливаем переадресацию 74951330101
forward_number Номер на который осуществляется переадресация или sip аккаунт 79991110000

Метод возвращает одно из следующих значений (или ошибку если входные параметры не прошли валидацию):

Значение Описание
1 Успешно назначенна переадресация
-1 Во время назначения возникла ошибка

Мои входящие номера

Наименование метода в API: number/incoming. Список передаваемых параметров:

Параметр Описание Пример
number_type Тип номеров all
offset Смещение результатов относительно начала 10
limit Ограничение результата выборки номеров  

Метод возвращает массив номеров (или ошибку если входные параметры не прошли валидацию):

Значение Описание
numbers массив номеров
-1 Нет номеров

numbers состоит из следующих элементов:

Значение Описание
number Номер телефона
follow На кого настроена переадресация
i_account id аккаунта телефонного номера

Возможные значения number_type

Значение Описание
all Номера всех типов
mobile Мобильные номера
city Городские номера
federal Федеральные номера (8-800)
personal Персональные номера

Получение доступных кодов городов

Наименование метода в API: number/get-city-codes. Список передаваемых параметров:

Параметр Описание Пример
types массив типов [„city“, „mobile“, „federal“]

В случае успеха возвращается массив доступных кодов городов:

Параметр Описание Пример
code Код города 347
region Название города Уфа

Обновление алиаса

Наименование метода в API: number/updateAlias. Список передаваемых параметров:

Параметр Описание Пример
number номер 9644951177
numberAlias алиас andrium

В случае успеха возвращается TRUE.

Список алиасов

Наименование метода в API: number/listAlias. Список передаваемых параметров:

Параметр Описание Пример
numbers массив номеров [„9644951177“, „9611167864“]

В случае успеха возвращается массив, где ключем является номер, а значением - его алиас.