Users

List users

List a collection of users.

GEThttp://127.0.0.1:8888/api/users

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 100,
  "items": [
    {
      "id": {},
      "name": "text",
      "enabled": true,
      "email": {},
      "display_name": "text",
      "role": "User",
      "mobile_phone": "text",
      "work_phone": "text",
      "home_phone": "text",
      "address": "text",
      "department": "text",
      "extension_number": "text",
      "created_at": {},
      "avatar_file_name": "text",
      "avatar_file_size": 0,
      "avatar_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
      "sync_type": "Microsoft 365"
    }
  ]
}

Create a user

Create a new user.

POSThttp://127.0.0.1:8888/api/users

Body

application/json

name*string

The user's account name.
Only letters, numbers, and the following special characters can be added: underscore, dash, single quote, and period (_, -, ', and .).
Username cannot start or end with period (.).
admin, system, administrator, and root are reserved names for system admin only with case ignored.

password*string

The password of user.

email*all of

The email address of user.

display_name*string

The display name of user.

enabledboolean

Allows temporarily disabling the extension.

role*string

Roles include built-in roles and custom roles.
Built-in roles roles cannot be modified.
Also, the names of built-in roles are reserved words, custom roles are not allowed to use these names to avoid unnecessary confusion.
Built-in roles include:

• SystemAdmin: the system administrator has almost all permissions.
• Replicator: the application permissions collection.
• Dealer: the sales manager has all sold tenant resource permissions
• Admin: the admin has all tenant-wide resource permissions.
• StandardUser: the user all user-wide resource permissions.
• StandardInternationalUser: the user all user-wide resource permissions with international call permissions.
• QueueManager: The call queue manager.

Example: "User"

mobile_phonestring

The mobile phone number of user.

work_phonestring

The office phone number of user.

home_phonestring

The home phone number of user.

addressstring

The address.

departmentstring

The department of user.

extension_number*string

The extension number.

Pattern: [0-9]{3,64}

extension_password*string

The extension password.

enable_audio_recordingboolean

Records all calls and saves audio recordings on server.

enable_video_recordingboolean

Records all calls and saves video recordings on server.

enable_dndboolean

Enable Do Not Disturb or not.

enable_acbboolean

Enable Automatic Callback or not.

enable_hot_deskingboolean

Enable hot desking feature or not.

anonymous_outbound_callsboolean

Always make outbound anonymous calls or not.

smsenum

The preferred configuration for SMS/MMS.
Note: Only users with UserManagement::Users privilege can change this property.

• DISABLE: Disable user SMS/MMS feature.
• DISABLE: Enable user SMS/MMS feature but with outbound caller ID.
• ALLOW_WITH_SENDER_ID: Enable user SMS/MMS but with trunk sender ID.

DISABLEALLOWALLOW_WITH_SENDER_ID

delivery_outbound_cidboolean

Always delivery outbound caller ID or not.

outbound_caller_idsarray of object

A collection of outbound caller IDs.

custom_optionsstring

Some custom configuration options serialized as json string

office_hoursall of

available_office_hours_forward_ruleobject

available_non_office_hours_forward_ruleobject

available_no_answer_forward_ruleobject

busy_office_hours_forward_ruleobject

busy_non_office_hours_forward_ruleobject

busy_no_answer_forward_ruleobject

dnd_office_hours_forward_ruleobject

dnd_non_office_hours_forward_ruleobject

away_office_hours_forward_ruleobject

away_non_office_hours_forward_ruleobject

lunch_office_hours_forward_ruleobject

lunch_non_office_hours_forward_ruleobject

trip_office_hours_forward_ruleobject

trip_non_office_hours_forward_ruleobject

offline_office_hours_forward_ruleobject

offline_non_office_hours_forward_ruleobject

custom_forward_rulesarray of object

voicemail_promptstring

BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US.

Example: "en-US"

enable_voicemail_pinboolean

Whether the PIN is required to access voice mail of extension.

voicemail_pin*string

The PIN number for accessing.
The PIN policies include:

1. A sequence of numbers 6-10 digits in length.
2. No repeating numbers (e.g. "111", "222")
3. No sequential numbers (e.g. "012", "789")

enable_voicemail_notifyboolean

Enable voicemail to email notify.

voicemail_play_datetimeenum

Announces Date and Time of Message.

• DISABLE: Do not read;
• 12_HOUR_CLOCK: Read in 12-hour clock;
• 24_HOUR_CLOCK: Read in 24-hour clock.

DISABLE12_HOUR_CLOCK24_HOUR_CLOCK

interfaceenum

The interface type for QR code or auto provisioning.
Can be neither:

• WEB_DOMAIN:
• PUBLIC_IPV4:
• PUBLIC_IPV6:
• PRIVATE_IPV4:
• PRIVATE_IPV6:
• SBC_DOMAIN:

WEB_DOMAINPUBLIC_IPV4PUBLIC_IPV6PRIVATE_IPV4PRIVATE_IPV6SBC_DOMAIN

preferred_transportenum

The transport protocol:
Can be either:

• UDP:
• TCP:
• TLS:

UDPTCPTLS

blfsarray of object

A collection of BLFs.

Response

2014XX

Created

Body

application/json

idall of

The unique ID of user.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "display_name": "text",
      "password": "text",
      "email": {},
      "role": "User",
      "extension_number": "text",
      "extension_password": "text",
      "voicemail_pin": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": {}
}

Retrieve a user

Retrieves the settings of a user.

GEThttp://127.0.0.1:8888/api/users/{id}

Path parameters

id*all of

The unique ID of user.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of user.

namestring

The user's account name.
Only letters, numbers, and the following special characters can be added: underscore, dash, single quote, and period (_, -, ', and .).
Username cannot start or end with period (.).
admin, system, administrator, and root are reserved names for system admin only with case ignored.

emailall of

The email address of user.

display_namestring

The display name of user.

rolestring

Roles include built-in roles and custom roles.
Built-in roles roles cannot be modified.
Also, the names of built-in roles are reserved words, custom roles are not allowed to use these names to avoid unnecessary confusion.
Built-in roles include:

• SystemAdmin: the system administrator has almost all permissions.
• Replicator: the application permissions collection.
• Dealer: the sales manager has all sold tenant resource permissions
• Admin: the admin has all tenant-wide resource permissions.
• StandardUser: the user all user-wide resource permissions.
• StandardInternationalUser: the user all user-wide resource permissions with international call permissions.
• QueueManager: The call queue manager.

Example: "User"

enabledboolean

Allows temporarily disabling the extension.

mobile_phonestring

The mobile phone number of user.

work_phonestring

The office phone number of user.

home_phonestring

The home phone number of user.

addressstring

The address.

departmentstring

The department of user.

extension_numberstring

The extension number.

Pattern: [0-9]{3,64}

enable_audio_recordingboolean

Records all calls and saves audio recordings on server.

enable_video_recordingboolean

Records all calls and saves video recordings on server.

enable_dndboolean

Enable Do Not Disturb or not.

enable_acbboolean

Enable Automatic Callback or not.

enable_hot_deskingboolean

Enable hot desking feature or not.

anonymous_outbound_callsboolean

Always make outbound anonymous calls or not.

delivery_outbound_cidboolean

Always delivery outbound caller ID or not.

smsenum

The preferred configuration for SMS/MMS.
Note: Only users with UserManagement::Users privilege can change this property.

• DISABLE: Disable user SMS/MMS feature.
• DISABLE: Enable user SMS/MMS feature but with outbound caller ID.
• ALLOW_WITH_SENDER_ID: Enable user SMS/MMS but with trunk sender ID.

DISABLEALLOWALLOW_WITH_SENDER_ID

outbound_caller_idsarray of object

A collection of outbound caller IDs.

custom_optionsstring

Some custom configuration options serialized as json string

office_hoursall of

available_office_hours_forward_ruleobject

available_non_office_hours_forward_ruleobject

available_no_answer_forward_ruleobject

busy_office_hours_forward_ruleobject

busy_non_office_hours_forward_ruleobject

busy_no_answer_forward_ruleobject

dnd_office_hours_forward_ruleobject

dnd_non_office_hours_forward_ruleobject

away_office_hours_forward_ruleobject

away_non_office_hours_forward_ruleobject

lunch_office_hours_forward_ruleobject

lunch_non_office_hours_forward_ruleobject

trip_office_hours_forward_ruleobject

trip_non_office_hours_forward_ruleobject

offline_office_hours_forward_ruleobject

offline_non_office_hours_forward_ruleobject

custom_forward_rulesarray of object

voicemail_promptstring

BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US.

Example: "en-US"

enable_voicemail_pinboolean

Whether the PIN is required to access voice mail of extension.

voicemail_pinstring

The PIN number for accessing.
The PIN policies include:

1. A sequence of numbers 6-10 digits in length.
2. No repeating numbers (e.g. "111", "222")
3. No sequential numbers (e.g. "012", "789")

enable_voicemail_notifyboolean

Enable voicemail to email notify.

voicemail_play_datetimeenum

Announces Date and Time of Message.

• DISABLE: Do not read;
• 12_HOUR_CLOCK: Read in 12-hour clock;
• 24_HOUR_CLOCK: Read in 24-hour clock.

DISABLE12_HOUR_CLOCK24_HOUR_CLOCK

interfaceenum

The interface type for QR code or auto provisioning.
Can be neither:

• WEB_DOMAIN:
• PUBLIC_IPV4:
• PUBLIC_IPV6:
• PRIVATE_IPV4:
• PRIVATE_IPV6:
• SBC_DOMAIN:

WEB_DOMAINPUBLIC_IPV4PUBLIC_IPV6PRIVATE_IPV4PRIVATE_IPV6SBC_DOMAIN

preferred_transportenum

The transport protocol:
Can be either:

• UDP:
• TCP:
• TLS:

UDPTCPTLS

blfsarray of object

A collection of BLFs.

profileall of

The unique ID of user profile file.

created_atall of

The creation time of user.

avatar_file_namestring

The name of the file.

avatar_file_sizeinteger (int64)

The file size in bytes.

Example: 0

avatar_file_urlstring

The relative path to file url for file downloading.

Example: "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"

sync_typeenum

The synchronization method.
Can be either:

• Microsoft 365: Sync from Microsoft 365.

Microsoft 365

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/users/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": {},
  "name": "text",
  "email": {},
  "display_name": "text",
  "role": "User",
  "enabled": true,
  "mobile_phone": "text",
  "work_phone": "text",
  "home_phone": "text",
  "address": "text",
  "department": "text",
  "extension_number": "text",
  "enable_audio_recording": false,
  "enable_video_recording": false,
  "enable_dnd": false,
  "enable_acb": false,
  "enable_hot_desking": false,
  "anonymous_outbound_calls": false,
  "delivery_outbound_cid": true,
  "sms": "DISABLE",
  "outbound_caller_ids": [
    {
      "provider_id": {},
      "caller_id": {},
      "description": "text"
    }
  ],
  "custom_options": "text",
  "office_hours": {
    "mode": "CUSTOM",
    "monday": {
      "enabled": false,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "tuesday": {
      "enabled": false,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "wednesday": {
      "enabled": false,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "thursday": {
      "enabled": false,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "friday": {
      "enabled": false,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "saturday": {
      "enabled": false,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "sunday": {
      "enabled": false,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    }
  },
  "available_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "available_non_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "available_no_answer_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text",
    "timeout": 60
  },
  "busy_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "busy_non_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "busy_no_answer_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text",
    "timeout": 60
  },
  "dnd_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "dnd_non_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "away_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "away_non_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "lunch_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "lunch_non_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "trip_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "trip_non_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "offline_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "offline_non_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "custom_forward_rules": [
    {
      "action": "FORWARD_TO_NUMBER",
      "number": "text",
      "caller_id": "text",
      "type": "ALL_HOURS",
      "hours": {
        "monday": {
          "enabled": false,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "tuesday": {
          "enabled": false,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "wednesday": {
          "enabled": false,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "thursday": {
          "enabled": false,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "friday": {
          "enabled": false,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "saturday": {
          "enabled": false,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "sunday": {
          "enabled": false,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        }
      }
    }
  ],
  "voicemail_prompt": "en-US",
  "enable_voicemail_pin": true,
  "voicemail_pin": "text",
  "enable_voicemail_notify": false,
  "voicemail_play_datetime": "DISABLE",
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP",
  "blfs": [
    {
      "key": "text",
      "value": "text",
      "first_name": "text",
      "last_name": "text"
    }
  ],
  "profile": {},
  "created_at": {},
  "avatar_file_name": "text",
  "avatar_file_size": 0,
  "avatar_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
  "sync_type": "Microsoft 365"
}

Update a user

Modify the settings of a user.

POSThttp://127.0.0.1:8888/api/users/{id}

Path parameters

id*all of

The unique ID of user.

Body

application/json

emailall of

The email address of user.

display_namestring

The display name of user.

enabledboolean

Allows temporarily disabling the extension.

mobile_phonestring

The mobile phone number of user.

work_phonestring

The office phone number of user.

home_phonestring

The home phone number of user.

addressstring

The address.

departmentstring

The department of user.

enable_audio_recordingboolean

Records all calls and saves audio recordings on server.

enable_video_recordingboolean

Records all calls and saves video recordings on server.

enable_dndboolean

Enable Do Not Disturb or not.

enable_acbboolean

Enable Automatic Callback or not.

enable_hot_deskingboolean

Enable hot desking feature or not.

anonymous_outbound_callsboolean

Always make outbound anonymous calls or not.

delivery_outbound_cidboolean

Always delivery outbound caller ID or not.

smsenum

The preferred configuration for SMS/MMS.
Note: Only users with UserManagement::Users privilege can change this property.

• DISABLE: Disable user SMS/MMS feature.
• DISABLE: Enable user SMS/MMS feature but with outbound caller ID.
• ALLOW_WITH_SENDER_ID: Enable user SMS/MMS but with trunk sender ID.

DISABLEALLOWALLOW_WITH_SENDER_ID

outbound_caller_idsarray of object

A collection of outbound caller IDs.

custom_optionsstring

Some custom configuration options serialized as json string

office_hoursall of

available_office_hours_forward_ruleobject

available_non_office_hours_forward_ruleobject

available_no_answer_forward_ruleobject

busy_office_hours_forward_ruleobject

busy_non_office_hours_forward_ruleobject

busy_no_answer_forward_ruleobject

dnd_office_hours_forward_ruleobject

dnd_non_office_hours_forward_ruleobject

away_office_hours_forward_ruleobject

away_non_office_hours_forward_ruleobject

lunch_office_hours_forward_ruleobject

lunch_non_office_hours_forward_ruleobject

trip_office_hours_forward_ruleobject

trip_non_office_hours_forward_ruleobject

offline_office_hours_forward_ruleobject

offline_non_office_hours_forward_ruleobject

custom_forward_rulesarray of object

voicemail_promptstring

BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US.

Example: "en-US"

enable_voicemail_pinboolean

Whether the PIN is required to access voice mail of extension.

voicemail_pinstring

The PIN number for accessing.
The PIN policies include:

1. A sequence of numbers 6-10 digits in length.
2. No repeating numbers (e.g. "111", "222")
3. No sequential numbers (e.g. "012", "789")

enable_voicemail_notifyboolean

Enable voicemail to email notify.

voicemail_play_datetimeenum

Announces Date and Time of Message.

• DISABLE: Do not read;
• 12_HOUR_CLOCK: Read in 12-hour clock;
• 24_HOUR_CLOCK: Read in 24-hour clock.

DISABLE12_HOUR_CLOCK24_HOUR_CLOCK

interfaceenum

The interface type for QR code or auto provisioning.
Can be neither:

• WEB_DOMAIN:
• PUBLIC_IPV4:
• PUBLIC_IPV6:
• PRIVATE_IPV4:
• PRIVATE_IPV6:
• SBC_DOMAIN:

WEB_DOMAINPUBLIC_IPV4PUBLIC_IPV6PRIVATE_IPV4PRIVATE_IPV6SBC_DOMAIN

preferred_transportenum

The transport protocol:
Can be either:

• UDP:
• TCP:
• TLS:

UDPTCPTLS

blfsarray of object

A collection of BLFs.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/users/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();