Lock
Метод Lock
Примените этот метод для бронирования номера перед его покупкой. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.
Точка подключения:
POST: https://api.exolve.ru/number/v1/Lock
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
| Имя | Тип | Описание |
|---|---|---|
| Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
| Параметр | Тип | Описание |
|---|---|---|
| number_code | uint64 | номер |
| seconds | uint32 | время бронирования в секундах (от 60 до 600 секунд) |
| description | string | комментарий к бронированию номера |
Выходные параметры
| Параметр | Тип | Описание |
|---|---|---|
| Id | uint32 | идентификатор бронирования |
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 500 | Internal Server Error | Номер {number} не в статусе free | заданный в поле number_code номер не свободен для покупки |
| 400 | Internal Server Error | Номер {number} не существует | заданный в поле number_code номер не существует |
| 400 | Bad Request | proto: syntax error (line 2:20): unexpected token , | пустое значение в поле number_code |
Примеры
Входные параметры:
{
"number_code": 74951340002,
"seconds": 500
}
Выходные параметры:
{
"Id": 1001884
}