JAjambonz
Clients

retrieve registered client registration

Changed on
get/Accounts/{AccountSid}/RegisteredSipUsers/{Client}

Request

Response

registered client found

namestring

the client username

contactstring

The value in the contact header of the registration

expiryTimeinteger

The timestamp (in ms since 00:00:00.000 01/01/1970) that the current registraion will expire

protocol'wss' | 'udp' | 'tcp' | 'tls'
allow_direct_app_callinginteger

set to 1 if client is allowed to call app sids directly

allow_direct_queue_callinginteger

set to 1 if client is allowed to dial into queues to dequeue calls

allow_direct_user_callinginteger

set to 1 if client is allowed to call other users by name directly.

registered_status'active' | 'inactive'

if there is a current registered session from the client

proxystring

The source IP and Port used for the registration request.

Example response

{
  "name": "xhoaluu",
  "contact": "sip:0dluqjt6@od41sl9jfc9m.invalid;transport=ws",
  "expiryTime": 1698981449173,
  "allow_direct_app_calling": 1,
  "allow_direct_queue_calling": 1,
  "allow_direct_user_calling": 1,
  "proxy": "sip:192.0.0.1:12345"
}

Changes

  • 35ad9602e3c7Revision changes
    • breaking

      the response property became optional for the status

    • warning

      added the new tcp enum value to the response property for the response status

    • warning

      added the new tls enum value to the response property for the response status

    • warning

      added the new udp enum value to the response property for the response status

    • warning

      added the new wss enum value to the response property for the response status

    • info

      added the optional property to the response with the status