Регистрации внутреннего номера (/registration/)

_{Протестировать методы API можно на странице}_{интерактивного обозревателя API}_{и без написания кода}
_{Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см.}_{Создание и авторизация приложений}₎

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

1 Описание структур данных
2 Примеры
3 Ресурсы раздела "Внутренний номер"

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

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

Имя	Тип	Описание

Имя	Тип	Описание
contact_address	string	Адрес и порт регистрации, указанные устройством при регистрации в формате address:port
device	object	Имя устройства (User Agent)
expires	long	Дата (UTC), по истечении которой регистрация пропадет (если не будет продлена устройством)
real_address	string	Адрес и порт, откуда реально пришел запрос на регистрацию (в отличие от contact_address)
registration_id	string	Уникальный идентификатор регистрации

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

Имя	Тип	Описание

Имя	Тип	Описание
extension_id	integer	Уникальный идентификатор внутреннего номера
registered	boolean	Значение"true", если есть активные регистрации. При значении "false" массив "registrations" содержит данные о последних (уже истекших) регистрациях
registrations	array	Массив элементов registration

Примеры

Для внутреннего номера с идентификатором 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"    
    }   
  ]
}

Теперь удалим вышеуказанную регистрацию:

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

[    
  {       
     "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":"Grandstream GXP2020 1.2.5.3",                
        "real_address":"sip:xxx.xxx.xxx.xxx:5060",                
        "contact_address":"sip:000*000@192.168.5.60:5060;transport=udp",                
        "expires":1444,                
        "registration_id":"uloc-570cfe57-aa6-8d4"            
       }        
     ]    
  }
]

Ресурсы раздела "Внутренний номер"

GET /extension/registration/

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

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

Имя	Тип

Имя	Тип
extension_id	array[integer]

Поля ответа

Имя	Тип

Имя	Тип
registered	boolean
extension_id	long
registrations	array[registration]

GET /extension/{extension_id}/registration/

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

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

Имя	Тип

Имя	Тип
extension_id	string

Поля ответа

Имя	Тип

Имя	Тип
registered	boolean
extension_id	long
registrations	array[registration]

DELETE /extension/{extension_id}/registration/

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

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

Имя	Тип

Имя	Тип
extension_id	string