Create
Метод Create
Примените этот метод для создания SIP-аккаунта. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.
Точка подключения:
POST: https://api.exolve.ru/sip/v1/Create
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
Имя | Тип | Описание |
---|---|---|
Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0 , где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
Параметр | Тип | Описание |
---|---|---|
sip_name | string | название ресурса SIP-аккаунта |
number | uint64 | определяемый номер телефона |
description | string | описание к ресурсу SIP-аккаунта |
cli | string | A-номер |
Выходные параметры
Параметр | Тип | Описание |
---|---|---|
sip_resource_id | uint64 | уникальный идентификатор ресурса SIP-аккаунта |
Возможные ошибки
Код | Статус | Пример сообщения | Описание |
---|---|---|---|
500 | Internal Server Error | Error adding SIP: Значение [’number’] свойства [exolve_sip_uid] не уникально | значение в поле number не уникально |
500 | Internal Server Error | ERROR: Application [ID] does not own resource [number] | значение в поле number не принадлежит указанному приложению |
400 | Bad Request | proto: syntax error (line 6:15): invalid value п | значение в поле number не валидно |
400 | Bad Request | proto: syntax error (line 6:15): unexpected token , | не задано значение в поле number |
Примеры
Входные параметры:
{
"sip_name": "Test",
"number": 74996487186,
"description": "Test SIP-аккаунт",
"cli": "74996487186"
}
Выходные параметры:
{
"sip_resource_id": "5202"
}