retrieve online sip users for an account by list of sip username

import requests
url = "https://api.jambonz.cloud/v1/Accounts/AccountSid/RegisteredSipUsers"
payload = ["alice123", "bob456"]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

[
  {
    "name": "alice123",
    "contact": "sip:alice123@client.jambonz.cloud;transport=wss",
    "expiryTime": 1710000000000,
    "protocol": "wss",
    "allow_direct_app_calling": 1,
    "allow_direct_queue_calling": 1,
    "allow_direct_user_calling": 1,
    "registered_status": "active",
    "proxy": "sip:203.0.113.5:5060"
  },
  {
    "name": "bob456",
    "contact": "sip:bob456@client.jambonz.cloud;transport=udp",
    "expiryTime": 1710003600000,
    "protocol": "udp",
    "allow_direct_app_calling": 0,
    "allow_direct_queue_calling": 1,
    "allow_direct_user_calling": 0,
    "registered_status": "active",
    "proxy": "sip:198.51.100.7:5060"
  }
]

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

AccountSidstringRequired

Request

This endpoint expects a list of strings.

Response

retrieve online sip users for an account

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

protocolenum

Allowed values:

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_statusenum

if there is a current registered session from the client

Allowed values:

proxystring

The source IP and Port used for the registration request.