Users
Manage extension users.
List a collection of roles.
Use the filter query parameter to retrieve just a subset of a collection.
Use the search query parameter to restrict the results of a request to match a search criterion.
Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
Use the skip query parameter to set the number of items to skip at the start of a collection.
0Use the top query parameter to specify the page size of the result set.
100GET /api/roles HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 100,
"items": [
{
"name": "User",
"description": "text"
}
]
}Create a new role.
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 permissionsAdmin: 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.
UserRole's description.
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"
}Retrieves the settings of a role.
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 permissionsAdmin: 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.
UserGET /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"
}Modify the settings of a role.
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 permissionsAdmin: 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.
UserRoles 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 permissionsAdmin: 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.
UserRole's description.
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 certain role.
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 permissionsAdmin: 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.
UserPOST /api/roles/{name}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve details of current 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.
The email address of user.
The display name of user.
The mobile phone number of user.
The office phone number of user.
The home phone number of user.
The address.
The department of user.
Records all calls and saves audio recordings on server.
falseRecords all calls and saves video recordings on server.
falseEnable Do Not Disturb or not.
Enable Automatic Callback or not.
Enable hot desking feature or not.
falseAlways make outbound anonymous calls or not.
falseAlways delivery outbound caller ID or not.
trueThe 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.
DISABLEPossible values: Some custom configuration options serialized as json string
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.
en-USWhether the PIN is required to access voice mail of extension.
trueThe 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 to email notify.
falseAnnounces 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.
The interface type for QR code or auto provisioning.
Can be neither:
WEB_DOMAIN:PUBLIC_IPV4:PUBLIC_IPV6:PRIVATE_IPV4:PRIVATE_IPV6:SBC_DOMAIN:
The transport protocol:
Can be either:
UDP:TCP:TLS:
The unique ID of the file.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /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.
The password of user.
The password of user.
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.
The extension password.
The 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
Get status of current user.
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.
The specified presence of extension:
DO_NOT_DISTURB:AVAILABLE:AWAY:BUSINESS_TRIP:LUNCH:
The presence note.
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
Retrieves a collection of greetings for current user.
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.
The unique ID of the file.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /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"
}Set one of current user's greetings to activated state.
The unique ID of greeting.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/greetings/{id}/enable HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Disable current user voicemail greeting by it's unique ID.
The unique ID of greeting.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/greetings/{id}/disable HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Destroy a voicemail greeting from user.
The unique ID of greeting.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/greetings/{id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve a collection of IP Phones for current user.
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 a phone to current user.
MAC address of this IP phone.
MAC address.
Template XML file name for phone provisioning.
The phone vendor of IP phone.
The name of IP phone model.
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".
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.
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.
BLINDPossible values: The timezone of phone.
The ringtone of phone.
The queue ringtone of phone for queue calls or ring group calls.
The ringtone of phone for external calls.
The date format of phone.
The time format of phone.
The power led of phone.
The backlight of phone.
The screensaver of phone.
Send to RPS or not.
Whether to use https
Settings for the priority of the codecs in this phone. This indicates the first preferred codec.
Enable or disable Link Layer Discovery Protocol.
falseEnable or disable VLAN for WAN Port.
falseVLAN ID for WAN PORT.
VLAN priority for WAN Port.
Enable or disable VLAN for PC Port.
falseVLAN ID for PC PORT.
VLAN priority for PC Port.
The interface type for QR code or auto provisioning.
Can be neither:
WEB_DOMAIN:PUBLIC_IPV4:PUBLIC_IPV6:PRIVATE_IPV4:PRIVATE_IPV6:SBC_DOMAIN:
The transport protocol:
Can be either:
UDP:TCP:TLS:
The serial number of phone.
The primary door password of phone. Only numeric sequences are allowed.
The secondary door password of phone. Only numeric sequences are allowed.
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 phone details of current user.
The unique ID of phone.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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 phone of current user by it's unique ID.
The unique ID of phone.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPassword 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".
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.
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.
BLINDPossible values: The timezone of phone.
The ringtone of phone.
The queue ringtone of phone for queue calls or ring group calls.
The ringtone of phone for external calls.
The date format of phone.
The time format of phone.
The power led of phone.
The backlight of phone.
The screensaver of phone.
Send to RPS or not.
Whether to use https
Settings for the priority of the codecs in this phone. This indicates the first preferred codec.
Enable or disable Link Layer Discovery Protocol.
falseEnable or disable VLAN for WAN Port.
falseVLAN ID for WAN PORT.
VLAN priority for WAN Port.
Enable or disable VLAN for PC Port.
falseVLAN ID for PC PORT.
VLAN priority for PC Port.
The interface type for QR code or auto provisioning.
Can be neither:
WEB_DOMAIN:PUBLIC_IPV4:PUBLIC_IPV6:PRIVATE_IPV4:PRIVATE_IPV6:SBC_DOMAIN:
The transport protocol:
Can be either:
UDP:TCP:TLS:
The serial number of phone.
The primary door password of phone. Only numeric sequences are allowed.
The secondary door password of phone. Only numeric sequences are allowed.
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 profile from current user.
The unique ID of phone.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/phones/{id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve a collection of user call detail records.
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.
The unique ID of CDR.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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"
}
}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
2017-07-21T17:32:28ZPOST /api/user/cdrs/sync_tokens HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"token": "RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo."
}List personal cdr changes.
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.
RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo.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
}
]
}
]
}Retrieve a collection of 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.
The unique ID of external message.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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"
}Retrieve a collection of user call recordings.
Use the filter query parameter to retrieve just a subset of a collection.
Use the search query parameter to restrict the results of a request to match a search criterion.
Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
Use the skip query parameter to set the number of items to skip at the start of a collection.
0Use the top query parameter to specify the page size of the result set.
100GET /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"
}
]
}Get details of an user call recording.
The unique ID of call recording.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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 an user call recording
The unique ID of call recording.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/recordings/{id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
List 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"
}
]
}Create new speed dial 8.
The speed dial 8 dialing code.
Available code range from 2 to 9.
The phone number that you want to call.
The description of speed dial.
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 by it's ID.
The unique ID of speed dial.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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.
The unique ID of speed dial.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe speed dial 8 dialing code.
Available code range from 2 to 9.
The phone number that you want to call.
The description of speed dial.
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
Remove speed dial 8 by ID.
The unique ID of speed dial.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /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 /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"
}
]
}Create new speed dial 100.
The speed dial 100 dialing code.
Available code range from 00 to 99.
The phone number that you want to call.
The description of speed dial.
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 by it's ID.
The unique ID of speed dial.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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.
The unique ID of speed dial.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe speed dial 100 dialing code.
Available code range from 00 to 99.
The phone number that you want to call.
The description of speed dial.
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
Remove speed dial 100 by ID.
The unique ID of speed dial.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/speed_dial_100/{id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve a collection of meetings.
Use the filter query parameter to retrieve just a subset of a collection.
Use the search query parameter to restrict the results of a request to match a search criterion.
Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
Use the skip query parameter to set the number of items to skip at the start of a collection.
0Use the top query parameter to specify the page size of the result set.
100GET /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.
The conference room mode.
Can be either:
AUDIO: audio conference room.VIDEO: video conference room.
The conference control type.
Can be either:
FREE: the free mode.MASTER: the master mode.
FREEPossible values: The height for video conference room.
Only valid in VIDEO mode.
720The width for video conference room.
Only valid in VIDEO mode.
1280The transmission rate for video conference room.
Only valid in VIDEO mode.
1024The framerate for video conference room.
Only valid in VIDEO mode.
15The number of grids allowed for video conference room.
Only valid in VIDEO mode.
Can be either:
- LAYOUT0:
- LAYOUT1:
- LAYOUT2:
- LAYOUT3:
- LAYOUT4:
- LAYOUT6:
- LAYOUT9:
LAYOUT0Possible values: The subject of conference room.
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.
en-USThe PIN for admin of the conference room. Only numeric sequences are allowed.
The PIN for the conference room. Only numeric sequences are allowed.
Whether to enable recording when created.
falseWhether to enable voice menu.
trueThe IANA Time Zone names, such as "Asia/Shanghai".
The scheduled start time of meeting.
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
2017-07-21T17:32:28ZThe scheduled end time of meeting.
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
2017-07-21T17:32:28ZThe invitees to send invitation emails to.
Whether to close the meeting if the nobody in.
falseSome custom configuration options serialized as json string
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.
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe conference control type.
Can be either:
FREE: the free mode.MASTER: the master mode.
FREEPossible values: The height for video conference room.
Only valid in VIDEO mode.
720The width for video conference room.
Only valid in VIDEO mode.
1280The transmission rate for video conference room.
Only valid in VIDEO mode.
1024The framerate for video conference room.
Only valid in VIDEO mode.
15The number of grids allowed for video conference room.
Only valid in VIDEO mode.
Can be either:
- LAYOUT0:
- LAYOUT1:
- LAYOUT2:
- LAYOUT3:
- LAYOUT4:
- LAYOUT6:
- LAYOUT9:
LAYOUT0Possible values: The subject of conference room.
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.
en-USThe maximum number of participants allowed in the room.
9The PIN for admin of the conference room. Only numeric sequences are allowed.
The PIN for the conference room. Only numeric sequences are allowed.
Whether to enable recording when created.
falseWhether to enable voice menu.
trueThe IANA Time Zone names, such as "Asia/Shanghai".
The scheduled start time of meeting.
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
2017-07-21T17:32:28ZThe scheduled end time of meeting.
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
2017-07-21T17:32:28ZThe invitees to send invitation emails to.
Whether to close the meeting if the nobody in.
falseSome custom configuration options serialized as json string
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
Destroy a conference room
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/meetings/{id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve meeting status.
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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.
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/meetings/{id}/mute HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Unmute meeting by it's unique ID.
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/meetings/{id}/unmute HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Lock meeting by it's unique ID.
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/meetings/{id}/lock HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Unlock meeting by it's unique ID.
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/meetings/{id}/unlock HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Start meeting by it's unique ID.
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/meetings/{id}/start HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Stop meeting by it's unique ID.
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/meetings/{id}/stop HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Start recording in meeting.
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/meetings/{id}/start_recording HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Stop recording in meeting.
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/meetings/{id}/stop_recording HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve a collection of meeting participants.
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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
}
]
}Modify participants layout based on meeting layout.
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /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.
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of conference room participant.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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 an user as meeting participant.
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe number of invited participant.
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.
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of conference room participant.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /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.
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of conference room participant.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /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 to another participant.
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of conference room participant.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /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.
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of conference room participant.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe position of room member.
The member will not be displayed when -1 is specified.
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.
The unique ID of conference room.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of conference room participant.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/meetings/{id}/participants/{participant_id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve a collection of current user's 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.
The name of the holiday.
A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html
Whether the holiday consists of consecutive days.
Does the holiday take effect every year.
The start year of holiday.
The end year of holiday.
The start month of holiday.
The end month of holiday.
The start day of holiday.
The end day of holiday.
The start hour of holiday.
The end hour of holiday.
The start minute of holiday.
The end minute of holiday.
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"
}The unique ID of holiday.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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.
The unique ID of holiday.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe name of the holiday.
A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html
Whether the holiday consists of consecutive days.
Does the holiday take effect every year.
The start year of holiday.
The end year of holiday.
The start month of holiday.
The end month of holiday.
The start day of holiday.
The end day of holiday.
The start hour of holiday.
The end hour of holiday.
The start minute of holiday.
The end minute of holiday.
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.
The unique ID of holiday.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/holidays/{id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve a collection of current user's 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 from tenant 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"
}Retrieve a collection of personal contacts.
Use the skip query parameter to set the number of items to skip at the start of a collection.
0Use the top query parameter to specify the page size of the result set.
100GET /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
}
]
}The name of contact.
The email of contact.
The company name of contact.
The title of contact.
The business phone number of contact.
The secondary business phone number of contact.
The mobile phone number of contact.
The secondary mobile phone number of contact.
The home phone number of contact.
The secondary home phone number of contact.
The other phone number of contact.
The business fax of contact.
The home fax of contact.
The address.
The notes of contact.
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"
}Retrieves details of a personal contact.
The unique ID of contact.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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.
The unique ID of contact.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe name of contact.
The email of contact.
The company name of contact.
The title of contact.
The business phone number of contact.
The secondary business phone number of contact.
The mobile phone number of contact.
The secondary mobile phone number of contact.
The home phone number of contact.
The secondary home phone number of contact.
The other phone number of contact.
The business fax of contact.
The home fax of contact.
The address.
The notes of contact.
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.
The unique ID of contact.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/contacts/{id}/favorite HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Favorite a personal contact.
The unique ID of contact.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/contacts/{id}/unfavorite HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Delete a personal contact by it's unique id.
The unique ID of contact.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/contacts/{id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
List personal contact changes.
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.
RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo.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.
The unique ID of contact.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/business_contacts/{id}/favorite HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Favorite a business contact.
The unique ID of contact.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/business_contacts/{id}/unfavorite HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
List business contact changes.
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.
RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo.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.
The unique ID of contact.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/extension_contacts/{id}/favorite HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Favorite an extension contact.
The unique ID of contact.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/user/extension_contacts/{id}/unfavorite HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
List extension contact changes.
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.
RQ2dX9ZC7VuWlVpXXvad2dL3lyhjnN-7eOw95wXymoo.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 /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 information of call queue agent.
The unique ID of call queue.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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.
The unique ID of call queue.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwChange call queue agent status to one of the following:
READY:NOT_READY:WRAP_UP:BREAK:LUNCH:LOGGED_IN:LOGGED_OUT:
READYPossible values: 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 /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 /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 a collection of users.
Use the filter query parameter to retrieve just a subset of a collection.
Use the search query parameter to restrict the results of a request to match a search criterion.
Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
Use the skip query parameter to set the number of items to skip at the start of a collection.
0Use the top query parameter to specify the page size of the result set.
100GET /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 new user.
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.
The password of user.
The email address of user.
The display name of user.
Allows temporarily disabling the extension.
trueRoles 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 permissionsAdmin: 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.
UserThe mobile phone number of user.
The office phone number of user.
The home phone number of user.
The address.
The department of user.
The extension number.
[0-9]{3,64}The extension password.
Records all calls and saves audio recordings on server.
falseRecords all calls and saves video recordings on server.
falseEnable Do Not Disturb or not.
Enable Automatic Callback or not.
Enable hot desking feature or not.
falseAlways make outbound anonymous calls or not.
falseThe 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.
DISABLEPossible values: Always delivery outbound caller ID or not.
trueSome custom configuration options serialized as json string
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.
en-USWhether the PIN is required to access voice mail of extension.
trueThe 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 to email notify.
falseAnnounces 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.
The interface type for QR code or auto provisioning.
Can be neither:
WEB_DOMAIN:PUBLIC_IPV4:PUBLIC_IPV6:PRIVATE_IPV4:PRIVATE_IPV6:SBC_DOMAIN:
The transport protocol:
Can be either:
UDP:TCP:TLS:
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 the active user profile with the specified ID, or reset all active user profiles when id is not specified.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/users/profile HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieves the settings of a user.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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"
}Modify the settings of a user.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe email address of user.
The display name of user.
Allows temporarily disabling the extension.
trueThe mobile phone number of user.
The office phone number of user.
The home phone number of user.
The address.
The department of user.
Records all calls and saves audio recordings on server.
falseRecords all calls and saves video recordings on server.
falseEnable Do Not Disturb or not.
Enable Automatic Callback or not.
Enable hot desking feature or not.
falseAlways make outbound anonymous calls or not.
falseAlways delivery outbound caller ID or not.
trueThe 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.
DISABLEPossible values: Some custom configuration options serialized as json string
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.
en-USWhether the PIN is required to access voice mail of extension.
trueThe 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 to email notify.
falseAnnounces 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.
The interface type for QR code or auto provisioning.
Can be neither:
WEB_DOMAIN:PUBLIC_IPV4:PUBLIC_IPV6:PRIVATE_IPV4:PRIVATE_IPV6:SBC_DOMAIN:
The transport protocol:
Can be either:
UDP:TCP:TLS:
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.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe password of user.
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.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe 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.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwRoles 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 permissionsAdmin: 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.
UserPOST /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.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/users/{id}/profile HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Bind user to ms365 account.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe OID or Principal Name of Microsoft 365 user.
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.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/users/{id}/ms365_binding/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Delete a certain user.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/users/{id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieves current status of given user.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe instance ID of registration.
POST /api/users/{id}/status/{instance_id}/destroy_status HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve extension's balance by it's unique ID.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /api/users/{id}/balance HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"balance": 1
}Update extension's balance
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwUser balance. Precision is five digits.
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
Retrieves a collection of greetings available to certain user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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 a voicemail greeting for user.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of the file.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /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"
}Set a voicemail greeting activated.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of greeting.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/users/{id}/greetings/{greeting_id}/enable HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Disable user voicemail greeting.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of greeting.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/users/{id}/greetings/{greeting_id}/disable HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Destroy a voicemail greeting from user.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of greeting.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/users/{id}/greetings/{greeting_id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve a collection of IP Phones.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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 a phone to user.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwMAC address of this IP phone.
MAC address.
Template XML file name for phone provisioning.
The phone vendor of IP phone.
The name of IP phone model.
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".
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.
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.
BLINDPossible values: The timezone of phone.
The ringtone of phone.
The queue ringtone of phone for queue calls or ring group calls.
The ringtone of phone for external calls.
The date format of phone.
The time format of phone.
The power led of phone.
The backlight of phone.
The screensaver of phone.
Send to RPS or not.
Whether to use https
Settings for the priority of the codecs in this phone. This indicates the first preferred codec.
Enable or disable Link Layer Discovery Protocol.
falseEnable or disable VLAN for WAN Port.
falseVLAN ID for WAN PORT.
VLAN priority for WAN Port.
Enable or disable VLAN for PC Port.
falseVLAN ID for PC PORT.
VLAN priority for PC Port.
The interface type for QR code or auto provisioning.
Can be neither:
WEB_DOMAIN:PUBLIC_IPV4:PUBLIC_IPV6:PRIVATE_IPV4:PRIVATE_IPV6:SBC_DOMAIN:
The transport protocol:
Can be either:
UDP:TCP:TLS:
The serial number of phone.
The primary door password of phone. Only numeric sequences are allowed.
The secondary door password of phone. Only numeric sequences are allowed.
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 phone details of user.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of phone.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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 phone of user by it's unique ID.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of phone.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPassword 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".
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.
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.
BLINDPossible values: The timezone of phone.
The ringtone of phone.
The queue ringtone of phone for queue calls or ring group calls.
The ringtone of phone for external calls.
The date format of phone.
The time format of phone.
The power led of phone.
The backlight of phone.
The screensaver of phone.
Send to RPS or not.
Whether to use https
Settings for the priority of the codecs in this phone. This indicates the first preferred codec.
Enable or disable Link Layer Discovery Protocol.
falseEnable or disable VLAN for WAN Port.
falseVLAN ID for WAN PORT.
VLAN priority for WAN Port.
Enable or disable VLAN for PC Port.
falseVLAN ID for PC PORT.
VLAN priority for PC Port.
The interface type for QR code or auto provisioning.
Can be neither:
WEB_DOMAIN:PUBLIC_IPV4:PUBLIC_IPV6:PRIVATE_IPV4:PRIVATE_IPV6:SBC_DOMAIN:
The transport protocol:
Can be either:
UDP:TCP:TLS:
The serial number of phone.
The primary door password of phone. Only numeric sequences are allowed.
The secondary door password of phone. Only numeric sequences are allowed.
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
Unassign a phone from extension.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of phone.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/users/{id}/phones/{phone_id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve a collection of user's holidays.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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 a user.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe name of the holiday.
A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html
Whether the holiday consists of consecutive days.
Does the holiday take effect every year.
The start year of holiday.
The end year of holiday.
The start month of holiday.
The end month of holiday.
The start day of holiday.
The end day of holiday.
The start hour of holiday.
The end hour of holiday.
The start minute of holiday.
The end minute of holiday.
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"
}The unique ID of holiday.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of holiday.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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 that already exists.
The unique ID of holiday.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of holiday.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe name of the holiday.
A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html
Whether the holiday consists of consecutive days.
Does the holiday take effect every year.
The start year of holiday.
The end year of holiday.
The start month of holiday.
The end month of holiday.
The start day of holiday.
The end day of holiday.
The start hour of holiday.
The end hour of holiday.
The start minute of holiday.
The end minute of holiday.
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.
The unique ID of holiday.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of holiday.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/users/{id}/holidays/{holiday_id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve a collection of global holidays.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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 global holidays from tenant holidays.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /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.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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 information of call queue agent.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of call queue.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of call queue.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwChange call queue agent status to one of the following:
READY:NOT_READY:WRAP_UP:BREAK:LUNCH:LOGGED_IN:LOGGED_OUT:
READYPossible values: 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.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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"
}
]
}Create new speed dial 8.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe speed dial 8 dialing code.
Available code range from 2 to 9.
The phone number that you want to call.
The description of speed dial.
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 by it's ID.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of speed dial.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of speed dial.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe speed dial 8 dialing code.
Available code range from 2 to 9.
The phone number that you want to call.
The description of speed dial.
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
Remove speed dial 8 by ID.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of speed dial.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /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.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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"
}
]
}Create new speed dial 100.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe speed dial 100 dialing code.
Available code range from 00 to 99.
The phone number that you want to call.
The description of speed dial.
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 by it's ID.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of speed dial.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of speed dial.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe speed dial 100 dialing code.
Available code range from 00 to 99.
The phone number that you want to call.
The description of speed dial.
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
Remove speed dial 100 by ID.
The unique ID of user.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of speed dial.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/users/{id}/speed_dial_100/{dial_id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Get a collection of user groups.
Use the filter query parameter to retrieve just a subset of a collection.
Use the search query parameter to restrict the results of a request to match a search criterion.
Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
Use the skip query parameter to set the number of items to skip at the start of a collection.
0Use the top query parameter to specify the page size of the result set.
100GET /api/groups HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 100,
"items": [
{
"id": "NzAwNTUxOTA5NzczMTQ4MTYw",
"name": "text",
"description": "text"
}
]
}Create a new user group.
The name of user group.
The description of user group.
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"
}Retrieves the properties of an user group.
The unique ID of user group.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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
The unique ID of user group.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe name of user group.
The description of user group.
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 a certain user group.
The unique ID of user group.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwPOST /api/groups/{id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve a collection of user group members.
The unique ID of user group.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwGET /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 if extension is in user group.
The unique ID of user group.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe extension number.
[0-9]{3,64}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 member into group.
The unique ID of user group.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe extension number.
[0-9]{3,64}POST /api/groups/{id}/members/{extension_number} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Delete an user group member.
The unique ID of user group.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe extension number.
[0-9]{3,64}POST /api/groups/{id}/members/{extension_number}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content