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

POST

https://api.jambonz.cloud/v1/Accounts/:AccountSid/RegisteredSipUsers

POST

/v1/Accounts/:AccountSid/RegisteredSipUsers

$ curl -X POST https://api.jambonz.cloud/v1/Accounts/AccountSid/RegisteredSipUsers \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '[
>   "alice123",
>   "bob456"
> ]'

200Successful

1 [
2   {
3     "name": "alice123",
4     "contact": "sip:alice123@client.jambonz.cloud;transport=wss",
5     "expiryTime": 1710000000000,
6     "protocol": "wss",
7     "allow_direct_app_calling": 1,
8     "allow_direct_queue_calling": 1,
9     "allow_direct_user_calling": 1,
10     "registered_status": "active",
11     "proxy": "sip:203.0.113.5:5060"
12   },
13   {
14     "name": "bob456",
15     "contact": "sip:bob456@client.jambonz.cloud;transport=udp",
16     "expiryTime": 1710003600000,
17     "protocol": "udp",
18     "allow_direct_app_calling": 0,
19     "allow_direct_queue_calling": 1,
20     "allow_direct_user_calling": 0,
21     "registered_status": "active",
22     "proxy": "sip:198.51.100.7:5060"
23   }
24 ]

Authentication

AuthorizationBearer

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

Path parameters

AccountSidstringRequiredformat: "uuid"

Request

This endpoint expects a list of strings.

Response

retrieve online sip users for an account

namestringOptional

the client username

contactstringOptional

The value in the contact header of the registration

expiryTimeintegerOptional

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

protocolenumOptional

allow_direct_app_callingintegerOptional

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

allow_direct_queue_callingintegerOptional

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

allow_direct_user_callingintegerOptional

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

registered_statusenumOptional

if there is a current registered session from the client

proxystringOptional

The source IP and Port used for the registration request.