Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Note

При необходимости получения данных о регистрации для нескольких добавочный рекомендуется использовать URL вида:

extension/registration/?extension_id=id1&extension_id=id2
где id1 и id2 идентификаторы добавочных. Одновременно можно запрашивать до 10 добавочных (ответ придет только на первые 10 добавочных)

(см. раздел "Пример")

 

Table of Contents

Описание структур данных

...

Имя

...

Тип

...

Описание

...

contact_address

...

string

...

device

...

string

...

expires

...

integer

...

real_address

...

string

...

registration_id

...

string

...

Данные всех регистраций (RegInfo)

...

Имя

...

Тип

...

Описание

...

extension_id

...

integer

...

registered

...

boolean

...

registrations

...

array

...

Пример

Для добавочного с  идентификатором 3 нужно выяснить состояние его регистраций:

...

метод

...

ресурс

...

данные

...

ответ

...

extension/registration/?extension_id=3

...

 

...


Warning

Мы обновили документацию, актуальная версия страницы доступна по ссылке: Регистрации внутреннего номера (/registration/)

Ресурс предназначен для выяснения адресов регистрации телефонного терминала на ATC и управления ими. Для задания статической регистрации следует использовать ресурс телефонного терминала.

Note

При необходимости получения данных о регистрации для нескольких добавочный рекомендуется использовать URL вида:
extension/registration/?extension_id=id1&extension_id=id2
где id1 и id2 идентификаторы добавочных.
(см. раздел "Пример")


Table of Contents

Описание структур данных

Данные одной регистрации (registration)
Anchor
RegItem
RegItem

Имя

Тип

Описание

contact_address

string

Адрес и порт регистрации, указанный устройством при регистрации в формате address:port

device

string

Имя устройства (User Agent)

expires

string

Дата (UTC), по истечении который регистрация пропадет (если не будет продлена устройстом)

real_address

string

Адрес и порт, откуда реально пришел запрос на регистрацию (в отличии от contact_address)

registration_id

string

Уникальный идентификатор регистрации

Данные всех регистраций (RegInfo)

Имя

Тип

Описание

extension_id

integer

Уникальный идентификатор добавочного

registered

boolean

"true" если есть активные регистрации. При значении "false" массив "registrations" содержит данные о последних (уже истекших) регистрациях

registrations

array

Массив элементов registration

Пример

Для добавочного с  идентификатором 3 нужно выяснить состояние его регистраций:

метод
ресурс
данные
ответ
GET
extension/registration/?extension_id=3


  
   "registered":true,
   "extension_id":3,
   "registrations":  
        
         "device":"Yealink SIP-T46G 28.72.14.5",
         "real_address":"sip:xxx.xxx.xxx.xxx:62338",
         "contact_address":"sip:000*002@192.168.5.52:5062",
         "expires":699,
         "registration_id": "uloc-572b0ffb-6d47-001"
      }
   ]
}

Теперь удалить эту регистрацию:

метод
ресурс
данные
ответ
DELETE
/extension/3/registration/uloc-572b0ffb-6d47-001


no content

Если у клиента много добавочных, то ускорения лучше получать их блоками:

метод
ресурс
данные
ответ
GET
extension/registration/?extension_id=3&extension_id=2


  
      
        "registered":true,
        "extension_id":3,
        "registrations":  
              
                "device":"Yealink SIP-T46G 28.72.14.5",
                "real_address":"sip:xxx.xxx.xxx.xxx:62338",
                "contact_address":"sip:000*002@192.168.5.52:5062",
                "expires":1764,
                "registration_id":"uloc-5731d93c-4a88-51"
            }
        ]
    },
      
        "registered":true,
        "extension_id":2,
        "registrations":  
      
              
         
                "device":"
Yealink SIP-T46G 28
Grandstream GXP2020 1.
72
2.
14
5.
5
3",
         
                "real_address":"sip:xxx.xxx.xxx.xxx:
62338
5060",
         
                "contact_address":"sip:000*
002@192
000@192.168.5.
52:5062
60:5060;transport=udp",
         
                "expires":
699
1444,
         
                "registration_id":"uloc-
572b0ffb
570cfe57-
6d47
aa6-
001
8d4"
      
            }
   
метод
ресурс
данные
ответ
DELETE
        ]
    }

Теперь удалить эту регистрацию:

]

Ресурсы

Раздел "добавочный"

GET /extension/

...

registration/

...

 

...

Если у клиента много добавочных, то ускорения лучше получать их блоками (до 10 добавочных):

...

метод

...

ресурс

...

данные

...

ответ

...

extension/registration/?extension_id=3&extension_id=2

...

 

...

Ресурсы

Раздел "клиент"

Раздел "группа добавочных"

...

Получить статус регистрации всех добавочных

Параметры запроса

Имя

Тип

extension_id

array [integer]

Поля ответа

Имя

Тип

registered

boolean

extension_id

integer

registrations

array [registration]


GET /extension/{extension_id}/registration/

Получить статус регистрации добавочного

Параметры URL

Имя

Тип

extension_id

string

Поля ответа

Имя

Тип

registered

boolean

extension_id

integer

registrations

array [registration]

DELETE /extension/{extension_id}/registration/

Удалить все регистрации на добавочном

Параметры URL

Имя

Тип

extension_id

string

...

DELETE /extension/{extension_id}/registration/{registration_id}

Удалить конкретную регистрацию на добавочном

Параметры URL

Имя

Тип

registration_id

string

extension_id

string


Теги по теме

Related Labels