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.
100OK
Total number of resource.
100Error
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.OperationsAdmin: the operations administrator.SiteAdmin: the site administrator.Dealer: the sales manager has all sold tenant resource permissions.Admin: the admin has all tenant-wide resource permissions.StandardUser: the user all user-wide resource permissions.StandardInternationalUser: the user all user-wide resource permissions with international call permissions.QueueManager: The call queue manager.
UserThe permission string.
Role's description.
OK
NzAwNTUxOTA5NzczMTQ4MTYwError
NzAwNTUxOTA5NzczMTQ4MTYwOK
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.OperationsAdmin: the operations administrator.SiteAdmin: the site administrator.Dealer: the sales manager has all sold tenant resource permissions.Admin: the admin has all tenant-wide resource permissions.StandardUser: the user all user-wide resource permissions.StandardInternationalUser: the user all user-wide resource permissions with international call permissions.QueueManager: The call queue manager.
UserWhether role is protected.
falseThe permission string.
Role's description.
Error
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.OperationsAdmin: the operations administrator.SiteAdmin: the site administrator.Dealer: the sales manager has all sold tenant resource permissions.Admin: the admin has all tenant-wide resource permissions.StandardUser: the user all user-wide resource permissions.StandardInternationalUser: the user all user-wide resource permissions with international call permissions.QueueManager: The call queue manager.
UserThe permission string.
Role's description.
OK
No content
Error
No content
OK
NzAwNTUxOTA5NzczMTQ4MTYwThe 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 email address.
example@example.comThe display name of user.
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.OperationsAdmin: the operations administrator.SiteAdmin: the site administrator.Dealer: the sales manager has all sold tenant resource permissions.Admin: the admin has all tenant-wide resource permissions.StandardUser: the user all user-wide resource permissions.StandardInternationalUser: the user all user-wide resource permissions with international call permissions.QueueManager: The call queue manager.
UserNzAwNTUxOTA5NzczMTQ4MTYwRoles 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.OperationsAdmin: the operations administrator.SiteAdmin: the site administrator.Dealer: the sales manager has all sold tenant resource permissions.Admin: the admin has all tenant-wide resource permissions.StandardUser: the user all user-wide resource permissions.StandardInternationalUser: the user all user-wide resource permissions with international call permissions.QueueManager: The call queue manager.
UserAllows 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.
The extension number.
[0-9]{3,64}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.
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:
Enable ai transcript or not.
The transport protocol:
Can be either:
UDP:TCP:TLS:
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 name of the file.
The file size in bytes.
0The relative path to file url for file downloading.
/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcKNzAwNTUxOTA5NzczMTQ4MTYwThe account provider.
The account provider ID.
The synchronization method.
Is login to the app allowed.
Is it allowed to log in to the teams phone app.
The IANA Time Zone names, such as "Asia/Shanghai".
Enable selective call acceptations or not.
falseEnable selective call rejections or not.
falseError
The email address.
example@example.comThe 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.
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:
Enable ai transcript or not.
Enable user-agent of app or not.
Enable enable teams phone app or not.
NzAwNTUxOTA5NzczMTQ4MTYwThe IANA Time Zone names, such as "Asia/Shanghai".
Enable selective call acceptations or not.
falseEnable selective call rejections or not.
falseOK
No content
Error
No content
The extension password.
The extension password.
OK
No content
Error
No content
OK
Status of extension:
ONLINEOFFLINEONCALL
The current presence of extension:
DO_NOT_DISTURB:AWAY:BUSINESS_TRIP:LUNCH:OFFLINEONLINE
The presence note.
Do Not Disturb enabled or not.
Automatic Callback enabled or not.
Error
The specified presence of the extension.
ONLINELUNCHBUSINESS_TRIPDO_NOT_DISTURBAWAY
The presence note.
OK
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwOK
NzAwNTUxOTA5NzczMTQ4MTYwError
NzAwNTUxOTA5NzczMTQ4MTYwOK
No content
Invalid extension number supplied
User not found
No content
NzAwNTUxOTA5NzczMTQ4MTYwOK
No content
Invalid extension number supplied
User not found
No content
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.
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
The list of currently enabled codec formats.
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.
Success
NzAwNTUxOTA5NzczMTQ4MTYwError
NzAwNTUxOTA5NzczMTQ4MTYwOK
NzAwNTUxOTA5NzczMTQ4MTYwMAC 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.
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
The list of currently enabled codec formats.
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.
Auto provision server URL.
Error
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.
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
The list of currently enabled codec formats.
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.
OK
No content
Error
No content
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:28ZCreated
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.Error
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.OK
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.Error
NzAwNTUxOTA5NzczMTQ4MTYwOK
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwThe sender number of the message.
The sender name of the message.
The receiver number of the message.
The receiver name of the message.
The channel name of the message.
The channel number of the message.
The brand of the message.
The did of the message.
The type of message:
Can be either:
UNKNOWN:SMS:WHATSAPP:
The direction of message:
IN:OUT:
The content of the message.
The reason of the message.
The delivery status of message:
Can be either:
ERR:SENT:RECV:DELIVERED:
The provider message ID of the message.
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:28ZError
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.
100OK
Total number of resource.
100Error
ID from a /voicemails or /recordings item used to create the transcription.
Type of the source item. Allowed values are CALL_RECORD_ITEM or VOICE_MAIL_ITEM.
Successfully created
List of created transcription IDs.
Invalid parameters
Internal server error
The resource ID from /recordings or /voicemails to retrieve transcription records for.
Transcription details retrieved successfully
The unique ID of the transcription record.
The item ID of the original recording.
NzAwNTUxOTA5NzczMTQ4MTYwThe file ID associated with the transcription.
The relative path to file url for file downloading.
/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcKType of the source item. Allowed values are CALL_RECORD_ITEM or VOICE_MAIL_ITEM.
The caller number of the call.
The callee number of the call.
The unique ID of the transcription.
The unique ID of the analysis result.
AI transcription status.
- TranscriptionNotStarted
- TranscriptionQuotaLimited
- TranscriptionRunning
- TranscriptionFailed
- TranscriptionSucceeded
- AnalyzeRunning
- AnalyzeFailed
- AnalyzeSucceeded
- TranscriptionUploadFailed
- TranscriptionOtherFailed
AI transcription status description.
Display version of the AI transcription in JSON format.
AI-generated summary of the transcription.
AI transcription sentiment.
SENTIMENT_POSITIVE: positiveSENTIMENT_NEUTRAL: neutralSENTIMENT_NEGATIVE: negative
Time at which the transcription record was created.
Transcription not found
The primary key ID of the transcription record to update.
Transcription display content (JSON string).
Intelligent summary content.
AI transcription sentiment.
SENTIMENT_POSITIVE: positiveSENTIMENT_NEUTRAL: neutralSENTIMENT_NEGATIVE: negative
Transcription updated successfully
No content
Transcription updated successfully
No content
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.
Created
NzAwNTUxOTA5NzczMTQ4MTYwError
NzAwNTUxOTA5NzczMTQ4MTYwOK
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.
Error
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.
OK
No content
Error
No content
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.
Created
NzAwNTUxOTA5NzczMTQ4MTYwError
NzAwNTUxOTA5NzczMTQ4MTYwOK
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.
Error
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.
OK
No content
Error
No content
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.
100OK
Total number of resource.
100Error
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 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 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 unique ID of user.
NzAwNTUxOTA5NzczMTQ4MTYwThe invitees to send invitation emails to.
Whether to close the meeting if the nobody in.
falseSome custom configuration options serialized as json string
Created
NzAwNTUxOTA5NzczMTQ4MTYwThe extension number.
[0-9]{3,64}Error
NzAwNTUxOTA5NzczMTQ4MTYwOK
NzAwNTUxOTA5NzczMTQ4MTYwThe extension number.
[0-9]{3,64}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 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 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 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 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 unique ID of user.
NzAwNTUxOTA5NzczMTQ4MTYwThe invitees to send invitation emails to.
Whether to close the meeting if the nobody in.
falseThe SIP domain of tenant.
It is usually a fully qualified domain name (FQDN).
If there is no FQDN, you can also use the IP address of the PBX server as the SIP domain.
The SIP domain name is only used for SIP message authentication and does not require analysis.
The SBC domain.
A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port
80Access token to be passed as a header
4DFCF1D4C30B4D798ECE3AE43769F008.Whether the user has ownership of the meeting.
Some custom configuration options serialized as json string
Error
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 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 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 unique ID of user.
NzAwNTUxOTA5NzczMTQ4MTYwThe invitees to send invitation emails to.
Whether to close the meeting if the nobody in.
falseSome custom configuration options serialized as json string
OK
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwOK
The conference room status. Can be either:
ONLINE:OFFLINE:ON_CALL:
Whether the conference room was locked.
Whether the conference room was muted.
Whether the conference room is recording.
Error
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwOK
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwOK
NzAwNTUxOTA5NzczMTQ4MTYwThe display name of conference room participant.
"example"<sip:100@example.com>Whether the participant is muted.
Indicates whether the user is chairman of the conference room.
The position of room member.
The member will not be displayed when -1 is specified.
Error
NzAwNTUxOTA5NzczMTQ4MTYwThe number of invited participant.
OK
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwOK
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwOK
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwOK
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwThe position of room member.
The member will not be displayed when -1 is specified.
OK
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwNo Content
No content
Error
No content
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
Does the holiday take effect every year.
Whether the holiday consists of consecutive days.
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.
Created
NzAwNTUxOTA5NzczMTQ4MTYwError
The unique ID of the holiday.
NzAwNTUxOTA5NzczMTQ4MTYwOK
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
Does the holiday take effect every year.
Whether the holiday consists of consecutive days.
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.
Error
The unique ID of holiday.
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwThe 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
Does the holiday take effect every year.
Whether the holiday consists of consecutive days.
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.
OK
No content
Error
No content
The unique ID of the holiday.
NzAwNTUxOTA5NzczMTQ4MTYwNo Content
No content
Invalid ID supplied.
No content
A collection of ID of tenant's holiday.
NzAwNTUxOTA5NzczMTQ4MTYwOK
No content
Error
No content
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.
100OK
Total number of resource.
100Error
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.
Created contact
NzAwNTUxOTA5NzczMTQ4MTYwError
NzAwNTUxOTA5NzczMTQ4MTYwOK
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.
The synchronization method.
Mark if a contact has been added to the favorites list.
trueError
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.
OK
No content
Error
No content
Created
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.Error
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.OK
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.Error
Created
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.Error
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.OK
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.Error
Created
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.Error
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.OK
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.Error
Created
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.Error
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.OK
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.Error
NzAwNTUxOTA5NzczMTQ4MTYwOK
The extension number.
[0-9]{3,64}The display name of user.
The skill level of agent in queue.
Only valid when polling_strategy is skill based.
1Current status of agent:
READY:NOT_READY:QUEUE_CALL:OTHER_CALL:WRAP_UP:BREAK:LUNCH:TRANSFER:CONSULT_TRANSFER:ON_HOLD:LOGGED_OUT:OFFLINE:
The reason for changing a call queue agent's status.
Standard presets include:
NOT_RAEDYLUNCHBUSINESS_TRIPDO_NOT_DISTURBAWAY
You can also provide a custom string for a custom reason.
Note: This field is only effective when settingstatustoNOT_READY.
For other statuses, this field will be ignored.
The reason field is optional and can be left empty.
NOT_RAEDYError
NzAwNTUxOTA5NzczMTQ4MTYwChange call queue agent status to one of the following:
READY:NOT_READY:WRAP_UP:LOGGED_IN:LOGGED_OUT:
READYPossible values: The reason for changing a call queue agent's status.
Standard presets include:
NOT_RAEDYLUNCHBUSINESS_TRIPDO_NOT_DISTURBAWAY
You can also provide a custom string for a custom reason.
Note: This field is only effective when settingstatustoNOT_READY.
For other statuses, this field will be ignored.
The reason field is optional and can be left empty.
NOT_RAEDYOK
No content
Error
No content
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.
100OK
Total number of resource.
100Error
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.
example@example.comThe 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.OperationsAdmin: the operations administrator.SiteAdmin: the site administrator.Dealer: the sales manager has all sold tenant resource permissions.Admin: the admin has all tenant-wide resource permissions.StandardUser: the user all user-wide resource permissions.StandardInternationalUser: the user all user-wide resource permissions with international call permissions.QueueManager: The call queue manager.
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.
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:
Enable ai transcript or not.
Enable user-agent of app or not.
Enable enable teams phone app or not.
The template file name used to generate the user configuration file for the soft phone.
app.xmlThe IANA Time Zone names, such as "Asia/Shanghai".
Enable selective call acceptations or not.
falseEnable selective call rejections or not.
falseCreated
NzAwNTUxOTA5NzczMTQ4MTYwError
NzAwNTUxOTA5NzczMTQ4MTYwOK
NzAwNTUxOTA5NzczMTQ4MTYwThe 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 email address.
example@example.comThe display name of user.
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.OperationsAdmin: the operations administrator.SiteAdmin: the site administrator.Dealer: the sales manager has all sold tenant resource permissions.Admin: the admin has all tenant-wide resource permissions.StandardUser: the user all user-wide resource permissions.StandardInternationalUser: the user all user-wide resource permissions with international call permissions.QueueManager: The call queue manager.
UserNzAwNTUxOTA5NzczMTQ4MTYwRoles 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.OperationsAdmin: the operations administrator.SiteAdmin: the site administrator.Dealer: the sales manager has all sold tenant resource permissions.Admin: the admin has all tenant-wide resource permissions.StandardUser: the user all user-wide resource permissions.StandardInternationalUser: the user all user-wide resource permissions with international call permissions.QueueManager: The call queue manager.
UserAllows 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.
The extension number.
[0-9]{3,64}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.
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:
NzAwNTUxOTA5NzczMTQ4MTYwThe 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 name of the file.
The file size in bytes.
0The relative path to file url for file downloading.
/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcKThe account provider.
The account provider ID.
The synchronization method.
Enable ai transcript or not.
Enable user-agent of app or not.
The password of user.
The extension_password of user.
Is it allowed to log in to the teams phone app.
The template file name used to generate the user configuration file for the soft phone.
app.xmlThe IANA Time Zone names, such as "Asia/Shanghai".
Enable selective call acceptations or not.
falseEnable selective call rejections or not.
falseError
NzAwNTUxOTA5NzczMTQ4MTYwThe email address.
example@example.comThe 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.
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:
Enable ai transcript or not.
Enable user-agent of app or not.
Enable enable teams phone app or not.
The template file name used to generate the user configuration file for the soft phone.
app.xmlThe IANA Time Zone names, such as "Asia/Shanghai".
Enable selective call acceptations or not.
falseEnable selective call rejections or not.
falseOK
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwThe extension password.
OK
No content
Error
No content
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.OperationsAdmin: the operations administrator.SiteAdmin: the site administrator.Dealer: the sales manager has all sold tenant resource permissions.Admin: the admin has all tenant-wide resource permissions.StandardUser: the user all user-wide resource permissions.StandardInternationalUser: the user all user-wide resource permissions with international call permissions.QueueManager: The call queue manager.
UserOK
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwThe OID or Principal Name of Microsoft 365 user.
OK
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwThe user ID of Google account.
No Content
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwOK
Status of extension:
ONLINEOFFLINEONCALL
The current presence of extension:
DO_NOT_DISTURB:AWAY:BUSINESS_TRIP:LUNCH:OFFLINEONLINE
The presence note.
Do Not Disturb enabled or not.
Automatic Callback enabled or not.
Error
NzAwNTUxOTA5NzczMTQ4MTYwThe instance ID of registration.
No Content
No content
Error
No content
The unique ID of the extension.
NzAwNTUxOTA5NzczMTQ4MTYwOK
User balance. Precision is five digits.
Error
The unique ID of the extension.
NzAwNTUxOTA5NzczMTQ4MTYwUser balance. Precision is five digits.
OK
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwOK
NzAwNTUxOTA5NzczMTQ4MTYwError
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwOK
No content
Invalid extension number supplied
User not found
No content
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwOK
No content
Invalid extension number supplied
User not found
No content
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwNo Content
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwMAC 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.
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
The list of currently enabled codec formats.
The list of all supported codec formats.
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.
Success
NzAwNTUxOTA5NzczMTQ4MTYwError
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwOK
NzAwNTUxOTA5NzczMTQ4MTYwMAC 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.
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
The list of currently enabled codec formats.
The list of all supported codec formats.
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.
Auto provision server URL.
Error
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwPassword 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.
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
The list of currently enabled codec formats.
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.
OK
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwNo Content
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwOK
Total number of resource.
100Error
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwThe 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
Does the holiday take effect every year.
Whether the holiday consists of consecutive days.
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.
Created
NzAwNTUxOTA5NzczMTQ4MTYwError
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of the holiday.
NzAwNTUxOTA5NzczMTQ4MTYwOK
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
Does the holiday take effect every year.
Whether the holiday consists of consecutive days.
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.
Error
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of the holiday.
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwThe 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
Does the holiday take effect every year.
Whether the holiday consists of consecutive days.
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.
OK
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of the holiday.
NzAwNTUxOTA5NzczMTQ4MTYwNo Content
No content
Invalid ID supplied.
No content
NzAwNTUxOTA5NzczMTQ4MTYwA collection of ID of tenant's holiday.
NzAwNTUxOTA5NzczMTQ4MTYwOK
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwOK
The extension number.
[0-9]{3,64}The display name of user.
The skill level of agent in queue.
Only valid when polling_strategy is skill based.
1Current status of agent:
READY:NOT_READY:QUEUE_CALL:OTHER_CALL:WRAP_UP:BREAK:LUNCH:TRANSFER:CONSULT_TRANSFER:ON_HOLD:LOGGED_OUT:OFFLINE:
The reason for changing a call queue agent's status.
Standard presets include:
NOT_RAEDYLUNCHBUSINESS_TRIPDO_NOT_DISTURBAWAY
You can also provide a custom string for a custom reason.
Note: This field is only effective when settingstatustoNOT_READY.
For other statuses, this field will be ignored.
The reason field is optional and can be left empty.
NOT_RAEDYError
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwChange call queue agent status to one of the following:
READY:NOT_READY:WRAP_UP:LOGGED_IN:LOGGED_OUT:
READYPossible values: OK
No content
Error
No content
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.
Created
NzAwNTUxOTA5NzczMTQ4MTYwError
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwOK
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.
Error
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwThe 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.
OK
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwNo Content
No content
Error
No content
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.
Created
NzAwNTUxOTA5NzczMTQ4MTYwError
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwOK
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.
Error
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwThe 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.
OK
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwNo Content
No content
Error
No content
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.
100OK
Total number of resource.
100Error
The name of user group.
The description of user group.
Created user group
NzAwNTUxOTA5NzczMTQ4MTYwError
NzAwNTUxOTA5NzczMTQ4MTYwOK
NzAwNTUxOTA5NzczMTQ4MTYwThe name of user group.
The description of user group.
Error
NzAwNTUxOTA5NzczMTQ4MTYwThe name of user group.
The description of user group.
OK
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwThe extension number.
[0-9]{3,64}OK
NzAwNTUxOTA5NzczMTQ4MTYwThe 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 display name of user.
The extension number.
[0-9]{3,64}Not Found
NzAwNTUxOTA5NzczMTQ4MTYwThe extension number.
[0-9]{3,64}OK
No content
Error
No content
NzAwNTUxOTA5NzczMTQ4MTYwThe extension number.
[0-9]{3,64}No Content
No content
Error
No content
Last updated
Was this helpful?