Для добавления нового SIP шлюза, необходимо отправить  POST запрос на адрес сервера Webitel Engine с заданным телом запроса. Ниже приведен пример такого запроса:

POST /api/v2/gateway

Content-Type: application/json
X-Access-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6ImNmMTQ3ZTFiLTk1ZGYtNDI1OC05ZT
M2LWQ4NWZkZDZlZDUzZiIsImV4cCI6MTQ5NzkwNjAwMDAwMCwiZCI6InNpdGUiLCJ0IjoiZG9tYWluIiwidiI6Mn0.o
-bcG_U3oJMN4r3YaBfSg9CcrZPANZulcapR4E6TSdg
BODY
{
	"name": "myGW",
	"username": "4952-200",
	"password": "dvxhH5Lm32",
	"realm": "pbx.zadarma.com",
	"profile": "external",
	"domain": "test06.webitel.com",
	"params": [
		{
			"name": "register",
			"value": "true"
		},
		{
			"name": "extension-in-contact",
			"value": "true"
		}
	],
	"var": [],
	"ivar": [],
	"ovar": []
}

Описание структуры тела запроса приведено в таблице ниже:

#
Название
Тип
Значение
2name
stringУникальное название SIP шлюза
3username
stringSIP Username
4passwordstringSIP password
5realmstringSIP realm / domain
6profilestring

SIP profile, указывается одно из значений:

  • nonreg - для SIP trunk без регистрации (5060/udp)
  • external - для подключения к SIP провайдеру по логин и пароль (5080/udp)
7domainstringWebitel domain с которым связан данным шлюз.
8paramsarrayМассив дополнительных параметров для FreeSWITCH.

var | ivar | ovararrayДополнительные переменные.

Просмотр информации, обновление или удаление происходит через GET, PUT и DELETE запросы соответственно:

GET /api/v2/gateway/myGW

X-Access-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6ImNmMTQ3ZTFiLTk1ZGYtNDI1OC05ZT
M2LWQ4NWZkZDZlZDUzZiIsImV4cCI6MTQ5NzkwNjAwMDAwMCwiZCI6InNpdGUiLCJ0IjoiZG9tYWluIiwidiI6Mn0.o
-bcG_U3oJMN4r3YaBfSg9CcrZPANZulcapR4E6TSdg
  • No labels