2.Описание протоколов управления услугами

compared with
Current by Ковалев Дмитрий
on Jul 29, 2016 09:33.

Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (30)

View Page History

Для выполнения действий по управлению услугами, OSS/BSS должна быть авторизована.

h3. 2.1.1.Авторизация по имени и паролю

Для доступа к точке привязки веб-сервиса необходимо выполнить BASIC HTTP авторизацию.

h3. 2.1.2.Авторизация по IP адресу

В случае, когда связь с OSS/BSS осуществляется по защищенному каналу (VPN), рекомендованный механизм авторизации -- авторизация по IP-адресу. В «UC Centrex» необходимо зарегистрировать IP-адрес OSS/BSS.

h3. 2.1.3.Авторизация с PKI

В случае распределенной OSS или если связь с OSS осуществляется по незащищенному каналу связи, рекомендованный механизм авторизации -- авторизация персональным криптографическим ключом с использованием протокола SSL.

h2. 2.2.Формат информационного обмена

e164telnums?: E164Telnum[],

aliases?: string[],
route: string,

gateways?: gateway[],
dialplan: string,

demo: boolean,

billingID?: string,

filesLimit?: string,
maxLines?: string,

mailLimit?: maxLinesIn?: string,

    diskLimit?: maxLinesOut?: string

)
{code}
e164telnums - номера телефонов, которые будут делегированы в домен. Если номера в операторском домене нет, он будет создан и привязан к дефолтному шлюзу.
route - идентификатор маршрута, который надо назначить домену
dialplan - идентификатор дефолтного диалплана для домена
Demo - выставляет домену специальный признак, по которому он исключается из учета.
maxLines - максимальное количество линий, которое доступно домену. Если не задано, количество линий считается неограниченным.
maxLinesIn - максимальное количество входящих линий, которое доступно домену
maxLinesOut - максимальное количество исходящих линий, которое доступно домену
Если задано значение maxLines, то maxLinesIn и maxLinesOut игнорируются.

Aliases --- перечень дополнительных имён домена. Gateways --- список провайдеров с указанием возможности совершать входящие и исходящие звонки пользователям домена. Существует два вида звонков --- входящие и исходящие. Соответственно, каждому идентификатору провайдера должна соответствовать строка in, out, или both. Demo - выставляет домену специальный признак, по которому он исключается из учета. Результат:
Результат:
|| Код ошибки || Текст || Описание ||
| 200 | OK | Домен создан |
| 512 | Incorrect DNS record “%testline%”; | Домен не прошел валидацию DNS. В тексте перечисляются некорректные DNS записи. |
| 515 | Number exists | Номер уже зарегистрирован за другим доменом |
| 516 | Telnum not found | Номер не существует |
| 518 | Telnum delegate error | Ошибка делегации номера |

<e164telnums>74872300101</e164telnums>

<aliases>mail.test.mtt.cport.ru</aliases> <route>afb7ee54-de26-4cd6-808a-431f0a280d91</route>

<gateways><id>sp1</id><direction>both</direction></gateways> <dialplan>c9343a11-04e1-4750-a543-824f935a1994</dialplan>

<demoDomain>false</demoDomain>
{code}

h3. 2.3.5.Регистрация домена (Гравител)

Сигнатура:

{code}
createGravitelDomain(

domain: string,

password: string,

telnum: E164Telnum

)
{code}

domain --- имя домена, который необходимо создать;
password --- пароль администратора;
telnum --- номер телефона в формате E.164.

Результат:
|| Код ошибки || Текст || Описание ||
| 200 | OK | Домен создан |
| 500 | | Внутренняя ошибка сервера |
| 504 | Invalid preference | Неправильное свойство домена |
| 511 | Domain exists | Домен с таким именем уже существует |
| 512 | Incorrect DNS record “%testline%”; | Домен не прошел валидацию DNS. В тексте перечисляются некорректные DNS записи. |
| 515 | Number exists | Номер уже зарегистрирован за другим доменом |
| 516 | Telnum not found | Номер не существует |
| 518 | Telnum delegate error | Ошибка делегации номера |

Пример:

{code:xml|title=POST http://be01.cport.ru:8011/uccp|borderStyle=solid}
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prov="http://itoolabs.com/ns/ucc/provision">

<soapenv:Header/>

<soapenv:Body>

<prov:createGravitelDomain>

<createGravitelDomainRequest>

<domain>test.mtt.cport.ru</domain>

<password>1qaz2wsx</password>

<telnum>74872300100</telnum>

</createGravitelDomainRequest>

</prov:createGravitelDomain>

</soapenv:Body>

</soapenv:Envelope>
{code}

возвращает в случае успеха:

{code:xml|borderStyle=solid}
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

<S:Body>

<ns2:createGravitelDomainResponse xmlns:ns2="http://itoolabs.com/ns/ucc/provision">

<createGravitelDomainResponse>

<code>200</code>

<text>OK</text>

</createGravitelDomainResponse>

</ns2:createGravitelDomainResponse>

</S:Body>

</S:Envelope>
{code}

возвращает в случае неуспеха:

{code:xml|borderStyle=solid}
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">

<S:Body>

<ns2:createGravitelDomainResponse xmlns:ns2="http://itoolabs.com/ns/ucc/provision">

<createGravitelDomainResponse>

<code>501</code>

<text>Domain exists</text>

</createGravitelDomainResponse>

</ns2:createGravitelDomainResponse>

</S:Body>

</S:Envelope>
{code}


h2. 2.4.Временная блокировка объектов

updateDomain (

name: string,

serviceClass: string,

demo?: boolean,

billingID?: string,

filesLimit?: string,
maxLines?: string,

mailLimit?: maxLinesIn?: string,

diskLimit?: string
    maxLinesOut?: string


)
{code}

maxLines - максимальное количество линий, которое доступно домену. Если не задано, количество линий считается неограниченным.
maxLinesIn - максимальное количество входящих линий, которое доступно домену
maxLinesOut - максимальное количество исходящих линий, которое доступно домену
Если задано значение maxLines, то maxLinesIn и maxLinesOut игнорируются.

Результат:
|| Код ошибки || Текст || Описание ||
<name>test.mtt.cport.u</name>

<serviceClass>Standard</serviceClass>

<demo>false</demo>

<maxLinesIn>5</maxLinesIn>

<maxLinesOut>7</maxLinesOut>

</updateDomainRequest>