List Clients

GET

https://api.jambonz.cloud/v1/Clients

GET

/v1/Clients

$ curl https://api.jambonz.cloud/v1/Clients \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 [
2   {
3     "account_sid": "a3f1c2d4-5b67-4e89-9f01-23456789abcd",
4     "client_sid": "b7e8f9a0-c123-4d56-8e90-abcdef123456",
5     "username": "jambonz_user01",
6     "password": "pxxxxxxxxxx",
7     "is_active": 1,
8     "allow_direct_app_calling": 1,
9     "allow_direct_queue_calling": 0,
10     "allow_direct_user_calling": 1
11   },
12   {
13     "account_sid": "d4e5f6a7-8910-4b32-8cde-0987654321fe",
14     "client_sid": "c9d8e7f6-a543-21b0-9c87-fedcba654321",
15     "username": "client_2024",
16     "password": "axxxxxxxxxx",
17     "is_active": 0,
18     "allow_direct_app_calling": 0,
19     "allow_direct_queue_calling": 1,
20     "allow_direct_user_calling": 0
21   }
22 ]

Returns a list of clients

Authentication

AuthorizationBearer

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

Response

retrieve online sip users for an account

account_sidstringOptionalformat: "uuid"

client_sidstringOptionalformat: "uuid"

usernamestringOptional

passwordstringOptional

in the response the password will only show the first character with subsequnet ones replaces by an x

is_activeenumOptionalDefaults to 1

allow_direct_app_callingenumOptionalDefaults to 1

allow_direct_queue_callingenumOptionalDefaults to 1

allow_direct_user_callingenumOptionalDefaults to 1