Users | PortSIP Knowledge Base

List roles

get

List a collection of roles.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/roles

GET /api/roles HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "name": "User",
      "description": "text"
    }
  ]
}

Create a role

post

Create a new role.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestring · min: 1 · max: 64Required

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

descriptionstring · max: 1024Optional

Role's description.

Responses

201

OK

application/json

4XX

Error

post

/roles

POST /api/roles HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 900

{
  "name": "User",
  "permissions": {
    "general": {
      "voicemail_view_only": false,
      "voicemail_full_access": false,
      "meeting": false
    },
    "system": {
      "information": false,
      "dealer": false,
      "tenant": false
    },
    "trunk": {
      "view_only": false,
      "full_access": false
    },
    "company": {
      "view_only": false,
      "full_access": false
    },
    "company_call_log": {
      "call_log_view_only": false,
      "call_log_full_access": false,
      "call_recording_view_only": false,
      "call_recording_full_access": false
    },
    "phone_system": {
      "view_only": false,
      "full_access": false
    },
    "user_management": {
      "roles": false,
      "users": false
    },
    "user_call_log": {
      "call_log_view_only": false,
      "call_log_full_access": false,
      "call_recording_view_only": false,
      "call_recording_full_access": false
    },
    "policies": {
      "domestic_calls": false,
      "internal_calls": false,
      "international_calls": false
    },
    "analytics": {
      "call_report_view_only": false,
      "call_report_full_access": false
    },
    "billing": {
      "view_only": false,
      "full_access": false
    }
  },
  "description": "text"
}

{
  "name": "User"
}

Retrieve a role

get

Retrieves the settings of a role.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestring · min: 1 · max: 64Required

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

Responses

200

OK

application/json

namestring · min: 1 · max: 64Optional

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

descriptionstring · max: 1024Optional

Role's description.

4XX

Error

get

/roles/{name}

GET /api/roles/{name} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "User",
  "permissions": {
    "general": {
      "voicemail_view_only": false,
      "voicemail_full_access": false,
      "meeting": false
    },
    "system": {
      "information": false,
      "dealer": false,
      "tenant": false
    },
    "trunk": {
      "view_only": false,
      "full_access": false
    },
    "company": {
      "view_only": false,
      "full_access": false
    },
    "company_call_log": {
      "call_log_view_only": false,
      "call_log_full_access": false,
      "call_recording_view_only": false,
      "call_recording_full_access": false
    },
    "phone_system": {
      "view_only": false,
      "full_access": false
    },
    "user_management": {
      "roles": false,
      "users": false
    },
    "user_call_log": {
      "call_log_view_only": false,
      "call_log_full_access": false,
      "call_recording_view_only": false,
      "call_recording_full_access": false
    },
    "policies": {
      "domestic_calls": false,
      "internal_calls": false,
      "international_calls": false
    },
    "analytics": {
      "call_report_view_only": false,
      "call_report_full_access": false
    },
    "billing": {
      "view_only": false,
      "full_access": false
    }
  },
  "description": "text"
}

Update a role

post

Modify the settings of a role.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestring · min: 1 · max: 64Required

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

Body

namestring · min: 1 · max: 64Optional

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

descriptionstring · max: 1024Optional

Role's description.

Responses

200

OK

No content

4XX

Error

post

/roles/{name}

POST /api/roles/{name} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 900

{
  "name": "User",
  "permissions": {
    "general": {
      "voicemail_view_only": false,
      "voicemail_full_access": false,
      "meeting": false
    },
    "system": {
      "information": false,
      "dealer": false,
      "tenant": false
    },
    "trunk": {
      "view_only": false,
      "full_access": false
    },
    "company": {
      "view_only": false,
      "full_access": false
    },
    "company_call_log": {
      "call_log_view_only": false,
      "call_log_full_access": false,
      "call_recording_view_only": false,
      "call_recording_full_access": false
    },
    "phone_system": {
      "view_only": false,
      "full_access": false
    },
    "user_management": {
      "roles": false,
      "users": false
    },
    "user_call_log": {
      "call_log_view_only": false,
      "call_log_full_access": false,
      "call_recording_view_only": false,
      "call_recording_full_access": false
    },
    "policies": {
      "domestic_calls": false,
      "internal_calls": false,
      "international_calls": false
    },
    "analytics": {
      "call_report_view_only": false,
      "call_report_full_access": false
    },
    "billing": {
      "view_only": false,
      "full_access": false
    }
  },
  "description": "text"
}

No content

Delete a role

post

Delete a certain role.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestring · min: 1 · max: 64Required

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

Responses

204

No Content

4XX

Error

post

/roles/{name}/destroy

POST /api/roles/{name}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retrieve current user

get

Retrieve details of current user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

idall ofOptional

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

namestring · min: 1 · max: 64Optional

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 ofOptional

The email address of user.

string · max: 128Optional

The email address.

Example: [email protected]

display_namestring · max: 1024Optional

The display name of user.

rolestring · min: 1 · max: 64Optional

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

enabledbooleanOptional

Allows temporarily disabling the extension.

Default: true

mobile_phonestring · max: 32Optional

The mobile phone number of user.

work_phonestring · max: 32Optional

The office phone number of user.

home_phonestring · max: 32Optional

The home phone number of user.

addressstring · max: 128Optional

The address.

departmentstring · max: 128Optional

The department of user.

extension_numberstring · min: 3 · max: 64Optional

The extension number.

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

enable_audio_recordingbooleanOptional

Records all calls and saves audio recordings on server.

Default: false

enable_video_recordingbooleanOptional

Records all calls and saves video recordings on server.

Default: false

enable_dndbooleanOptional

Enable Do Not Disturb or not.

enable_acbbooleanOptional

Enable Automatic Callback or not.

enable_hot_deskingbooleanOptional

Enable hot desking feature or not.

Default: false

anonymous_outbound_callsbooleanOptional

Always make outbound anonymous calls or not.

Default: false

delivery_outbound_cidbooleanOptional

Always delivery outbound caller ID or not.

Default: true

smsstring · enumOptional

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

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

Default: DISABLEPossible values:

custom_optionsstringOptional

Some custom configuration options serialized as json string

voicemail_promptstringOptional

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_pinbooleanOptional

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

Default: true

voicemail_pinstring · min: 6 · max: 10Optional

The PIN number for accessing.
The PIN policies include:

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

enable_voicemail_notifybooleanOptional

Enable voicemail to email notify.

Default: false

voicemail_play_datetimestring · enumOptional

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.

Possible values:

interfacestring · enumOptional

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

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

Possible values:

preferred_transportstring · enumOptional

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Possible values:

created_atall ofOptional

The creation time of user.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

avatar_file_namestringOptional

The name of the file.

avatar_file_sizeinteger · int64Optional

The file size in bytes.

Example: 0

avatar_file_urlstringRead-onlyOptional

The relative path to file url for file downloading.

Example: /api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK

profileall ofOptional

The unique ID of user profile file.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

sync_typestring · enumOptional

The synchronization method.
Can be either:

Microsoft 365: Sync from Microsoft 365.

Possible values:

4XX

Error

get

/user

GET /api/user HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "email": "[email protected]",
  "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": true,
  "enable_acb": true,
  "enable_hot_desking": false,
  "anonymous_outbound_calls": false,
  "delivery_outbound_cid": true,
  "sms": "DISABLE",
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "preferred": true,
      "description": "text"
    }
  ],
  "custom_options": "text",
  "office_hours": {
    "mode": "CUSTOM",
    "monday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "tuesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "wednesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "thursday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "friday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "saturday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "sunday": {
      "enabled": true,
      "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": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "tuesday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "wednesday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "thursday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "friday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "saturday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "sunday": {
          "enabled": true,
          "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"
    }
  ],
  "created_at": "2017-07-21T17:32:28Z",
  "avatar_file_name": "text",
  "avatar_file_size": 0,
  "avatar_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
  "transports": [
    {
      "protocol": "UDP",
      "port": 80,
      "verification": "DISABLE"
    }
  ],
  "profile": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "sync_type": "Microsoft 365"
}

Update current user properties.

post

Update current user properties.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

emailall ofOptional

The email address of user.

string · max: 128Optional

The email address.

Example: [email protected]

display_namestring · max: 1024Optional

The display name of user.

mobile_phonestring · max: 32Optional

The mobile phone number of user.

work_phonestring · max: 32Optional

The office phone number of user.

home_phonestring · max: 32Optional

The home phone number of user.

addressstring · max: 128Optional

The address.

departmentstring · max: 128Optional

The department of user.

enable_audio_recordingbooleanOptional

Records all calls and saves audio recordings on server.

Default: false

enable_video_recordingbooleanOptional

Records all calls and saves video recordings on server.

Default: false

enable_dndbooleanOptional

Enable Do Not Disturb or not.

enable_acbbooleanOptional

Enable Automatic Callback or not.

enable_hot_deskingbooleanOptional

Enable hot desking feature or not.

Default: false

anonymous_outbound_callsbooleanOptional

Always make outbound anonymous calls or not.

Default: false

delivery_outbound_cidbooleanOptional

Always delivery outbound caller ID or not.

Default: true

smsstring · enumOptional

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

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

Default: DISABLEPossible values:

custom_optionsstringOptional

Some custom configuration options serialized as json string

voicemail_promptstringOptional

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_pinbooleanOptional

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

Default: true

voicemail_pinstring · min: 6 · max: 10Optional

The PIN number for accessing.
The PIN policies include:

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

enable_voicemail_notifybooleanOptional

Enable voicemail to email notify.

Default: false

voicemail_play_datetimestring · enumOptional

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.

Possible values:

interfacestring · enumOptional

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

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

Possible values:

preferred_transportstring · enumOptional

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Possible values:

avatar_file_idall ofOptional

The unique ID of the file.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/user

POST /api/user HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3280

{
  "email": "[email protected]",
  "display_name": "text",
  "mobile_phone": "text",
  "work_phone": "text",
  "home_phone": "text",
  "address": "text",
  "department": "text",
  "enable_audio_recording": false,
  "enable_video_recording": false,
  "enable_dnd": true,
  "enable_acb": true,
  "enable_hot_desking": false,
  "anonymous_outbound_calls": false,
  "delivery_outbound_cid": true,
  "sms": "DISABLE",
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "preferred": true,
      "description": "text"
    }
  ],
  "custom_options": "text",
  "office_hours": {
    "mode": "CUSTOM",
    "monday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "tuesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "wednesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "thursday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "friday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "saturday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "sunday": {
      "enabled": true,
      "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": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "tuesday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "wednesday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "thursday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "friday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "saturday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "sunday": {
          "enabled": true,
          "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"
    }
  ],
  "avatar_file_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

No content

Reset current user password

post

Reset current user password.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

old_passwordstringOptional

The password of user.

new_passwordstringOptional

The password of user.

Responses

200

OK

No content

4XX

Error

post

/user/password

POST /api/user/password HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "old_password": "text",
  "new_password": "text"
}

No content

Reset current user extension password

post

Reset current user extension password.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

old_passwordstringOptional

The extension password.

new_passwordstringOptional

The extension password.

Responses

200

OK

No content

4XX

Error

post

/user/extension_password

POST /api/user/extension_password HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "old_password": "text",
  "new_password": "text"
}

No content

Reset current user profile

post

Reset current user profile.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

No content

4XX

Error

post

/user/profile

POST /api/user/profile HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retrieves current user status

get

Get status of current user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

statusstring · enumOptional

Status of extension:

ONLINE
ON_CALL
OFFLINE

Possible values:

presencestring · enumOptional

The current presence of extension:

DO_NOT_DISTURB:
AVAILABLE:
AWAY:
BUSINESS_TRIP:
LUNCH:
ON_CALL
OFFLINE

Possible values:

presence_notestring · max: 128Optional

The presence note.

enable_dndbooleanOptional

Do Not Disturb enabled or not.

enable_acbbooleanOptional

Automatic Callback enabled or not.

4XX

Error

get

/user/status

GET /api/user/status HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "ONLINE",
  "presence": "DO_NOT_DISTURB",
  "presence_note": "text",
  "registration": [
    {
      "instance_id": "text",
      "user_agent": "text",
      "application": "text",
      "ip": "text",
      "enable_push": true,
      "contact_address": "text"
    }
  ],
  "enable_dnd": true,
  "enable_acb": true
}

Set current extension user presence

post

Set current extension user presence.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

presencestring · enumOptional

The specified presence of extension:

DO_NOT_DISTURB:
AVAILABLE:
AWAY:
BUSINESS_TRIP:
LUNCH:

Possible values:

presence_notestring · max: 128Optional

The presence note.

Responses

200

OK

No content

4XX

Error

post

/user/presence

POST /api/user/presence HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "presence": "DO_NOT_DISTURB",
  "presence_note": "text"
}

No content

Retrieve current user balance.

get

Retrieve current user's balance.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

balancenumber · doubleOptional

User balance. Precision is five digits.

4XX

Error

get

/user/balance

GET /api/user/balance HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "balance": 1
}

List current user voicemail greetings

get

Retrieves a collection of greetings for current user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/user/greetings

GET /api/user/greetings HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "enabled": true,
      "file_name": "text",
      "file_size": 0,
      "file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
    }
  ]
}

Create voicemail greeting for current user

post

Create voicemail greeting for current user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

file_idall ofOptional

The unique ID of the file.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

201

OK

application/json

4XX

Error

post

/user/greetings

POST /api/user/greetings HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "file_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Enable one of current user's greetings.

post

Set one of current user's greetings to activated state.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of greeting.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

400

Invalid extension number supplied

404

User not found

post

/user/greetings/{id}/enable

POST /api/user/greetings/{id}/enable HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Disable current user greeting

post

Disable current user voicemail greeting by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of greeting.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

400

Invalid extension number supplied

404

User not found

post

/user/greetings/{id}/disable

POST /api/user/greetings/{id}/disable HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete voicemail greeting

post

Destroy a voicemail greeting from user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of greeting.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/user/greetings/{id}/destroy

POST /api/user/greetings/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List current user's IP phones

get

Retrieve a collection of IP Phones for current user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/user/phones

GET /api/user/phones HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "mac": "text",
      "filename": "text",
      "vendor": "text",
      "model": "text",
      "fwver": "text",
      "password": "text",
      "language": "ENGLISH",
      "transfer": "BLIND",
      "timezone": "text",
      "ringtone": "text",
      "queue_ringtone": "text",
      "external_ringtone": "text",
      "date_format": "text",
      "time_format": "text",
      "powerled": "text",
      "backlight": "text",
      "screensaver": "text",
      "rps": true,
      "https": true,
      "codecs": [
        "text"
      ],
      "enable_lldp": false,
      "enable_vlan_wan_port": false,
      "wan_port_id": 1,
      "wan_port_priority": 1,
      "enable_vlan_pc_port": false,
      "pc_port_id": 1,
      "pc_port_priority": 1,
      "interface": "WEB_DOMAIN",
      "preferred_transport": "UDP",
      "serial_number": "text",
      "door_password1": "text",
      "door_password2": "text",
      "url": "text"
    }
  ]
}

Assign phone to current user

post

Assign a phone to current user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

macall ofRequired

MAC address of this IP phone.

stringOptional

MAC address.

filenamestringRequired

Template XML file name for phone provisioning.

vendorstringRequired

The phone vendor of IP phone.

modelstringRequired

The name of IP phone model.

passwordstringRequired

Password for accessing the Web interface of phone. The username remains default because most phone manufacturers do not allow modification of the user name. This is supported for some phone model, such as "Snom 300".

languagestring · enumRequired

Language for strings displayed on Phone Display LCD. Supported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.

Possible values:

transferstring · enumRequired

The transfer method for auto provision.
Can be either:

BLIND: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will directly initiate a Blind transfer to the configured number.
ATTENDED: After the IP phone is configured with the BLF of a key, during a call on the IP phone, press the key, and the phone will directly initiate an Attended transfer to the configured number.
NEW_CALL: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will initiate a new call to the configured number.

Default: BLINDPossible values:

timezonestringRequired

The timezone of phone.

ringtonestringOptional

The ringtone of phone.

queue_ringtonestringOptional

The queue ringtone of phone for queue calls or ring group calls.

external_ringtonestringOptional

The ringtone of phone for external calls.

date_formatstringOptional

The date format of phone.

time_formatstringOptional

The time format of phone.

powerledstringOptional

The power led of phone.

backlightstringOptional

The backlight of phone.

screensaverstringOptional

The screensaver of phone.

rpsbooleanOptional

Send to RPS or not.

httpsbooleanOptional

Whether to use https

codecsstring[]Required

Settings for the priority of the codecs in this phone. This indicates the first preferred codec.

enable_lldpbooleanOptional

Enable or disable Link Layer Discovery Protocol.

Default: false

enable_vlan_wan_portbooleanOptional

Enable or disable VLAN for WAN Port.

Default: false

wan_port_idinteger · min: 1 · max: 4094Optional

VLAN ID for WAN PORT.

wan_port_priorityinteger · max: 7Optional

VLAN priority for WAN Port.

enable_vlan_pc_portbooleanOptional

Enable or disable VLAN for PC Port.

Default: false

pc_port_idinteger · min: 1 · max: 4094Optional

VLAN ID for PC PORT.

pc_port_priorityinteger · max: 7Optional

VLAN priority for PC Port.

interfacestring · enumRequired

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

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

Possible values:

preferred_transportstring · enumRequired

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Possible values:

serial_numberstringOptional

The serial number of phone.

door_password1string · min: 4 · max: 8Optional

The primary door password of phone. Only numeric sequences are allowed.

door_password2string · min: 4 · max: 8Optional

The secondary door password of phone. Only numeric sequences are allowed.

Responses

201

Success

application/json

4XX

Error

post

/user/phones

POST /api/user/phones HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 625

{
  "mac": "text",
  "filename": "text",
  "vendor": "text",
  "model": "text",
  "password": "text",
  "language": "ENGLISH",
  "transfer": "BLIND",
  "timezone": "text",
  "ringtone": "text",
  "queue_ringtone": "text",
  "external_ringtone": "text",
  "date_format": "text",
  "time_format": "text",
  "powerled": "text",
  "backlight": "text",
  "screensaver": "text",
  "rps": true,
  "https": true,
  "codecs": [
    "text"
  ],
  "enable_lldp": false,
  "enable_vlan_wan_port": false,
  "wan_port_id": 1,
  "wan_port_priority": 1,
  "enable_vlan_pc_port": false,
  "pc_port_id": 1,
  "pc_port_priority": 1,
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP",
  "serial_number": "text",
  "door_password1": "text",
  "door_password2": "text"
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve current user phone details

get

Retrieve phone details of current user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

macall ofOptional

MAC address of this IP phone.

stringOptional

MAC address.

filenamestringOptional

Template XML file name for phone provisioning.

vendorstringOptional

The phone vendor of IP phone.

modelstringOptional

The name of IP phone model.

passwordstringOptional

Password for accessing the Web interface of phone. The username remains default because most phone manufacturers do not allow modification of the user name. This is supported for some phone model, such as "Snom 300".

languagestring · enumOptional

Language for strings displayed on Phone Display LCD. Supported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.

Possible values:

transferstring · enumOptional

The transfer method for auto provision.
Can be either:

BLIND: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will directly initiate a Blind transfer to the configured number.
ATTENDED: After the IP phone is configured with the BLF of a key, during a call on the IP phone, press the key, and the phone will directly initiate an Attended transfer to the configured number.
NEW_CALL: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will initiate a new call to the configured number.

Default: BLINDPossible values:

timezonestringOptional

The timezone of phone.

ringtonestringOptional

The ringtone of phone.

queue_ringtonestringOptional

The queue ringtone of phone for queue calls or ring group calls.

external_ringtonestringOptional

The ringtone of phone for external calls.

date_formatstringOptional

The date format of phone.

time_formatstringOptional

The time format of phone.

powerledstringOptional

The power led of phone.

backlightstringOptional

The backlight of phone.

screensaverstringOptional

The screensaver of phone.

rpsbooleanOptional

Send to RPS or not.

httpsbooleanOptional

Whether to use https

codecsstring[]Optional

Settings for the priority of the codecs in this phone. This indicates the first preferred codec.

enable_lldpbooleanOptional

Enable or disable Link Layer Discovery Protocol.

Default: false

enable_vlan_wan_portbooleanOptional

Enable or disable VLAN for WAN Port.

Default: false

wan_port_idinteger · min: 1 · max: 4094Optional

VLAN ID for WAN PORT.

wan_port_priorityinteger · max: 7Optional

VLAN priority for WAN Port.

enable_vlan_pc_portbooleanOptional

Enable or disable VLAN for PC Port.

Default: false

pc_port_idinteger · min: 1 · max: 4094Optional

VLAN ID for PC PORT.

pc_port_priorityinteger · max: 7Optional

VLAN priority for PC Port.

interfacestring · enumOptional

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

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

Possible values:

preferred_transportstring · enumOptional

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Possible values:

serial_numberstringOptional

The serial number of phone.

door_password1string · min: 4 · max: 8Optional

The primary door password of phone. Only numeric sequences are allowed.

door_password2string · min: 4 · max: 8Optional

The secondary door password of phone. Only numeric sequences are allowed.

urlstringOptional

Auto provision server URL.

4XX

Error

get

/user/phones/{id}

GET /api/user/phones/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "mac": "text",
  "filename": "text",
  "vendor": "text",
  "model": "text",
  "password": "text",
  "language": "ENGLISH",
  "transfer": "BLIND",
  "timezone": "text",
  "ringtone": "text",
  "queue_ringtone": "text",
  "external_ringtone": "text",
  "date_format": "text",
  "time_format": "text",
  "powerled": "text",
  "backlight": "text",
  "screensaver": "text",
  "rps": true,
  "https": true,
  "codecs": [
    "text"
  ],
  "enable_lldp": false,
  "enable_vlan_wan_port": false,
  "wan_port_id": 1,
  "wan_port_priority": 1,
  "enable_vlan_pc_port": false,
  "pc_port_id": 1,
  "pc_port_priority": 1,
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP",
  "serial_number": "text",
  "door_password1": "text",
  "door_password2": "text",
  "url": "text"
}

Update a phone of current user

post

Update phone of current user by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

passwordstringOptional

Password for accessing the Web interface of phone. The username remains default because most phone manufacturers do not allow modification of the user name. This is supported for some phone model, such as "Snom 300".

languagestring · enumOptional

Language for strings displayed on Phone Display LCD. Supported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.

Possible values:

transferstring · enumOptional

The transfer method for auto provision.
Can be either:

BLIND: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will directly initiate a Blind transfer to the configured number.
ATTENDED: After the IP phone is configured with the BLF of a key, during a call on the IP phone, press the key, and the phone will directly initiate an Attended transfer to the configured number.
NEW_CALL: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will initiate a new call to the configured number.

Default: BLINDPossible values:

timezonestringOptional

The timezone of phone.

ringtonestringOptional

The ringtone of phone.

queue_ringtonestringOptional

The queue ringtone of phone for queue calls or ring group calls.

external_ringtonestringOptional

The ringtone of phone for external calls.

date_formatstringOptional

The date format of phone.

time_formatstringOptional

The time format of phone.

powerledstringOptional

The power led of phone.

backlightstringOptional

The backlight of phone.

screensaverstringOptional

The screensaver of phone.

rpsbooleanOptional

Send to RPS or not.

httpsbooleanOptional

Whether to use https

codecsstring[]Optional

Settings for the priority of the codecs in this phone. This indicates the first preferred codec.

enable_lldpbooleanOptional

Enable or disable Link Layer Discovery Protocol.

Default: false

enable_vlan_wan_portbooleanOptional

Enable or disable VLAN for WAN Port.

Default: false

wan_port_idinteger · min: 1 · max: 4094Optional

VLAN ID for WAN PORT.

wan_port_priorityinteger · max: 7Optional

VLAN priority for WAN Port.

enable_vlan_pc_portbooleanOptional

Enable or disable VLAN for PC Port.

Default: false

pc_port_idinteger · min: 1 · max: 4094Optional

VLAN ID for PC PORT.

pc_port_priorityinteger · max: 7Optional

VLAN priority for PC Port.

interfacestring · enumOptional

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

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

Possible values:

preferred_transportstring · enumOptional

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Possible values:

serial_numberstringOptional

The serial number of phone.

door_password1string · min: 4 · max: 8Optional

The primary door password of phone. Only numeric sequences are allowed.

door_password2string · min: 4 · max: 8Optional

The secondary door password of phone. Only numeric sequences are allowed.

Responses

200

OK

No content

4XX

Error

post

/user/phones/{id}

POST /api/user/phones/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 563

{
  "password": "text",
  "language": "ENGLISH",
  "transfer": "BLIND",
  "timezone": "text",
  "ringtone": "text",
  "queue_ringtone": "text",
  "external_ringtone": "text",
  "date_format": "text",
  "time_format": "text",
  "powerled": "text",
  "backlight": "text",
  "screensaver": "text",
  "rps": true,
  "https": true,
  "codecs": [
    "text"
  ],
  "enable_lldp": false,
  "enable_vlan_wan_port": false,
  "wan_port_id": 1,
  "wan_port_priority": 1,
  "enable_vlan_pc_port": false,
  "pc_port_id": 1,
  "pc_port_priority": 1,
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP",
  "serial_number": "text",
  "door_password1": "text",
  "door_password2": "text"
}

No content

Remove a phone of current user

post

Remove a phone profile from current user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/user/phones/{id}/destroy

POST /api/user/phones/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List user call detail records

get

Retrieve a collection of user call detail records.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/user/cdrs

GET /api/user/cdrs HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller": "text",
      "caller_domain": "text",
      "caller_display_name": "text",
      "callee": "text",
      "callee_domain": "text",
      "callee_display_name": "text",
      "started_at": "2017-07-21T17:32:28Z",
      "rang_at": "2017-07-21T17:32:28Z",
      "answered_at": "2017-07-21T17:32:28Z",
      "ended_at": "2017-07-21T17:32:28Z",
      "call_id": "text",
      "direction": "INBOUND_CALL",
      "end_reason": "CALLER_DISCONNECTED",
      "reroute_reason": "TRANSFER",
      "status_code": 1,
      "destination": "text",
      "outbound_caller_id": "text",
      "did_cid": "text",
      "trunk": "text",
      "duration": 1,
      "service_number": "text",
      "user_data": "text"
    }
  ]
}

Retrieve user call detail record

get

Retrieve user call detail record.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of CDR.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/user/cdrs/{id}

GET /api/user/cdrs/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": {
    "caller": "text",
    "caller_domain": "text",
    "caller_display_name": "text",
    "callee": "text",
    "callee_domain": "text",
    "callee_display_name": "text",
    "started_at": "2017-07-21T17:32:28Z",
    "rang_at": "2017-07-21T17:32:28Z",
    "answered_at": "2017-07-21T17:32:28Z",
    "ended_at": "2017-07-21T17:32:28Z",
    "call_id": "text",
    "direction": "INBOUND_CALL",
    "end_reason": "CALLER_DISCONNECTED",
    "reroute_reason": "TRANSFER",
    "status_code": 1,
    "destination": "text",
    "outbound_caller_id": "text",
    "did_cid": "text",
    "trunk": "text",
    "cost": 1,
    "billed_account": "text",
    "service_number": "text",
    "user_data": "text"
  }
}

Create new personal cdr sync token

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

date_fromstring · date_timeOptional

The start time sync token in RFC 3339 format, for example, 2017-07-21T17:32:28Z. The RFC 3339 format is defined by RFC 3339, section 5.6

Example: 2017-07-21T17:32:28Z

Responses

201

Created

application/json

4XX

Error

post

/user/cdrs/sync_tokens

POST /api/user/cdrs/sync_tokens HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo."
}

List personal cdr changes

post

List personal cdr changes.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tokenstringRequired

The sync token.
Clients should treat the sync token as an opaque string and should never try to assemble it.
This document imposes no constraints on the format and clients should never impose any.

Example: RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo.

Responses

200

OK

application/json

tokenstringOptional

The sync token.
Clients should treat the sync token as an opaque string and should never try to assemble it.
This document imposes no constraints on the format and clients should never impose any.

Example: RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo.

4XX

Error

post

/user/cdrs/sync_tokens/{token}/diff

POST /api/user/cdrs/sync_tokens/{token}/diff HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo.",
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "change_type": "CREATED",
      "items": [
        {
          "caller": "text",
          "callee": "text",
          "started_at": "2017-07-21T17:32:28Z",
          "answered_at": "2017-07-21T17:32:28Z",
          "ended_at": "2017-07-21T17:32:28Z",
          "outbound_caller_id": "text",
          "did_cid": "text",
          "trunk": "text",
          "status_code": 1
        }
      ]
    }
  ]
}

List user external messages

get

Retrieve a collection of user external messages.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/user/external_messages

GET /api/user/external_messages HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "config_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "sender": "text",
      "sender_name": "text",
      "receiver": "text",
      "receiver_name": "text",
      "channel_name": "text",
      "channel_number": "text",
      "brand": "text",
      "did": "text",
      "msg_type": "UNKNOWN",
      "direction": "IN",
      "content": "text",
      "reason": "text",
      "delivery": "ERR",
      "provider_msg_id": "text",
      "created_at": "2017-07-21T17:32:28Z"
    }
  ]
}

Retrieve user external message

get

Retrieve user external message.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of external message.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of external message.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

config_idall ofOptional

The unique ID of external message.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

senderstringOptional

The sender number of the message.

sender_namestringOptional

The sender name of the message.

receiverstringOptional

The receiver number of the message.

receiver_namestringOptional

The receiver name of the message.

channel_namestringOptional

The channel name of the message.

channel_numberstringOptional

The channel number of the message.

brandstringOptional

The brand of the message.

didstringOptional

The did of the message.

msg_typestring · enumOptional

The type of message:
Can be either:

UNKNOWN:
SMS:
WHATSAPP:

Possible values:

directionstring · enumOptional

The direction of message:

IN:
OUT:

Possible values:

contentstringOptional

The content of the message.

reasonstringOptional

The reason of the message.

deliverystring · enumOptional

The delivery status of message:
Can be either:

ERR:
SENT:
RECV:
DELIVERED:

Possible values:

provider_msg_idstringOptional

The provider message ID of the message.

created_atall ofOptional

The creation time of the message.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

4XX

Error

get

/user/external_messages/{id}

GET /api/user/external_messages/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "config_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "sender": "text",
  "sender_name": "text",
  "receiver": "text",
  "receiver_name": "text",
  "channel_name": "text",
  "channel_number": "text",
  "brand": "text",
  "did": "text",
  "msg_type": "UNKNOWN",
  "direction": "IN",
  "content": "text",
  "reason": "text",
  "delivery": "ERR",
  "provider_msg_id": "text",
  "created_at": "2017-07-21T17:32:28Z"
}

List user call recordings

get

Retrieve a collection of user call recordings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/user/recordings

GET /api/user/recordings HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller": "text",
      "callee": "text",
      "started_at": "2017-07-21T17:32:28Z",
      "ended_at": "2017-07-21T17:32:28Z"
    }
  ]
}

Retrieve an user call recording

get

Get details of an user call recording.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRead-onlyRequired

The unique ID of call recording.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/user/recordings/{id}

GET /api/user/recordings/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "caller": "text",
      "callee": "text",
      "started_at": "2017-07-21T17:32:28Z",
      "ended_at": "2017-07-21T17:32:28Z",
      "duration": 1,
      "file_name": "text",
      "file_size": 0,
      "file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
    }
  ]
}

Delete user call recording

post

Delete an user call recording

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRead-onlyRequired

The unique ID of call recording.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/user/recordings/{id}/destroy

POST /api/user/recordings/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List speed dial 8

get

List speed dial 8.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/user/speed_dial_8

GET /api/user/speed_dial_8 HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "code": "text",
      "phone_number": "text",
      "description": "text"
    }
  ]
}

Add new speed dial 8

post

Create new speed dial 8.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

codestring · min: 1 · max: 1Required

The speed dial 8 dialing code.
Available code range from 2 to 9.

phone_numberstringRequired

The phone number that you want to call.

descriptionstring · max: 1024Optional

The description of speed dial.

Responses

201

Created

application/json

4XX

Error

post

/user/speed_dial_8

POST /api/user/speed_dial_8 HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "code": "text",
  "phone_number": "text",
  "description": "text"
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve details of speed dial 8

get

Retrieve details of speed dial 8 by it's ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of speed dial.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of speed dial.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

codestring · min: 1 · max: 1Optional

The speed dial 8 dialing code.
Available code range from 2 to 9.

phone_numberstringOptional

The phone number that you want to call.

descriptionstring · max: 1024Optional

The description of speed dial.

4XX

Error

get

/user/speed_dial_8/{id}

GET /api/user/speed_dial_8/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "code": "text",
  "phone_number": "text",
  "description": "text"
}

Update speed dial 8

post

Update speed dial 8.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of speed dial.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

codestring · min: 1 · max: 1Optional

The speed dial 8 dialing code.
Available code range from 2 to 9.

phone_numberstringOptional

The phone number that you want to call.

descriptionstring · max: 1024Optional

The description of speed dial.

Responses

200

OK

No content

4XX

Error

post

/user/speed_dial_8/{id}

POST /api/user/speed_dial_8/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "code": "text",
  "phone_number": "text",
  "description": "text"
}

No content

Delete speed dial 8

post

Remove speed dial 8 by ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of speed dial.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/user/speed_dial_8/{id}/destroy

POST /api/user/speed_dial_8/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List speed dial 100

get

List speed dial 100.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/user/speed_dial_100

GET /api/user/speed_dial_100 HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "code": "text",
      "phone_number": "text",
      "description": "text"
    }
  ]
}

Add new speed dial 100

post

Create new speed dial 100.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

codestring · min: 2 · max: 2Required

The speed dial 100 dialing code.
Available code range from 00 to 99.

phone_numberstringRequired

The phone number that you want to call.

descriptionstring · max: 1024Optional

The description of speed dial.

Responses

201

Created

application/json

4XX

Error

post

/user/speed_dial_100

POST /api/user/speed_dial_100 HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "code": "text",
  "phone_number": "text",
  "description": "text"
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve details of speed dial 100

get

Retrieve details of speed dial 100 by it's ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of speed dial.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of speed dial.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

codestring · min: 2 · max: 2Optional

The speed dial 100 dialing code.
Available code range from 00 to 99.

phone_numberstringOptional

The phone number that you want to call.

descriptionstring · max: 1024Optional

The description of speed dial.

4XX

Error

get

/user/speed_dial_100/{id}

GET /api/user/speed_dial_100/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "code": "text",
  "phone_number": "text",
  "description": "text"
}

Update speed dial 100

post

Update speed dial 100.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of speed dial.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

codestring · min: 2 · max: 2Optional

The speed dial 100 dialing code.
Available code range from 00 to 99.

phone_numberstringOptional

The phone number that you want to call.

descriptionstring · max: 1024Optional

The description of speed dial.

Responses

200

OK

No content

4XX

Error

post

/user/speed_dial_100/{id}

POST /api/user/speed_dial_100/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "code": "text",
  "phone_number": "text",
  "description": "text"
}

No content

Delete speed dial 100

post

Remove speed dial 100 by ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of speed dial.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/user/speed_dial_100/{id}/destroy

POST /api/user/speed_dial_100/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List user meetings

get

Retrieve a collection of meetings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/user/meetings

GET /api/user/meetings HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "extension_number": "text",
      "mode": "AUDIO",
      "control": "FREE",
      "height": 720,
      "width": 1280,
      "bitrate": 1024,
      "framerate": 15,
      "layout": "LAYOUT0",
      "subject": "text",
      "language": "en-US",
      "capacity": 9,
      "admin_pin": "text",
      "room_pin": "text",
      "enable_recording": false,
      "enable_prompt": true,
      "timezone": "text",
      "created_at": "2017-07-21T17:32:28Z",
      "scheduled_start_at": "2017-07-21T17:32:28Z",
      "scheduled_end_at": "2017-07-21T17:32:28Z",
      "internal_invitees": [
        "NzAwNTUxOTA5NzczMTQ4MTYw"
      ],
      "external_invitees": "text",
      "close_on_nobody": false,
      "outbound_caller_ids": [
        {
          "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
          "caller_id": "text",
          "description": "text"
        }
      ],
      "ownership": true,
      "custom_options": "text"
    }
  ]
}

Create a Meeting

post

Create a meeting.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

modestring · enumRequired

The conference room mode.
Can be either:

AUDIO: audio conference room.
VIDEO: video conference room.

Possible values:

controlstring · enumOptional

The conference control type.
Can be either:

FREE: the free mode.
MASTER: the master mode.

Default: FREEPossible values:

heightinteger · int32 · min: 144 · max: 1920Optional

The height for video conference room.
Only valid in VIDEO mode.

Default: 720

widthinteger · int32 · min: 144 · max: 1920Optional

The width for video conference room.
Only valid in VIDEO mode.

Default: 1280

bitrateinteger · int32 · min: 128 · max: 10240Optional

The transmission rate for video conference room.
Only valid in VIDEO mode.

Default: 1024

framerateinteger · min: 5 · max: 30Optional

The framerate for video conference room.
Only valid in VIDEO mode.

Default: 15

layoutstring · enumOptional

The number of grids allowed for video conference room.
Only valid in VIDEO mode.
Can be either:

LAYOUT0:
LAYOUT1:
LAYOUT2:
LAYOUT3:
LAYOUT4:
LAYOUT6:
LAYOUT9:

Default: LAYOUT0Possible values:

subjectstring · min: 1 · max: 64Required

The subject of conference room.

languagestringOptional

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

admin_pinstring · min: 3 · max: 6Optional

The PIN for admin of the conference room. Only numeric sequences are allowed.

room_pinstring · min: 3 · max: 6Optional

The PIN for the conference room. Only numeric sequences are allowed.

enable_recordingbooleanOptional

Whether to enable recording when created.

Default: false

enable_promptbooleanOptional

Whether to enable voice menu.

Default: true

timezonestringRequired

The IANA Time Zone names, such as "Asia/Shanghai".

scheduled_start_atall ofOptional

The scheduled start time of meeting.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

scheduled_end_atall ofOptional

The scheduled end time of meeting.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

external_inviteesstringOptional

The invitees to send invitation emails to.

close_on_nobodybooleanOptional

Whether to close the meeting if the nobody in.

Default: false

custom_optionsstringOptional

Some custom configuration options serialized as json string

Responses

201

Created

application/json

4XX

Error

post

/user/meetings

POST /api/user/meetings HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 562

{
  "mode": "AUDIO",
  "control": "FREE",
  "height": 720,
  "width": 1280,
  "bitrate": 1024,
  "framerate": 15,
  "layout": "LAYOUT0",
  "subject": "text",
  "language": "en-US",
  "admin_pin": "text",
  "room_pin": "text",
  "enable_recording": false,
  "enable_prompt": true,
  "timezone": "text",
  "scheduled_start_at": "2017-07-21T17:32:28Z",
  "scheduled_end_at": "2017-07-21T17:32:28Z",
  "internal_invitees": [
    "NzAwNTUxOTA5NzczMTQ4MTYw"
  ],
  "external_invitees": "text",
  "close_on_nobody": false,
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "description": "text"
    }
  ],
  "custom_options": "text"
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "extension_number": "text"
}

Retrieve a meeting

get

Retrieve a meeting.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

extension_numberstring · min: 3 · max: 64Optional

The extension number.

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

modestring · enumOptional

The conference room mode.
Can be either:

AUDIO: audio conference room.
VIDEO: video conference room.

Possible values:

controlstring · enumOptional

The conference control type.
Can be either:

FREE: the free mode.
MASTER: the master mode.

Default: FREEPossible values:

heightinteger · int32 · min: 144 · max: 1920Optional

The height for video conference room.
Only valid in VIDEO mode.

Default: 720

widthinteger · int32 · min: 144 · max: 1920Optional

The width for video conference room.
Only valid in VIDEO mode.

Default: 1280

bitrateinteger · int32 · min: 128 · max: 10240Optional

The transmission rate for video conference room.
Only valid in VIDEO mode.

Default: 1024

framerateinteger · min: 5 · max: 30Optional

The framerate for video conference room.
Only valid in VIDEO mode.

Default: 15

layoutstring · enumOptional

The number of grids allowed for video conference room.
Only valid in VIDEO mode.
Can be either:

LAYOUT0:
LAYOUT1:
LAYOUT2:
LAYOUT3:
LAYOUT4:
LAYOUT6:
LAYOUT9:

Default: LAYOUT0Possible values:

subjectstring · min: 1 · max: 64Optional

The subject of conference room.

languagestringOptional

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

capacityinteger · int32 · min: 1 · max: 200Optional

The maximum number of participants allowed in the room.

Default: 9

admin_pinstring · min: 3 · max: 6Optional

The PIN for admin of the conference room. Only numeric sequences are allowed.

room_pinstring · min: 3 · max: 6Optional

The PIN for the conference room. Only numeric sequences are allowed.

enable_recordingbooleanOptional

Whether to enable recording when created.

Default: false

enable_promptbooleanOptional

Whether to enable voice menu.

Default: true

timezonestringOptional

The IANA Time Zone names, such as "Asia/Shanghai".

created_atall ofOptional

The creation time of conference room.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

scheduled_start_atall ofOptional

The scheduled start time of meeting.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

scheduled_end_atall ofOptional

The scheduled end time of meeting.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

external_inviteesstringOptional

The invitees to send invitation emails to.

close_on_nobodybooleanOptional

Whether to close the meeting if the nobody in.

Default: false

domainstring · min: 1 · max: 280Optional

The SIP domain of tenant.
It is usually a fully qualified domain name (FQDN). If there is no FQDN, you can also use the IP address of the PBX server as the SIP domain. The SIP domain name is only used for SIP message authentication and does not require analysis.

sbc_hoststringOptional

The SBC domain.

sbc_portall ofOptional

The SBC web port fot https.

Default: 8883

integer · int32 · max: 65535Optional

A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port

Example: 80

tokenstringOptional

Access token to be passed as a header

Example: 4DFCF1D4C30B4D798ECE3AE43769F008.

ownershipbooleanOptional

Whether the user has ownership of the meeting.

custom_optionsstringOptional

Some custom configuration options serialized as json string

4XX

Error

get

/user/meetings/{id}

GET /api/user/meetings/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "extension_number": "text",
  "mode": "AUDIO",
  "control": "FREE",
  "height": 720,
  "width": 1280,
  "bitrate": 1024,
  "framerate": 15,
  "layout": "LAYOUT0",
  "subject": "text",
  "language": "en-US",
  "capacity": 9,
  "admin_pin": "text",
  "room_pin": "text",
  "enable_recording": false,
  "enable_prompt": true,
  "timezone": "text",
  "created_at": "2017-07-21T17:32:28Z",
  "scheduled_start_at": "2017-07-21T17:32:28Z",
  "scheduled_end_at": "2017-07-21T17:32:28Z",
  "internal_invitees": [
    "NzAwNTUxOTA5NzczMTQ4MTYw"
  ],
  "external_invitees": "text",
  "close_on_nobody": false,
  "domain": "text",
  "sbc_host": "text",
  "sbc_port": 8883,
  "token": "4DFCF1D4C30B4D798ECE3AE43769F008.",
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "description": "text"
    }
  ],
  "ownership": true,
  "custom_options": "text"
}

Update a meeting

post

Update a meeting

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

controlstring · enumOptional

The conference control type.
Can be either:

FREE: the free mode.
MASTER: the master mode.

Default: FREEPossible values:

heightinteger · int32 · min: 144 · max: 1920Optional

The height for video conference room.
Only valid in VIDEO mode.

Default: 720

widthinteger · int32 · min: 144 · max: 1920Optional

The width for video conference room.
Only valid in VIDEO mode.

Default: 1280

bitrateinteger · int32 · min: 128 · max: 10240Optional

The transmission rate for video conference room.
Only valid in VIDEO mode.

Default: 1024

framerateinteger · min: 5 · max: 30Optional

The framerate for video conference room.
Only valid in VIDEO mode.

Default: 15

layoutstring · enumOptional

The number of grids allowed for video conference room.
Only valid in VIDEO mode.
Can be either:

LAYOUT0:
LAYOUT1:
LAYOUT2:
LAYOUT3:
LAYOUT4:
LAYOUT6:
LAYOUT9:

Default: LAYOUT0Possible values:

subjectstring · min: 1 · max: 64Optional

The subject of conference room.

languagestringOptional

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

capacityinteger · int32 · min: 1 · max: 200Optional

The maximum number of participants allowed in the room.

Default: 9

admin_pinstring · min: 3 · max: 6Optional

The PIN for admin of the conference room. Only numeric sequences are allowed.

room_pinstring · min: 3 · max: 6Optional

The PIN for the conference room. Only numeric sequences are allowed.

enable_recordingbooleanOptional

Whether to enable recording when created.

Default: false

enable_promptbooleanOptional

Whether to enable voice menu.

Default: true

timezonestringOptional

The IANA Time Zone names, such as "Asia/Shanghai".

scheduled_start_atall ofOptional

The scheduled start time of meeting.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

scheduled_end_atall ofOptional

The scheduled end time of meeting.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

external_inviteesstringOptional

The invitees to send invitation emails to.

close_on_nobodybooleanOptional

Whether to close the meeting if the nobody in.

Default: false

custom_optionsstringOptional

Some custom configuration options serialized as json string

Responses

200

OK

No content

4XX

Error

post

/user/meetings/{id}

POST /api/user/meetings/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 560

{
  "control": "FREE",
  "height": 720,
  "width": 1280,
  "bitrate": 1024,
  "framerate": 15,
  "layout": "LAYOUT0",
  "subject": "text",
  "language": "en-US",
  "capacity": 9,
  "admin_pin": "text",
  "room_pin": "text",
  "enable_recording": false,
  "enable_prompt": true,
  "timezone": "text",
  "scheduled_start_at": "2017-07-21T17:32:28Z",
  "scheduled_end_at": "2017-07-21T17:32:28Z",
  "internal_invitees": [
    "NzAwNTUxOTA5NzczMTQ4MTYw"
  ],
  "external_invitees": "text",
  "close_on_nobody": false,
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "description": "text"
    }
  ],
  "custom_options": "text"
}

No content

Delete meeting

post

Destroy a conference room

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

400

Invalid username supplied

404

Not found

post

/user/meetings/{id}/destroy

POST /api/user/meetings/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get meeting status

get

Retrieve meeting status.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

statusstring · enumOptional

The conference room status. Can be either:

ONLINE:
OFFLINE:
ON_CALL:

Possible values:

lockedbooleanOptional

Whether the conference room was locked.

mutedbooleanOptional

Whether the conference room was muted.

recordingbooleanOptional

Whether the conference room is recording.

4XX

Error

get

/user/meetings/{id}/status

GET /api/user/meetings/{id}/status HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "ONLINE",
  "locked": true,
  "muted": true,
  "recording": true
}

Mute meeting

post

Mute meeting.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/user/meetings/{id}/mute

POST /api/user/meetings/{id}/mute HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Unmute meeting

post

Unmute meeting by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/user/meetings/{id}/unmute

POST /api/user/meetings/{id}/unmute HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Lock meeting

post

Lock meeting by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/user/meetings/{id}/lock

POST /api/user/meetings/{id}/lock HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Unlock meeting

post

Unlock meeting by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/user/meetings/{id}/unlock

POST /api/user/meetings/{id}/unlock HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Start meeting

post

Start meeting by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/user/meetings/{id}/start

POST /api/user/meetings/{id}/start HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Stop meeting

post

Stop meeting by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/user/meetings/{id}/stop

POST /api/user/meetings/{id}/stop HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Start recording in meeting

post

Start recording in meeting.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/user/meetings/{id}/start_recording

POST /api/user/meetings/{id}/start_recording HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Stop recording in meeting

post

Stop recording in meeting.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/user/meetings/{id}/stop_recording

POST /api/user/meetings/{id}/stop_recording HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List meeting participants

get

Retrieve a collection of meeting participants.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/user/meetings/{id}/participants

GET /api/user/meetings/{id}/participants HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "display_name": "\"example\"<sip:[email protected]>",
      "muted": true,
      "chairman": true,
      "position": 1
    }
  ]
}

Update meeting participants layout

post

Modify participants layout based on meeting layout.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

Responses

200

OK

No content

4XX

Error

post

/user/meetings/{id}/participants/layout

POST /api/user/meetings/{id}/participants/layout HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "items": [
    "NzAwNTUxOTA5NzczMTQ4MTYw"
  ]
}

No content

Get meeting participant details

get

Get meeting participant details.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

participant_idall ofRequired

The unique ID of conference room participant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of conference room participant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

display_namestringOptional

The display name of conference room participant.

Example: "example"<sip:[email protected]>

mutedbooleanOptional

Whether the participant is muted.

chairmanbooleanOptional

Indicates whether the user is chairman of the conference room.

positioninteger · int32 · min: -1 · max: 8Optional

The position of room member.
The member will not be displayed when -1 is specified.

4XX

Error

get

/user/meetings/{id}/participants/{participant_id}

GET /api/user/meetings/{id}/participants/{participant_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "display_name": "\"example\"<sip:[email protected]>",
  "muted": true,
  "chairman": true,
  "position": 1
}

Invite meeting participant

post

Invite an user as meeting participant.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

numberstringOptional

The number of invited participant.

Responses

200

OK

No content

4XX

Error

post

/user/meetings/{id}/participants/invite

POST /api/user/meetings/{id}/participants/invite HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "number": "text"
}

No content

Mute meeting participant

post

Mute meeting participant.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

participant_idall ofRequired

The unique ID of conference room participant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/user/meetings/{id}/participants/{participant_id}/mute

POST /api/user/meetings/{id}/participants/{participant_id}/mute HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Unmute meeting participant

post

Unmute meeting participant.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

participant_idall ofRequired

The unique ID of conference room participant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/user/meetings/{id}/participants/{participant_id}/unmute

POST /api/user/meetings/{id}/participants/{participant_id}/unmute HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Transfer meeting ownership

post

Transfer meeting ownership to another participant.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

participant_idall ofRequired

The unique ID of conference room participant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/user/meetings/{id}/participants/{participant_id}/chairman

POST /api/user/meetings/{id}/participants/{participant_id}/chairman HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Set meeting participant position

post

Set meeting participant position.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

participant_idall ofRequired

The unique ID of conference room participant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

positioninteger · int32 · min: -1 · max: 8Optional

The position of room member.
The member will not be displayed when -1 is specified.

Responses

200

OK

No content

4XX

Error

post

/user/meetings/{id}/participants/{participant_id}/position

POST /api/user/meetings/{id}/participants/{participant_id}/position HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "position": 1
}

No content

Kick out meeting participant

post

Kick out meeting participant.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of conference room.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

participant_idall ofRequired

The unique ID of conference room participant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/user/meetings/{id}/participants/{participant_id}/destroy

POST /api/user/meetings/{id}/participants/{participant_id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List current user's holidays

get

Retrieve a collection of current user's holidays.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/user/holidays

GET /api/user/holidays HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "region": "text",
      "consecutive": true,
      "every_year": true,
      "year_start": 1,
      "year_end": 1,
      "month_start": 1,
      "month_end": 1,
      "day_start": 1,
      "day_end": 1,
      "hour_start": 1,
      "hour_end": 1,
      "minute_start": 1,
      "minute_end": 1
    }
  ]
}

Create a new holiday for current user

post

Create a new holiday for current user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestring · min: 1 · max: 64Required

The name of the holiday.

regionstringRequired

A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html

consecutivebooleanRequired

Whether the holiday consists of consecutive days.

every_yearbooleanRequired

Does the holiday take effect every year.

year_startintegerOptional

The start year of holiday.

year_endintegerOptional

The end year of holiday.

month_startintegerOptional

The start month of holiday.

month_endintegerOptional

The end month of holiday.

day_startintegerOptional

The start day of holiday.

day_endintegerOptional

The end day of holiday.

hour_startintegerOptional

The start hour of holiday.

hour_endintegerOptional

The end hour of holiday.

minute_startintegerOptional

The start minute of holiday.

minute_endintegerOptional

The end minute of holiday.

Responses

201

Created

application/json

4XX

Error

post

/user/holidays

POST /api/user/holidays HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 212

{
  "name": "text",
  "region": "text",
  "consecutive": true,
  "every_year": true,
  "year_start": 1,
  "year_end": 1,
  "month_start": 1,
  "month_end": 1,
  "day_start": 1,
  "day_end": 1,
  "hour_start": 1,
  "hour_end": 1,
  "minute_start": 1,
  "minute_end": 1
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve a holiday of current user

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRead-onlyRequired

The unique ID of holiday.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofRead-onlyOptional

The unique ID of holiday.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

namestring · min: 1 · max: 64Optional

The name of the holiday.

regionstringOptional

A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html

consecutivebooleanOptional

Whether the holiday consists of consecutive days.

every_yearbooleanOptional

Does the holiday take effect every year.

year_startintegerOptional

The start year of holiday.

year_endintegerOptional

The end year of holiday.

month_startintegerOptional

The start month of holiday.

month_endintegerOptional

The end month of holiday.

day_startintegerOptional

The start day of holiday.

day_endintegerOptional

The end day of holiday.

hour_startintegerOptional

The start hour of holiday.

hour_endintegerOptional

The end hour of holiday.

minute_startintegerOptional

The start minute of holiday.

minute_endintegerOptional

The end minute of holiday.

4XX

Error

get

/user/holidays/{id}

GET /api/user/holidays/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "region": "text",
  "consecutive": true,
  "every_year": true,
  "year_start": 1,
  "year_end": 1,
  "month_start": 1,
  "month_end": 1,
  "day_start": 1,
  "day_end": 1,
  "hour_start": 1,
  "hour_end": 1,
  "minute_start": 1,
  "minute_end": 1
}

Update a holiday of current user

post

Update a holiday of current user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRead-onlyRequired

The unique ID of holiday.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

namestring · min: 1 · max: 64Required

The name of the holiday.

regionstringOptional

A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html

consecutivebooleanRequired

Whether the holiday consists of consecutive days.

every_yearbooleanRequired

Does the holiday take effect every year.

year_startintegerOptional

The start year of holiday.

year_endintegerOptional

The end year of holiday.

month_startintegerOptional

The start month of holiday.

month_endintegerOptional

The end month of holiday.

day_startintegerOptional

The start day of holiday.

day_endintegerOptional

The end day of holiday.

hour_startintegerOptional

The start hour of holiday.

hour_endintegerOptional

The end hour of holiday.

minute_startintegerOptional

The start minute of holiday.

minute_endintegerOptional

The end minute of holiday.

Responses

200

OK

No content

4XX

Error

post

/user/holidays/{id}

POST /api/user/holidays/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 212

{
  "name": "text",
  "region": "text",
  "consecutive": true,
  "every_year": true,
  "year_start": 1,
  "year_end": 1,
  "month_start": 1,
  "month_end": 1,
  "day_start": 1,
  "day_end": 1,
  "hour_start": 1,
  "hour_end": 1,
  "minute_start": 1,
  "minute_end": 1
}

No content

Destroy a holiday of current user

post

Destroy a holiday of current user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRead-onlyRequired

The unique ID of holiday.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

400

Invalid ID supplied.

post

/user/holidays/{id}/destroy

POST /api/user/holidays/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List current user's global holidays

get

Retrieve a collection of current user's global holidays.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/user/global_holidays

GET /api/user/global_holidays HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "region": "text",
      "consecutive": true,
      "every_year": true,
      "year_start": 1,
      "year_end": 1,
      "month_start": 1,
      "month_end": 1,
      "day_start": 1,
      "day_end": 1,
      "hour_start": 1,
      "hour_end": 1,
      "minute_start": 1,
      "minute_end": 1
    }
  ]
}

Update current user's global holidays

post

Update current user's global holidays from tenant holidays.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

201

Created

application/json

4XX

Error

post

/user/global_holidays

POST /api/user/global_holidays HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "items": [
    "NzAwNTUxOTA5NzczMTQ4MTYw"
  ]
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

List personal contact

get

Retrieve a collection of personal contacts.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/user/contacts

GET /api/user/contacts HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "email": "text",
      "company": "text",
      "title": "text",
      "business": "text",
      "business2": "text",
      "mobile_phone": "text",
      "mobile_phone2": "text",
      "home_phone": "text",
      "home_phone2": "text",
      "other": "text",
      "business_fax": "text",
      "home_fax": "text",
      "address": "text",
      "notes": "text",
      "sync_type": "Microsoft 365",
      "favorite": true
    }
  ]
}

Add a new personal contact

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestring · min: 1 · max: 64Optional

The name of contact.

emailstring · max: 128Optional

The email of contact.

companystring · max: 128Optional

The company name of contact.

titlestring · max: 128Optional

The title of contact.

businessstring · max: 128Optional

The business phone number of contact.

business2string · max: 128Optional

The secondary business phone number of contact.

mobile_phonestring · max: 128Optional

The mobile phone number of contact.

mobile_phone2string · max: 128Optional

The secondary mobile phone number of contact.

home_phonestring · max: 128Optional

The home phone number of contact.

home_phone2string · max: 128Optional

The secondary home phone number of contact.

otherstring · max: 128Optional

The other phone number of contact.

business_faxstring · max: 128Optional

The business fax of contact.

home_faxstring · max: 128Optional

The home fax of contact.

addressstring · max: 128Optional

The address.

notesstring · max: 1024Optional

The notes of contact.

Responses

201

Created contact

application/json

4XX

Error

post

/user/contacts

POST /api/user/contacts HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 272

{
  "name": "text",
  "email": "text",
  "company": "text",
  "title": "text",
  "business": "text",
  "business2": "text",
  "mobile_phone": "text",
  "mobile_phone2": "text",
  "home_phone": "text",
  "home_phone2": "text",
  "other": "text",
  "business_fax": "text",
  "home_fax": "text",
  "address": "text",
  "notes": "text"
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve personal contact details

get

Retrieves details of a personal contact.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of contact.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of contact.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

namestring · min: 1 · max: 64Optional

The name of contact.

emailstring · max: 128Optional

The email of contact.

companystring · max: 128Optional

The company name of contact.

titlestring · max: 128Optional

The title of contact.

businessstring · max: 128Optional

The business phone number of contact.

business2string · max: 128Optional

The secondary business phone number of contact.

mobile_phonestring · max: 128Optional

The mobile phone number of contact.

mobile_phone2string · max: 128Optional

The secondary mobile phone number of contact.

home_phonestring · max: 128Optional

The home phone number of contact.

home_phone2string · max: 128Optional

The secondary home phone number of contact.

otherstring · max: 128Optional

The other phone number of contact.

business_faxstring · max: 128Optional

The business fax of contact.

home_faxstring · max: 128Optional

The home fax of contact.

addressstring · max: 128Optional

The address.

notesstring · max: 1024Optional

The notes of contact.

sync_typestring · enumOptional

The synchronization method.
Can be either:

Microsoft 365: Sync from Microsoft 365.

Possible values:

favoritebooleanOptional

Mark if a contact has been added to the favorites list.

Example: true

4XX

Error

get

/user/contacts/{id}

GET /api/user/contacts/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "email": "text",
  "company": "text",
  "title": "text",
  "business": "text",
  "business2": "text",
  "mobile_phone": "text",
  "mobile_phone2": "text",
  "home_phone": "text",
  "home_phone2": "text",
  "other": "text",
  "business_fax": "text",
  "home_fax": "text",
  "address": "text",
  "notes": "text",
  "sync_type": "Microsoft 365",
  "favorite": true
}

Update a personal contact

post

Update a personal contact.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of contact.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

namestring · min: 1 · max: 64Optional

The name of contact.

emailstring · max: 128Optional

The email of contact.

companystring · max: 128Optional

The company name of contact.

titlestring · max: 128Optional

The title of contact.

businessstring · max: 128Optional

The business phone number of contact.

business2string · max: 128Optional

The secondary business phone number of contact.

mobile_phonestring · max: 128Optional

The mobile phone number of contact.

mobile_phone2string · max: 128Optional

The secondary mobile phone number of contact.

home_phonestring · max: 128Optional

The home phone number of contact.

home_phone2string · max: 128Optional

The secondary home phone number of contact.

otherstring · max: 128Optional

The other phone number of contact.

business_faxstring · max: 128Optional

The business fax of contact.

home_faxstring · max: 128Optional

The home fax of contact.

addressstring · max: 128Optional

The address.

notesstring · max: 1024Optional

The notes of contact.

Responses

200

OK

No content

4XX

Error

post

/user/contacts/{id}

POST /api/user/contacts/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 272

{
  "name": "text",
  "email": "text",
  "company": "text",
  "title": "text",
  "business": "text",
  "business2": "text",
  "mobile_phone": "text",
  "mobile_phone2": "text",
  "home_phone": "text",
  "home_phone2": "text",
  "other": "text",
  "business_fax": "text",
  "home_fax": "text",
  "address": "text",
  "notes": "text"
}

No content

Favorite a personal contact

post

Favorite a personal contact.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of contact.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/user/contacts/{id}/favorite

POST /api/user/contacts/{id}/favorite HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Unfavorite a personal contact

post

Favorite a personal contact.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of contact.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/user/contacts/{id}/unfavorite

POST /api/user/contacts/{id}/unfavorite HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete a personal contact

post

Delete a personal contact by it's unique id.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of contact.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/user/contacts/{id}/destroy

POST /api/user/contacts/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create new personal contact sync token

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

201

Created

application/json

4XX

Error

post

/user/contacts/sync_tokens

POST /api/user/contacts/sync_tokens HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo."
}

List personal contact changes

post

List personal contact changes.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tokenstringRequired

The sync token.
Clients should treat the sync token as an opaque string and should never try to assemble it.
This document imposes no constraints on the format and clients should never impose any.

Example: RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo.

Responses

200

OK

application/json

tokenstringOptional

The sync token.
Clients should treat the sync token as an opaque string and should never try to assemble it.
This document imposes no constraints on the format and clients should never impose any.

Example: RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo.

4XX

Error

post

/user/contacts/sync_tokens/{token}/diff

POST /api/user/contacts/sync_tokens/{token}/diff HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo.",
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "email": "text",
      "company": "text",
      "title": "text",
      "business": "text",
      "business2": "text",
      "mobile_phone": "text",
      "mobile_phone2": "text",
      "home_phone": "text",
      "home_phone2": "text",
      "other": "text",
      "business_fax": "text",
      "home_fax": "text",
      "address": "text",
      "notes": "text",
      "favorite": true,
      "change_type": "CREATED"
    }
  ]
}

Favorite a business contact

post

Favorite a business contact.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of contact.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/user/business_contacts/{id}/favorite

POST /api/user/business_contacts/{id}/favorite HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Unfavorite a business contact

post

Favorite a business contact.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of contact.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/user/business_contacts/{id}/unfavorite

POST /api/user/business_contacts/{id}/unfavorite HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create a business contact sync token

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

201

Created

application/json

4XX

Error

post

/user/business_contacts/sync_tokens

POST /api/user/business_contacts/sync_tokens HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo."
}

List business contact changes

post

List business contact changes.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tokenstringRequired

The sync token.
Clients should treat the sync token as an opaque string and should never try to assemble it.
This document imposes no constraints on the format and clients should never impose any.

Example: RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo.

Responses

200

OK

application/json

tokenstringOptional

The sync token.
Clients should treat the sync token as an opaque string and should never try to assemble it.
This document imposes no constraints on the format and clients should never impose any.

Example: RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo.

4XX

Error

post

/user/business_contacts/sync_tokens/{token}/diff

POST /api/user/business_contacts/sync_tokens/{token}/diff HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo.",
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "email": "text",
      "company": "text",
      "title": "text",
      "business": "text",
      "business2": "text",
      "mobile_phone": "text",
      "mobile_phone2": "text",
      "home_phone": "text",
      "home_phone2": "text",
      "other": "text",
      "business_fax": "text",
      "home_fax": "text",
      "address": "text",
      "notes": "text",
      "favorite": true,
      "change_type": "CREATED"
    }
  ]
}

Favorite an extension contact

post

Favorite an extension contact.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of contact.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/user/extension_contacts/{id}/favorite

POST /api/user/extension_contacts/{id}/favorite HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Unfavorite an extension contact

post

Favorite an extension contact.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of contact.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/user/extension_contacts/{id}/unfavorite

POST /api/user/extension_contacts/{id}/unfavorite HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create a extension contact sync token

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

201

Created

application/json

4XX

Error

post

/user/extension_contacts/sync_tokens

POST /api/user/extension_contacts/sync_tokens HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo."
}

List extension contact changes

post

List extension contact changes.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tokenstringRequired

The sync token.
Clients should treat the sync token as an opaque string and should never try to assemble it.
This document imposes no constraints on the format and clients should never impose any.

Example: RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo.

Responses

200

OK

application/json

tokenstringOptional

The sync token.
Clients should treat the sync token as an opaque string and should never try to assemble it.
This document imposes no constraints on the format and clients should never impose any.

Example: RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo.

4XX

Error

post

/user/extension_contacts/sync_tokens/{token}/diff

POST /api/user/extension_contacts/sync_tokens/{token}/diff HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo.",
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "display_name": "text",
      "email": "[email protected]",
      "mobile_phone": "[email protected]",
      "work_phone": "[email protected]",
      "home_phone": "[email protected]",
      "address": "text",
      "department": "text",
      "avatar_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
      "extension_number": "text",
      "favorite": true,
      "change_type": "CREATED"
    }
  ]
}

Retrieve the call queues which current user belongs

get

Retrieve the call queues which current user belongs.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/user/call_queues

GET /api/user/call_queues HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "extension_number": "text"
    }
  ]
}

Retrieve call queue agent

get

Retrieve information of call queue agent.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of call queue.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

extension_numberall ofOptional

The extension number of agent.

string · min: 3 · max: 64Optional

The extension number.

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

display_nameall ofOptional

The display name of agent.

string · max: 1024Optional

The display name of user.

skill_levelinteger · int32 · min: 1 · max: 100Optional

The skill level of agent in queue.
Only valid when polling_strategy is skill based.

Default: 1

statusstring · enumRead-onlyOptional

Current status of agent:

READY:
NOT_READY:
QUEUE_CALL:
OTHER_CALL:
WRAP_UP:
BREAK:
LUNCH:
TRANSFER:
CONSULT_TRANSFER:
ON_HOLD:
LOGGED_OUT:
OFFLINE:

Possible values:

4XX

Error

get

/user/call_queues/{id}/agent

GET /api/user/call_queues/{id}/agent HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "extension_number": "text",
  "display_name": "text",
  "skill_level": 1,
  "status": "READY"
}

Set call queue agent status

post

Set call queue agent status.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of call queue.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

statusstring · enumOptional

Change call queue agent status to one of the following:

READY:
NOT_READY:
WRAP_UP:
BREAK:
LUNCH:
LOGGED_IN:
LOGGED_OUT:

Example: READYPossible values:

Responses

200

OK

No content

4XX

Error

post

/user/call_queues/{id}/agent

POST /api/user/call_queues/{id}/agent HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "status": "READY"
}

No content

Retrieve a collection of outbound caller ids

get

Retrieve a collection of outbound caller ids.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/user/outbound_caller_ids

GET /api/user/outbound_caller_ids HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "description": "text"
    }
  ]
}

Retrieve the ring groups which current user belongs

get

Retrieve the ring groups which current user belongs.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/user/ring_groups

GET /api/user/ring_groups HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "extension_number": "text"
    }
  ]
}

List users

get

List a collection of users.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/users

GET /api/users HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "enabled": true,
      "email": "[email protected]",
      "display_name": "text",
      "role": "User",
      "mobile_phone": "text",
      "work_phone": "text",
      "home_phone": "text",
      "address": "text",
      "department": "text",
      "extension_number": "text",
      "created_at": "2017-07-21T17:32:28Z",
      "avatar_file_name": "text",
      "avatar_file_size": 0,
      "avatar_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
      "sync_type": "Microsoft 365"
    }
  ]
}

Create a user

post

Create a new user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestring · min: 1 · max: 64Required

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.

passwordstringRequired

The password of user.

emailall ofRequired

The email address of user.

string · max: 128Optional

The email address.

Example: [email protected]

display_namestring · max: 1024Required

The display name of user.

enabledbooleanOptional

Allows temporarily disabling the extension.

Default: true

rolestring · min: 1 · max: 64Required

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 · max: 32Optional

The mobile phone number of user.

work_phonestring · max: 32Optional

The office phone number of user.

home_phonestring · max: 32Optional

The home phone number of user.

addressstring · max: 128Optional

The address.

departmentstring · max: 128Optional

The department of user.

extension_numberstring · min: 3 · max: 64Required

The extension number.

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

extension_passwordstringRequired

The extension password.

enable_audio_recordingbooleanOptional

Records all calls and saves audio recordings on server.

Default: false

enable_video_recordingbooleanOptional

Records all calls and saves video recordings on server.

Default: false

enable_dndbooleanOptional

Enable Do Not Disturb or not.

enable_acbbooleanOptional

Enable Automatic Callback or not.

enable_hot_deskingbooleanOptional

Enable hot desking feature or not.

Default: false

anonymous_outbound_callsbooleanOptional

Always make outbound anonymous calls or not.

Default: false

smsstring · enumOptional

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

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

Default: DISABLEPossible values:

delivery_outbound_cidbooleanOptional

Always delivery outbound caller ID or not.

Default: true

custom_optionsstringOptional

Some custom configuration options serialized as json string

voicemail_promptstringOptional

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_pinbooleanOptional

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

Default: true

voicemail_pinstring · min: 6 · max: 10Required

The PIN number for accessing.
The PIN policies include:

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

enable_voicemail_notifybooleanOptional

Enable voicemail to email notify.

Default: false

voicemail_play_datetimestring · enumOptional

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.

Possible values:

interfacestring · enumOptional

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

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

Possible values:

preferred_transportstring · enumOptional

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Possible values:

Responses

201

Created

application/json

4XX

Error

post

/users

POST /api/users HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3351

{
  "name": "text",
  "password": "text",
  "email": "[email protected]",
  "display_name": "text",
  "enabled": true,
  "role": "User",
  "mobile_phone": "text",
  "work_phone": "text",
  "home_phone": "text",
  "address": "text",
  "department": "text",
  "extension_number": "text",
  "extension_password": "text",
  "enable_audio_recording": false,
  "enable_video_recording": false,
  "enable_dnd": true,
  "enable_acb": true,
  "enable_hot_desking": false,
  "anonymous_outbound_calls": false,
  "sms": "DISABLE",
  "delivery_outbound_cid": true,
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "preferred": true,
      "description": "text"
    }
  ],
  "custom_options": "text",
  "office_hours": {
    "mode": "CUSTOM",
    "monday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "tuesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "wednesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "thursday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "friday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "saturday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "sunday": {
      "enabled": true,
      "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": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "tuesday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "wednesday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "thursday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "friday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "saturday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "sunday": {
          "enabled": true,
          "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"
    }
  ]
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Reset all user profiles

post

Reset the active user profile with the specified ID, or reset all active user profiles when id is not specified.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

idall ofOptional

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/users/profile

POST /api/users/profile HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retrieve a user

get

Retrieves the settings of a user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

namestring · min: 1 · max: 64Optional

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 ofOptional

The email address of user.

string · max: 128Optional

The email address.

Example: [email protected]

display_namestring · max: 1024Optional

The display name of user.

rolestring · min: 1 · max: 64Optional

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

enabledbooleanOptional

Allows temporarily disabling the extension.

Default: true

mobile_phonestring · max: 32Optional

The mobile phone number of user.

work_phonestring · max: 32Optional

The office phone number of user.

home_phonestring · max: 32Optional

The home phone number of user.

addressstring · max: 128Optional

The address.

departmentstring · max: 128Optional

The department of user.

extension_numberstring · min: 3 · max: 64Optional

The extension number.

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

enable_audio_recordingbooleanOptional

Records all calls and saves audio recordings on server.

Default: false

enable_video_recordingbooleanOptional

Records all calls and saves video recordings on server.

Default: false

enable_dndbooleanOptional

Enable Do Not Disturb or not.

enable_acbbooleanOptional

Enable Automatic Callback or not.

enable_hot_deskingbooleanOptional

Enable hot desking feature or not.

Default: false

anonymous_outbound_callsbooleanOptional

Always make outbound anonymous calls or not.

Default: false

delivery_outbound_cidbooleanOptional

Always delivery outbound caller ID or not.

Default: true

smsstring · enumOptional

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

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

Default: DISABLEPossible values:

custom_optionsstringOptional

Some custom configuration options serialized as json string

voicemail_promptstringOptional

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_pinbooleanOptional

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

Default: true

voicemail_pinstring · min: 6 · max: 10Optional

The PIN number for accessing.
The PIN policies include:

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

enable_voicemail_notifybooleanOptional

Enable voicemail to email notify.

Default: false

voicemail_play_datetimestring · enumOptional

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.

Possible values:

interfacestring · enumOptional

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

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

Possible values:

preferred_transportstring · enumOptional

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Possible values:

profileall ofOptional

The unique ID of user profile file.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

created_atall ofOptional

The creation time of user.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z

avatar_file_namestringOptional

The name of the file.

avatar_file_sizeinteger · int64Optional

The file size in bytes.

Example: 0

avatar_file_urlstringRead-onlyOptional

The relative path to file url for file downloading.

Example: /api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK

sync_typestring · enumOptional

The synchronization method.
Can be either:

Microsoft 365: Sync from Microsoft 365.

Possible values:

4XX

Error

get

/users/{id}

GET /api/users/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "email": "[email protected]",
  "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": true,
  "enable_acb": true,
  "enable_hot_desking": false,
  "anonymous_outbound_calls": false,
  "delivery_outbound_cid": true,
  "sms": "DISABLE",
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "preferred": true,
      "description": "text"
    }
  ],
  "custom_options": "text",
  "office_hours": {
    "mode": "CUSTOM",
    "monday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "tuesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "wednesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "thursday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "friday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "saturday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "sunday": {
      "enabled": true,
      "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": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "tuesday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "wednesday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "thursday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "friday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "saturday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "sunday": {
          "enabled": true,
          "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": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "created_at": "2017-07-21T17:32:28Z",
  "avatar_file_name": "text",
  "avatar_file_size": 0,
  "avatar_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
  "sync_type": "Microsoft 365"
}

Update a user

post

Modify the settings of a user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

emailall ofOptional

The email address of user.

string · max: 128Optional

The email address.

Example: [email protected]

display_namestring · max: 1024Optional

The display name of user.

enabledbooleanOptional

Allows temporarily disabling the extension.

Default: true

mobile_phonestring · max: 32Optional

The mobile phone number of user.

work_phonestring · max: 32Optional

The office phone number of user.

home_phonestring · max: 32Optional

The home phone number of user.

addressstring · max: 128Optional

The address.

departmentstring · max: 128Optional

The department of user.

enable_audio_recordingbooleanOptional

Records all calls and saves audio recordings on server.

Default: false

enable_video_recordingbooleanOptional

Records all calls and saves video recordings on server.

Default: false

enable_dndbooleanOptional

Enable Do Not Disturb or not.

enable_acbbooleanOptional

Enable Automatic Callback or not.

enable_hot_deskingbooleanOptional

Enable hot desking feature or not.

Default: false

anonymous_outbound_callsbooleanOptional

Always make outbound anonymous calls or not.

Default: false

delivery_outbound_cidbooleanOptional

Always delivery outbound caller ID or not.

Default: true

smsstring · enumOptional

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

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

Default: DISABLEPossible values:

custom_optionsstringOptional

Some custom configuration options serialized as json string

voicemail_promptstringOptional

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_pinbooleanOptional

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

Default: true

voicemail_pinstring · min: 6 · max: 10Optional

The PIN number for accessing.
The PIN policies include:

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

enable_voicemail_notifybooleanOptional

Enable voicemail to email notify.

Default: false

voicemail_play_datetimestring · enumOptional

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.

Possible values:

interfacestring · enumOptional

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

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

Possible values:

preferred_transportstring · enumOptional

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Possible values:

Responses

200

OK

No content

4XX

Error

post

/users/{id}

POST /api/users/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3251

{
  "email": "[email protected]",
  "display_name": "text",
  "enabled": true,
  "mobile_phone": "text",
  "work_phone": "text",
  "home_phone": "text",
  "address": "text",
  "department": "text",
  "enable_audio_recording": false,
  "enable_video_recording": false,
  "enable_dnd": true,
  "enable_acb": true,
  "enable_hot_desking": false,
  "anonymous_outbound_calls": false,
  "delivery_outbound_cid": true,
  "sms": "DISABLE",
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "preferred": true,
      "description": "text"
    }
  ],
  "custom_options": "text",
  "office_hours": {
    "mode": "CUSTOM",
    "monday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "tuesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "wednesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "thursday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "friday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "saturday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "sunday": {
      "enabled": true,
      "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": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "tuesday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "wednesday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "thursday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "friday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "saturday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "sunday": {
          "enabled": true,
          "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"
    }
  ]
}

No content

Reset user password

post

Reset user password.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

passwordstringOptional

The password of user.

Responses

200

OK

No content

4XX

Error

post

/users/{id}/password

POST /api/users/{id}/password HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "password": "text"
}

No content

Reset user extension password

post

Reset user extension password.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

passwordstringOptional

The extension password.

Responses

200

OK

No content

4XX

Error

post

/users/{id}/extension_password

POST /api/users/{id}/extension_password HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "password": "text"
}

No content

Change user role

post

Change user role.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

rolestring · min: 1 · max: 64Optional

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

Responses

200

OK

No content

4XX

Error

post

/users/{id}/role

POST /api/users/{id}/role HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "role": "User"
}

No content

Reset user profile

post

Reset user profile.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/users/{id}/profile

POST /api/users/{id}/profile HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Bind user to ms365 account

post

Bind user to ms365 account.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

idstringOptional

The OID or Principal Name of Microsoft 365 user.

Responses

200

OK

No content

4XX

Error

post

/users/{id}/ms365_binding

POST /api/users/{id}/ms365_binding HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "id": "text"
}

No content

Unbind user from ms365 account

post

Unbind user from ms365 account.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/users/{id}/ms365_binding/destroy

POST /api/users/{id}/ms365_binding/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete a user

post

Delete a certain user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/users/{id}/destroy

POST /api/users/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retrieves user current status

get

Retrieves current status of given user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

statusstring · enumOptional

Status of extension:

ONLINE
ON_CALL
OFFLINE

Possible values:

presencestring · enumOptional

The current presence of extension:

DO_NOT_DISTURB:
AVAILABLE:
AWAY:
BUSINESS_TRIP:
LUNCH:
ON_CALL
OFFLINE

Possible values:

presence_notestring · max: 128Optional

The presence note.

enable_dndbooleanOptional

Do Not Disturb enabled or not.

enable_acbbooleanOptional

Automatic Callback enabled or not.

4XX

Error

get

/users/{id}/status

GET /api/users/{id}/status HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "ONLINE",
  "presence": "DO_NOT_DISTURB",
  "presence_note": "text",
  "registration": [
    {
      "instance_id": "text",
      "user_agent": "text",
      "application": "text",
      "ip": "text",
      "enable_push": true,
      "contact_address": "text"
    }
  ],
  "enable_dnd": true,
  "enable_acb": true
}

Delete user registration

post

Delete user registration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

instance_idstringRequired

The instance ID of registration.

Responses

204

No Content

4XX

Error

post

/users/{id}/status/{instance_id}/destroy_status

POST /api/users/{id}/status/{instance_id}/destroy_status HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retrieve balance

get

Retrieve extension's balance by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

balancenumber · doubleOptional

User balance. Precision is five digits.

4XX

Error

get

/users/{id}/balance

GET /api/users/{id}/balance HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "balance": 1
}

Update balance

post

Update extension's balance

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

balancenumber · doubleOptional

User balance. Precision is five digits.

Responses

200

OK

No content

4XX

Error

post

/users/{id}/balance

POST /api/users/{id}/balance HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "balance": 1
}

No content

List voicemail greetings

get

Retrieves a collection of greetings available to certain user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/users/{id}/greetings

GET /api/users/{id}/greetings HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "enabled": true,
      "file_name": "text",
      "file_size": 0,
      "file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
    }
  ]
}

Create voicemail greeting

post

Create a voicemail greeting for user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

file_idall ofOptional

The unique ID of the file.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

201

OK

application/json

4XX

Error

post

/users/{id}/greetings

POST /api/users/{id}/greetings HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "file_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Enable greeting

post

Set a voicemail greeting activated.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

greeting_idall ofRequired

The unique ID of greeting.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

400

Invalid extension number supplied

404

User not found

post

/users/{id}/greetings/{greeting_id}/enable

POST /api/users/{id}/greetings/{greeting_id}/enable HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Disable greeting

post

Disable user voicemail greeting.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

greeting_idall ofRequired

The unique ID of greeting.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

400

Invalid extension number supplied

404

User not found

post

/users/{id}/greetings/{greeting_id}/disable

POST /api/users/{id}/greetings/{greeting_id}/disable HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete voicemail greeting

post

Destroy a voicemail greeting from user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

greeting_idall ofRequired

The unique ID of greeting.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/users/{id}/greetings/{greeting_id}/destroy

POST /api/users/{id}/greetings/{greeting_id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List user's IP phones

get

Retrieve a collection of IP Phones.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/users/{id}/phones

GET /api/users/{id}/phones HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "mac": "text",
      "filename": "text",
      "vendor": "text",
      "model": "text",
      "password": "text",
      "language": "ENGLISH",
      "transfer": "BLIND",
      "timezone": "text",
      "ringtone": "text",
      "queue_ringtone": "text",
      "external_ringtone": "text",
      "date_format": "text",
      "time_format": "text",
      "powerled": "text",
      "backlight": "text",
      "screensaver": "text",
      "rps": true,
      "https": true,
      "codecs": [
        "text"
      ],
      "enable_lldp": false,
      "enable_vlan_wan_port": false,
      "wan_port_id": 1,
      "wan_port_priority": 1,
      "enable_vlan_pc_port": false,
      "pc_port_id": 1,
      "pc_port_priority": 1,
      "interface": "WEB_DOMAIN",
      "preferred_transport": "UDP",
      "serial_number": "text",
      "door_password1": "text",
      "door_password2": "text",
      "url": "text"
    }
  ]
}

Assign phone to user

post

Assign a phone to user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

macall ofRequired

MAC address of this IP phone.

stringOptional

MAC address.

filenamestringRequired

Template XML file name for phone provisioning.

vendorstringRequired

The phone vendor of IP phone.

modelstringRequired

The name of IP phone model.

passwordstringRequired

Password for accessing the Web interface of phone. The username remains default because most phone manufacturers do not allow modification of the user name. This is supported for some phone model, such as "Snom 300".

languagestring · enumRequired

Language for strings displayed on Phone Display LCD. Supported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.

Possible values:

transferstring · enumRequired

The transfer method for auto provision.
Can be either:

BLIND: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will directly initiate a Blind transfer to the configured number.
ATTENDED: After the IP phone is configured with the BLF of a key, during a call on the IP phone, press the key, and the phone will directly initiate an Attended transfer to the configured number.
NEW_CALL: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will initiate a new call to the configured number.

Default: BLINDPossible values:

timezonestringRequired

The timezone of phone.

ringtonestringOptional

The ringtone of phone.

queue_ringtonestringOptional

The queue ringtone of phone for queue calls or ring group calls.

external_ringtonestringOptional

The ringtone of phone for external calls.

date_formatstringOptional

The date format of phone.

time_formatstringOptional

The time format of phone.

powerledstringOptional

The power led of phone.

backlightstringOptional

The backlight of phone.

screensaverstringOptional

The screensaver of phone.

rpsbooleanOptional

Send to RPS or not.

httpsbooleanOptional

Whether to use https

codecsstring[]Required

Settings for the priority of the codecs in this phone. This indicates the first preferred codec.

enable_lldpbooleanOptional

Enable or disable Link Layer Discovery Protocol.

Default: false

enable_vlan_wan_portbooleanOptional

Enable or disable VLAN for WAN Port.

Default: false

wan_port_idinteger · min: 1 · max: 4094Optional

VLAN ID for WAN PORT.

wan_port_priorityinteger · max: 7Optional

VLAN priority for WAN Port.

enable_vlan_pc_portbooleanOptional

Enable or disable VLAN for PC Port.

Default: false

pc_port_idinteger · min: 1 · max: 4094Optional

VLAN ID for PC PORT.

pc_port_priorityinteger · max: 7Optional

VLAN priority for PC Port.

interfacestring · enumRequired

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

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

Possible values:

preferred_transportstring · enumRequired

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Possible values:

serial_numberstringOptional

The serial number of phone.

door_password1string · min: 4 · max: 8Optional

The primary door password of phone. Only numeric sequences are allowed.

door_password2string · min: 4 · max: 8Optional

The secondary door password of phone. Only numeric sequences are allowed.

Responses

201

Success

application/json

4XX

Error

post

/users/{id}/phones

POST /api/users/{id}/phones HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 625

{
  "mac": "text",
  "filename": "text",
  "vendor": "text",
  "model": "text",
  "password": "text",
  "language": "ENGLISH",
  "transfer": "BLIND",
  "timezone": "text",
  "ringtone": "text",
  "queue_ringtone": "text",
  "external_ringtone": "text",
  "date_format": "text",
  "time_format": "text",
  "powerled": "text",
  "backlight": "text",
  "screensaver": "text",
  "rps": true,
  "https": true,
  "codecs": [
    "text"
  ],
  "enable_lldp": false,
  "enable_vlan_wan_port": false,
  "wan_port_id": 1,
  "wan_port_priority": 1,
  "enable_vlan_pc_port": false,
  "pc_port_id": 1,
  "pc_port_priority": 1,
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP",
  "serial_number": "text",
  "door_password1": "text",
  "door_password2": "text"
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve user phone details

get

Retrieve phone details of user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

phone_idall ofRequired

The unique ID of phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

macall ofOptional

MAC address of this IP phone.

stringOptional

MAC address.

filenamestringOptional

Template XML file name for phone provisioning.

vendorstringOptional

The phone vendor of IP phone.

modelstringOptional

The name of IP phone model.

passwordstringOptional

Password for accessing the Web interface of phone. The username remains default because most phone manufacturers do not allow modification of the user name. This is supported for some phone model, such as "Snom 300".

languagestring · enumOptional

Language for strings displayed on Phone Display LCD. Supported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.

Possible values:

transferstring · enumOptional

The transfer method for auto provision.
Can be either:

BLIND: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will directly initiate a Blind transfer to the configured number.
ATTENDED: After the IP phone is configured with the BLF of a key, during a call on the IP phone, press the key, and the phone will directly initiate an Attended transfer to the configured number.
NEW_CALL: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will initiate a new call to the configured number.

Default: BLINDPossible values:

timezonestringOptional

The timezone of phone.

ringtonestringOptional

The ringtone of phone.

queue_ringtonestringOptional

The queue ringtone of phone for queue calls or ring group calls.

external_ringtonestringOptional

The ringtone of phone for external calls.

date_formatstringOptional

The date format of phone.

time_formatstringOptional

The time format of phone.

powerledstringOptional

The power led of phone.

backlightstringOptional

The backlight of phone.

screensaverstringOptional

The screensaver of phone.

rpsbooleanOptional

Send to RPS or not.

httpsbooleanOptional

Whether to use https

codecsstring[]Optional

Settings for the priority of the codecs in this phone. This indicates the first preferred codec.

enable_lldpbooleanOptional

Enable or disable Link Layer Discovery Protocol.

Default: false

enable_vlan_wan_portbooleanOptional

Enable or disable VLAN for WAN Port.

Default: false

wan_port_idinteger · min: 1 · max: 4094Optional

VLAN ID for WAN PORT.

wan_port_priorityinteger · max: 7Optional

VLAN priority for WAN Port.

enable_vlan_pc_portbooleanOptional

Enable or disable VLAN for PC Port.

Default: false

pc_port_idinteger · min: 1 · max: 4094Optional

VLAN ID for PC PORT.

pc_port_priorityinteger · max: 7Optional

VLAN priority for PC Port.

interfacestring · enumOptional

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

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

Possible values:

preferred_transportstring · enumOptional

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Possible values:

serial_numberstringOptional

The serial number of phone.

door_password1string · min: 4 · max: 8Optional

The primary door password of phone. Only numeric sequences are allowed.

door_password2string · min: 4 · max: 8Optional

The secondary door password of phone. Only numeric sequences are allowed.

urlstringOptional

Auto provision server URL.

4XX

Error

get

/users/{id}/phones/{phone_id}

GET /api/users/{id}/phones/{phone_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "mac": "text",
  "filename": "text",
  "vendor": "text",
  "model": "text",
  "password": "text",
  "language": "ENGLISH",
  "transfer": "BLIND",
  "timezone": "text",
  "ringtone": "text",
  "queue_ringtone": "text",
  "external_ringtone": "text",
  "date_format": "text",
  "time_format": "text",
  "powerled": "text",
  "backlight": "text",
  "screensaver": "text",
  "rps": true,
  "https": true,
  "codecs": [
    "text"
  ],
  "enable_lldp": false,
  "enable_vlan_wan_port": false,
  "wan_port_id": 1,
  "wan_port_priority": 1,
  "enable_vlan_pc_port": false,
  "pc_port_id": 1,
  "pc_port_priority": 1,
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP",
  "serial_number": "text",
  "door_password1": "text",
  "door_password2": "text",
  "url": "text"
}

Update a phone of user

post

Update phone of user by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

phone_idall ofRequired

The unique ID of phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

passwordstringOptional

Password for accessing the Web interface of phone. The username remains default because most phone manufacturers do not allow modification of the user name. This is supported for some phone model, such as "Snom 300".

languagestring · enumOptional

Language for strings displayed on Phone Display LCD. Supported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.

Possible values:

transferstring · enumOptional

The transfer method for auto provision.
Can be either:

BLIND: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will directly initiate a Blind transfer to the configured number.
ATTENDED: After the IP phone is configured with the BLF of a key, during a call on the IP phone, press the key, and the phone will directly initiate an Attended transfer to the configured number.
NEW_CALL: After the IP phone is configured with the BLF of a certain key, during a call on the IP phone, press the key, and the phone will initiate a new call to the configured number.

Default: BLINDPossible values:

timezonestringOptional

The timezone of phone.

ringtonestringOptional

The ringtone of phone.

queue_ringtonestringOptional

The queue ringtone of phone for queue calls or ring group calls.

external_ringtonestringOptional

The ringtone of phone for external calls.

date_formatstringOptional

The date format of phone.

time_formatstringOptional

The time format of phone.

powerledstringOptional

The power led of phone.

backlightstringOptional

The backlight of phone.

screensaverstringOptional

The screensaver of phone.

rpsbooleanOptional

Send to RPS or not.

httpsbooleanOptional

Whether to use https

codecsstring[]Optional

Settings for the priority of the codecs in this phone. This indicates the first preferred codec.

enable_lldpbooleanOptional

Enable or disable Link Layer Discovery Protocol.

Default: false

enable_vlan_wan_portbooleanOptional

Enable or disable VLAN for WAN Port.

Default: false

wan_port_idinteger · min: 1 · max: 4094Optional

VLAN ID for WAN PORT.

wan_port_priorityinteger · max: 7Optional

VLAN priority for WAN Port.

enable_vlan_pc_portbooleanOptional

Enable or disable VLAN for PC Port.

Default: false

pc_port_idinteger · min: 1 · max: 4094Optional

VLAN ID for PC PORT.

pc_port_priorityinteger · max: 7Optional

VLAN priority for PC Port.

interfacestring · enumOptional

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

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

Possible values:

preferred_transportstring · enumOptional

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Possible values:

serial_numberstringOptional

The serial number of phone.

door_password1string · min: 4 · max: 8Optional

The primary door password of phone. Only numeric sequences are allowed.

door_password2string · min: 4 · max: 8Optional

The secondary door password of phone. Only numeric sequences are allowed.

Responses

200

OK

No content

4XX

Error

post

/users/{id}/phones/{phone_id}

POST /api/users/{id}/phones/{phone_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 563

{
  "password": "text",
  "language": "ENGLISH",
  "transfer": "BLIND",
  "timezone": "text",
  "ringtone": "text",
  "queue_ringtone": "text",
  "external_ringtone": "text",
  "date_format": "text",
  "time_format": "text",
  "powerled": "text",
  "backlight": "text",
  "screensaver": "text",
  "rps": true,
  "https": true,
  "codecs": [
    "text"
  ],
  "enable_lldp": false,
  "enable_vlan_wan_port": false,
  "wan_port_id": 1,
  "wan_port_priority": 1,
  "enable_vlan_pc_port": false,
  "pc_port_id": 1,
  "pc_port_priority": 1,
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP",
  "serial_number": "text",
  "door_password1": "text",
  "door_password2": "text"
}

No content

Remove a user phone

post

Unassign a phone from extension.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

phone_idall ofRequired

The unique ID of phone.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/users/{id}/phones/{phone_id}/destroy

POST /api/users/{id}/phones/{phone_id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List user's holidays

get

Retrieve a collection of user's holidays.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/users/{id}/holidays

GET /api/users/{id}/holidays HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "region": "text",
      "consecutive": true,
      "every_year": true,
      "year_start": 1,
      "year_end": 1,
      "month_start": 1,
      "month_end": 1,
      "day_start": 1,
      "day_end": 1,
      "hour_start": 1,
      "hour_end": 1,
      "minute_start": 1,
      "minute_end": 1
    }
  ]
}

Create a new holiday for user

post

Create a new holiday for a user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

namestring · min: 1 · max: 64Required

The name of the holiday.

regionstringRequired

A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html

consecutivebooleanRequired

Whether the holiday consists of consecutive days.

every_yearbooleanRequired

Does the holiday take effect every year.

year_startintegerOptional

The start year of holiday.

year_endintegerOptional

The end year of holiday.

month_startintegerOptional

The start month of holiday.

month_endintegerOptional

The end month of holiday.

day_startintegerOptional

The start day of holiday.

day_endintegerOptional

The end day of holiday.

hour_startintegerOptional

The start hour of holiday.

hour_endintegerOptional

The end hour of holiday.

minute_startintegerOptional

The start minute of holiday.

minute_endintegerOptional

The end minute of holiday.

Responses

201

Created

application/json

4XX

Error

post

/users/{id}/holidays

POST /api/users/{id}/holidays HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 212

{
  "name": "text",
  "region": "text",
  "consecutive": true,
  "every_year": true,
  "year_start": 1,
  "year_end": 1,
  "month_start": 1,
  "month_end": 1,
  "day_start": 1,
  "day_end": 1,
  "hour_start": 1,
  "hour_end": 1,
  "minute_start": 1,
  "minute_end": 1
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve a holiday of a user

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRead-onlyRequired

The unique ID of holiday.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

holiday_idall ofRead-onlyRequired

The unique ID of holiday.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofRead-onlyOptional

The unique ID of holiday.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

namestring · min: 1 · max: 64Optional

The name of the holiday.

regionstringOptional

A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html

consecutivebooleanOptional

Whether the holiday consists of consecutive days.

every_yearbooleanOptional

Does the holiday take effect every year.

year_startintegerOptional

The start year of holiday.

year_endintegerOptional

The end year of holiday.

month_startintegerOptional

The start month of holiday.

month_endintegerOptional

The end month of holiday.

day_startintegerOptional

The start day of holiday.

day_endintegerOptional

The end day of holiday.

hour_startintegerOptional

The start hour of holiday.

hour_endintegerOptional

The end hour of holiday.

minute_startintegerOptional

The start minute of holiday.

minute_endintegerOptional

The end minute of holiday.

4XX

Error

get

/users/{id}/holidays/{holiday_id}

GET /api/users/{id}/holidays/{holiday_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "region": "text",
  "consecutive": true,
  "every_year": true,
  "year_start": 1,
  "year_end": 1,
  "month_start": 1,
  "month_end": 1,
  "day_start": 1,
  "day_end": 1,
  "hour_start": 1,
  "hour_end": 1,
  "minute_start": 1,
  "minute_end": 1
}

Update a holiday for a user

post

Update a holiday that already exists.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRead-onlyRequired

The unique ID of holiday.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

holiday_idall ofRead-onlyRequired

The unique ID of holiday.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

namestring · min: 1 · max: 64Required

The name of the holiday.

regionstringOptional

A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html

consecutivebooleanRequired

Whether the holiday consists of consecutive days.

every_yearbooleanRequired

Does the holiday take effect every year.

year_startintegerOptional

The start year of holiday.

year_endintegerOptional

The end year of holiday.

month_startintegerOptional

The start month of holiday.

month_endintegerOptional

The end month of holiday.

day_startintegerOptional

The start day of holiday.

day_endintegerOptional

The end day of holiday.

hour_startintegerOptional

The start hour of holiday.

hour_endintegerOptional

The end hour of holiday.

minute_startintegerOptional

The start minute of holiday.

minute_endintegerOptional

The end minute of holiday.

Responses

200

OK

No content

4XX

Error

post

/users/{id}/holidays/{holiday_id}

POST /api/users/{id}/holidays/{holiday_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 212

{
  "name": "text",
  "region": "text",
  "consecutive": true,
  "every_year": true,
  "year_start": 1,
  "year_end": 1,
  "month_start": 1,
  "month_end": 1,
  "day_start": 1,
  "day_end": 1,
  "hour_start": 1,
  "hour_end": 1,
  "minute_start": 1,
  "minute_end": 1
}

No content

Destroy a holiday of user

post

Destroy a holiday of user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRead-onlyRequired

The unique ID of holiday.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

holiday_idall ofRead-onlyRequired

The unique ID of holiday.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

400

Invalid ID supplied.

post

/users/{id}/holidays/{holiday_id}/destroy

POST /api/users/{id}/holidays/{holiday_id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List user's global holidays

get

Retrieve a collection of global holidays.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/users/{id}/global_holidays

GET /api/users/{id}/global_holidays HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "region": "text",
      "consecutive": true,
      "every_year": true,
      "year_start": 1,
      "year_end": 1,
      "month_start": 1,
      "month_end": 1,
      "day_start": 1,
      "day_end": 1,
      "hour_start": 1,
      "hour_end": 1,
      "minute_start": 1,
      "minute_end": 1
    }
  ]
}

Update user's global holidays

post

Update global holidays from tenant holidays.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

Responses

201

Created

application/json

4XX

Error

post

/users/{id}/global_holidays

POST /api/users/{id}/global_holidays HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "items": [
    "NzAwNTUxOTA5NzczMTQ4MTYw"
  ]
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve the call queues which the user belongs

get

Retrieve the call queues which the user belongs.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/users/{id}/call_queues

GET /api/users/{id}/call_queues HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "extension_number": "text"
    }
  ]
}

Retrieve call queue agent

get

Retrieve information of call queue agent.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

queue_idall ofRequired

The unique ID of call queue.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

extension_numberall ofOptional

The extension number of agent.

string · min: 3 · max: 64Optional

The extension number.

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

display_nameall ofOptional

The display name of agent.

string · max: 1024Optional

The display name of user.

skill_levelinteger · int32 · min: 1 · max: 100Optional

The skill level of agent in queue.
Only valid when polling_strategy is skill based.

Default: 1

statusstring · enumRead-onlyOptional

Current status of agent:

READY:
NOT_READY:
QUEUE_CALL:
OTHER_CALL:
WRAP_UP:
BREAK:
LUNCH:
TRANSFER:
CONSULT_TRANSFER:
ON_HOLD:
LOGGED_OUT:
OFFLINE:

Possible values:

4XX

Error

get

/users/{id}/call_queues/{queue_id}/agent

GET /api/users/{id}/call_queues/{queue_id}/agent HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "extension_number": "text",
  "display_name": "text",
  "skill_level": 1,
  "status": "READY"
}

Set call queue agent status

post

Set call queue agent status.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

queue_idall ofRequired

The unique ID of call queue.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

statusstring · enumOptional

Change call queue agent status to one of the following:

READY:
NOT_READY:
WRAP_UP:
BREAK:
LUNCH:
LOGGED_IN:
LOGGED_OUT:

Example: READYPossible values:

Responses

200

OK

No content

4XX

Error

post

/users/{id}/call_queues/{queue_id}/agent

POST /api/users/{id}/call_queues/{queue_id}/agent HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "status": "READY"
}

No content

List speed dial 8

get

List speed dial 8.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/users/{id}/speed_dial_8

GET /api/users/{id}/speed_dial_8 HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "code": "text",
      "phone_number": "text",
      "description": "text"
    }
  ]
}

Add new speed dial 8

post

Create new speed dial 8.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

codestring · min: 1 · max: 1Required

The speed dial 8 dialing code.
Available code range from 2 to 9.

phone_numberstringRequired

The phone number that you want to call.

descriptionstring · max: 1024Optional

The description of speed dial.

Responses

201

Created

application/json

4XX

Error

post

/users/{id}/speed_dial_8

POST /api/users/{id}/speed_dial_8 HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "code": "text",
  "phone_number": "text",
  "description": "text"
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve details of speed dial 8

get

Retrieve details of speed dial 8 by it's ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

dial_idall ofRequired

The unique ID of speed dial.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of speed dial.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

codestring · min: 1 · max: 1Optional

The speed dial 8 dialing code.
Available code range from 2 to 9.

phone_numberstringOptional

The phone number that you want to call.

descriptionstring · max: 1024Optional

The description of speed dial.

4XX

Error

get

/users/{id}/speed_dial_8/{dial_id}

GET /api/users/{id}/speed_dial_8/{dial_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "code": "text",
  "phone_number": "text",
  "description": "text"
}

Update speed dial 8

post

Update speed dial 8.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

dial_idall ofRequired

The unique ID of speed dial.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

codestring · min: 1 · max: 1Optional

The speed dial 8 dialing code.
Available code range from 2 to 9.

phone_numberstringOptional

The phone number that you want to call.

descriptionstring · max: 1024Optional

The description of speed dial.

Responses

200

OK

No content

4XX

Error

post

/users/{id}/speed_dial_8/{dial_id}

POST /api/users/{id}/speed_dial_8/{dial_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "code": "text",
  "phone_number": "text",
  "description": "text"
}

No content

Delete speed dial 8

post

Remove speed dial 8 by ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

dial_idall ofRequired

The unique ID of speed dial.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/users/{id}/speed_dial_8/{dial_id}/destroy

POST /api/users/{id}/speed_dial_8/{dial_id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List speed dial 100

get

List speed dial 100.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/users/{id}/speed_dial_100

GET /api/users/{id}/speed_dial_100 HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "code": "text",
      "phone_number": "text",
      "description": "text"
    }
  ]
}

Add new speed dial 100

post

Create new speed dial 100.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

codestring · min: 2 · max: 2Required

The speed dial 100 dialing code.
Available code range from 00 to 99.

phone_numberstringRequired

The phone number that you want to call.

descriptionstring · max: 1024Optional

The description of speed dial.

Responses

201

Created

application/json

4XX

Error

post

/users/{id}/speed_dial_100

POST /api/users/{id}/speed_dial_100 HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "code": "text",
  "phone_number": "text",
  "description": "text"
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve details of speed dial 100

get

Retrieve details of speed dial 100 by it's ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

dial_idall ofRequired

The unique ID of speed dial.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of speed dial.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

codestring · min: 2 · max: 2Optional

The speed dial 100 dialing code.
Available code range from 00 to 99.

phone_numberstringOptional

The phone number that you want to call.

descriptionstring · max: 1024Optional

The description of speed dial.

4XX

Error

get

/users/{id}/speed_dial_100/{dial_id}

GET /api/users/{id}/speed_dial_100/{dial_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "code": "text",
  "phone_number": "text",
  "description": "text"
}

Update speed dial 100

post

Update speed dial 100.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

dial_idall ofRequired

The unique ID of speed dial.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

codestring · min: 2 · max: 2Optional

The speed dial 100 dialing code.
Available code range from 00 to 99.

phone_numberstringOptional

The phone number that you want to call.

descriptionstring · max: 1024Optional

The description of speed dial.

Responses

200

OK

No content

4XX

Error

post

/users/{id}/speed_dial_100/{dial_id}

POST /api/users/{id}/speed_dial_100/{dial_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "code": "text",
  "phone_number": "text",
  "description": "text"
}

No content

Delete speed dial 100

post

Remove speed dial 100 by ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

dial_idall ofRequired

The unique ID of speed dial.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/users/{id}/speed_dial_100/{dial_id}/destroy

POST /api/users/{id}/speed_dial_100/{dial_id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List user groups

get

Get a collection of user groups.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get

/groups

GET /api/groups HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "description": "text"
    }
  ]
}

Create an user group

post

Create a new user group.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestring · min: 1 · max: 64Optional

The name of user group.

descriptionstring · max: 1024Optional

The description of user group.

Responses

201

Created user group

application/json

4XX

Error

post

/groups

POST /api/groups HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "name": "text",
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "description": "text"
    }
  ],
  "description": "text"
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve an user group

get

Retrieves the properties of an user group.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

idall ofOptional

The unique ID of user group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

namestring · min: 1 · max: 64Optional

The name of user group.

descriptionstring · max: 1024Optional

The description of user group.

4XX

Error

get

/groups/{id}

GET /api/groups/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "description": "text"
    }
  ],
  "description": "text"
}

Update an user group.

post

Update an user group

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

namestring · min: 1 · max: 64Optional

The name of user group.

descriptionstring · max: 1024Optional

The description of user group.

Responses

200

OK

No content

4XX

Error

post

/groups/{id}

POST /api/groups/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "name": "text",
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "description": "text"
    }
  ],
  "description": "text"
}

No content

Delete an user group

post

Delete a certain user group.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

400

Invalid user number supplied

404

User not found

post

/groups/{id}/destroy

POST /api/groups/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List user group members

get

Retrieve a collection of user group members.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/groups/{id}/members

GET /api/groups/{id}/members HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "display_name": "text",
      "extension_number": "text"
    }
  ]
}

Check user group member

get

Check if extension is in user group.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

extension_numberstring · min: 3 · max: 64Required

The extension number.

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

Responses

200

OK

application/json

idall ofOptional

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

namestring · min: 1 · max: 64Optional

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.

display_namestring · max: 1024Optional

The display name of user.

extension_numberstring · min: 3 · max: 64Optional

The extension number.

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

404

Not Found

get

/groups/{id}/members/{extension_number}

GET /api/groups/{id}/members/{extension_number} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "display_name": "text",
  "extension_number": "text"
}

Add user group member

post

Add user member into group.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

extension_numberstring · min: 3 · max: 64Required

The extension number.

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

Responses

200

OK

No content

4XX

Error

post

/groups/{id}/members/{extension_number}

POST /api/groups/{id}/members/{extension_number} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete group member

post

Delete an user group member.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user group.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

extension_numberstring · min: 3 · max: 64Required

The extension number.

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

Responses

204

No Content

4XX

Error

post

/groups/{id}/members/{extension_number}/destroy

POST /api/groups/{id}/members/{extension_number}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

hashtagList roles

hashtagCreate a role

hashtagRetrieve a role

hashtagUpdate a role

hashtagDelete a role

hashtagRetrieve current user

hashtagUpdate current user properties.

hashtagReset current user password

hashtagReset current user extension password

hashtagReset current user profile

hashtagRetrieves current user status

hashtagSet current extension user presence

hashtagRetrieve current user balance.

hashtagList current user voicemail greetings

hashtagCreate voicemail greeting for current user

hashtagEnable one of current user's greetings.

hashtagDisable current user greeting

hashtagDelete voicemail greeting

hashtagList current user's IP phones

hashtagAssign phone to current user

hashtagRetrieve current user phone details

hashtagUpdate a phone of current user

hashtagRemove a phone of current user

hashtagList user call detail records

hashtagRetrieve user call detail record

hashtagCreate new personal cdr sync token

hashtagList personal cdr changes

hashtagList user external messages

hashtagRetrieve user external message

hashtagList user call recordings

hashtagRetrieve an user call recording

hashtagDelete user call recording

hashtagList speed dial 8

hashtagAdd new speed dial 8

hashtagRetrieve details of speed dial 8

hashtagUpdate speed dial 8

hashtagDelete speed dial 8

hashtagList speed dial 100

hashtagAdd new speed dial 100

hashtagRetrieve details of speed dial 100

hashtagUpdate speed dial 100

hashtagDelete speed dial 100

hashtagList user meetings

hashtagCreate a Meeting

hashtagRetrieve a meeting

hashtagUpdate a meeting

hashtagDelete meeting

hashtagGet meeting status

hashtagMute meeting

hashtagUnmute meeting

hashtagLock meeting

hashtagUnlock meeting

hashtagStart meeting

hashtagStop meeting

hashtagStart recording in meeting

hashtagStop recording in meeting

hashtagList meeting participants

hashtagUpdate meeting participants layout

hashtagGet meeting participant details

hashtagInvite meeting participant

hashtagMute meeting participant

hashtagUnmute meeting participant

hashtagTransfer meeting ownership

hashtagSet meeting participant position

hashtagKick out meeting participant

hashtagList current user's holidays

hashtagCreate a new holiday for current user

hashtagRetrieve a holiday of current user

hashtagUpdate a holiday of current user

hashtagDestroy a holiday of current user

hashtagList current user's global holidays

hashtagUpdate current user's global holidays

hashtagList personal contact

hashtagAdd a new personal contact

hashtagRetrieve personal contact details

hashtagUpdate a personal contact

hashtagFavorite a personal contact

hashtagUnfavorite a personal contact

hashtagDelete a personal contact

hashtagCreate new personal contact sync token

List roles

Create a role

Retrieve a role

Update a role

Delete a role

Retrieve current user

Update current user properties.

Reset current user password

Reset current user extension password

Reset current user profile

Retrieves current user status

Set current extension user presence

Retrieve current user balance.

List current user voicemail greetings

Create voicemail greeting for current user

Enable one of current user's greetings.

Disable current user greeting

Delete voicemail greeting

List current user's IP phones

Assign phone to current user

Retrieve current user phone details

Update a phone of current user

Remove a phone of current user

List user call detail records

Retrieve user call detail record

Create new personal cdr sync token

List personal cdr changes

List user external messages

Retrieve user external message

List user call recordings

Retrieve an user call recording

Delete user call recording

List speed dial 8

Add new speed dial 8

Retrieve details of speed dial 8

Update speed dial 8

Delete speed dial 8

List speed dial 100

Add new speed dial 100

Retrieve details of speed dial 100

Update speed dial 100

Delete speed dial 100

List user meetings

Create a Meeting

Retrieve a meeting

Update a meeting

Delete meeting

Get meeting status

Mute meeting

Unmute meeting

Lock meeting

Unlock meeting

Start meeting

Stop meeting

Start recording in meeting

Stop recording in meeting

List meeting participants

Update meeting participants layout

Get meeting participant details

Invite meeting participant

Mute meeting participant

Unmute meeting participant

Transfer meeting ownership

Set meeting participant position

Kick out meeting participant

List current user's holidays

Create a new holiday for current user

Retrieve a holiday of current user

Update a holiday of current user

Destroy a holiday of current user

List current user's global holidays

Update current user's global holidays

List personal contact

Add a new personal contact

Retrieve personal contact details

Update a personal contact

Favorite a personal contact

Unfavorite a personal contact

Delete a personal contact

Create new personal contact sync token