Перейти к основному содержимому

Аренда номеров

Аренда номера, просмотр активных номеров и отмена заказов.

Арендовать номер

POST /numbers/

Тело запроса

{
"product": "mixin",
"service_code": "tg",
"country_code": 187,
"period_code": 0
}

Параметры

ПараметрОбязательныйОписание
productДаmixin или residential
service_codeДаИз GET /numbers/mixed/
country_codeДаИз GET /numbers/mixed/countries/
period_codeТолько для residentialИз GET /numbers/residential/

Ответ

{
"id": "640170a4-8188-468e-be5f-b2281170deed",
"status": "waiting",
"product": "mixin",
"service_code": "tg",
"country_code": "187",
"phone_number": "13111111119",
"last_sms_code": null,
"expiration_time": "2023-08-31T14:21:20Z"
}

Список активных номеров

GET /numbers/

Возвращает все арендованные номера и полученные SMS-коды.

Ответ

[
{
"id": "640170a4-8188-468e-be5f-b2281170deed",
"status": "waiting",
"product": "mixin",
"service_code": "tg",
"country_code": "187",
"phone_number": "13111111119",
"last_sms_code": null,
"expiration_time": "2023-08-31T14:21:20Z"
}
]

Статусы

СтатусОписание
waitingНомер активен, ожидает SMS
receivedSMS-код получен
expiredСрок действия номера истёк
cancelledНомер отменён

Отменить номер

PUT /numbers/{id}/

Отменить или удалить арендованный номер по его ID.

Ответ

Возвращает 204 No Content при успешном выполнении.