Resources
Addressables
Search addressables |
Search addressables by name or list all addressables. |
Search persons |
Search or list persons. |
Search organisations |
Search or list organisations. |
Search objects |
Search or list objects. |
Get addressable |
Get extended information of an addressable. |
Create addressable |
Create an addressable and add it to the database. |
Remove addressable |
Remove an addressable from the database. |
Update Addressable |
Update the attributes of a person or an organisation. |
Get addressable image |
Get the icon of an addressable. |
Set addressable image |
Set the icon of an addressable. |
Search callables |
Search addressables by name or phone number. |
Join addressables |
Join an unknown addressable object with an addressable. |
List colleagues or employees |
List the colleagues of a person or the employees of an organisation. |
Recent contacts |
List colleagues that recently had contact with a person. |
Presence |
List user’s messages, location and status. |
Presence Group |
List user’s messages, location and status in a presence group. |
Anonymize Communication |
Anonymize communication of an addressable.{DEPRECATED, USE communications/anonymize} |
Search chattables |
Search or list chattables. |
Listed on |
Search for the lists that contain this addressable. |
Get telecom address labels |
Get the potential telecom address labels of this addressable. |
After Call Types
List after call types |
List after call types. |
Get after call type |
Retrieve information of an after call type. |
Create after call type |
Create a new after call type. |
Remove after call type |
Remove an after call type class. |
Update after call type |
Update attributes of an after call type. |
Appointment
Get appointment |
Get the appointment with the specified oid. |
Remove appointment |
Delete the appointment with the specified oid. |
Update appointment |
Update the specified appointment. |
Add appointment |
Add an appointment. |
App settings
List app settings |
List app settings. |
Get app settings |
Retrieve information of app settings. |
Create app settings |
Create a new app settings object. |
Remove app settings |
Remove an app settings object. |
Update app settings |
Update attributes of an app settings object. |
Get specific app setting |
Get value of a specific app setting. |
Update specific app setting |
Update or create a specific app setting. |
Remove specific app setting |
Delete a specific app setting. |
Attachments (Image, Audio, …)
Write attachment |
Write or update an attachment. |
Get attachment |
Get attachment contents. |
Get thumbnail |
Get thumbnail contents. |
Get attachment binary |
Get attachment contents as a binary. |
Get thumbnail binary |
Get attachment thumbnail contents as a binary. |
Attachments Maintenance
Export attachments |
Export attachments of communication objects. |
Remove attachments |
Remove attachments of communication objects. |
Shrink attachments |
Database cleaning, disk space is released. |
List attachment logs |
List attachment logs. |
Get attachment log |
Retrieve information of an attachment log. |
Audio File
List audio files |
List audio files |
Get audio file |
Retrieve information of a audio file. |
Create audio file |
Create a new audio file object. |
Remove audio file |
Remove an audio file. |
Update audio file |
Update attributes of an audio file. |
Upload Audio File |
Upload actual audio file to audio file object. |
Automated Reports
List automated reports |
List automated reports |
Get automated report |
Retrieve information of an automated report. |
Create automated teport |
Create a new automated report object. |
Update automated report |
Update attributes of an automated report. |
Remove automated report |
Remove an automated report. |
Automated report ad hoc |
Create ad hoc result from automated report. {DEPRECATED, use: Automated report - run ad hoc} |
Automated report - run ad hoc |
Create ad hoc result from automated report. |
Automated report results |
List the reports created by an automated report. |
Automated report results attachment |
Retrieve a report created by an automated report. |
Backup Schedules
List backup schedules |
List backup schedules. |
Get backup schedule |
Retrieve information of a backup schedule. |
Get backup schedule log |
Retrieve a backup schedule log file. |
Create backup schedule |
Create a new backup schedule. |
Remove backup schedule |
Remove a backup schedule. |
Update backup schedule |
Update attributes of a backup schedule. |
Start backup schedule |
Manually start backup from backup schedule. |
Get restore files |
Get list of restore files from backup schedule. |
Restore backup |
Restore backup of a backup schedule. |
Calendar
Get appointment list from addressable oid |
List the appointments from an addressable oid. |
Get appointment list from calendar oid |
List the appointments from a calendar oid. |
Channels {BETA}
Phone channels |
List the active phone channels. |
Hangup |
Hang up a channel. |
Chat
Search chattables |
Search or list chattables. |
Get addressable chat |
Get the chat session with an addressable. |
Send chat to addressable |
Send a chat message to an addressable. {DEPRICATED use Send chat message} |
Get chat session |
Get chat session information. |
Get chat messages |
Get chat session’s messages. |
Get chat attachment |
Get the attachment of a chat message. {DEPRICATED, USE Get Communication Attachment} |
Send chat message |
Send a chat message. |
Forward chat message |
Forward a chat message to another session. |
Forward chat communication |
Forward to a communication object of type chat to another session. {DEPRICATED, USE forward chat message} |
Reply chat message |
Reply to a chat message. |
Reply chat communication |
Reply to a communication object of type chat. {DEPRICATED, USE reply chat message} |
User is typing |
Tell server that user is typing a new message. |
External chat session through API |
Setup an external chat session through the API. {DEPRICATED, USE external chat from gateway} |
External chat session from gateway |
Setup an external chat session from gateway. |
Get chat concept |
Return current chat concept. |
Set chat concept |
Set chat concept. |
Chat Concept Upload Attachment |
Upload attachment to a chat concept. |
Get Concept Chat Attachment |
Get the uploaded chat concept attachment. |
Chat session delivered |
Set chat session as delivered for the current user. |
Chat session available users |
Get a list of users that are available for chatting in this chat session. |
Chat session reassign |
Reassign a chat session to the given user. |
End chat session |
Ends the external chat session. |
Decline invitation |
Declines a new external chat invitation. |
Create group chat session |
Create a new group chat session. |
Get Group Chat Participants |
Get the participants of a group chat session. |
Add Group Chat Participant |
Add a participant to a group chat. |
Remove Group Chat Participant |
Remove a participant from a group chat. |
Set Group Chat Admin |
Set or remove a group chat participant as administrator. |
Communication: call-logs, email, chat and SMS messages
Recent communication / Inbox |
Show the recent incoming communication / inbox of a user. |
Search communication |
Search communication. |
Search communication with |
Search communication with a participant. |
Get communication |
Retrieve information of a communication event. |
Get communication Audio |
Return the audio recording of a communication event. |
Get Communication First Attachment |
Return the first attachment of a communication event. |
Get Communication Attachment |
Return an attachment of a communication event. |
Send SMS |
Send an SMS message. |
Update communication |
Update attributes of a communication. |
Call |
Set up a call between 2 phone numbers. |
Anonymize |
Anonymize communication of addressables or/and a specific period. |
Get listen in info |
Listen in information of a specific channel. |
Get after call types |
Get available after call types for a specific communication. |
Get cradle to grave |
Get cradle to grave for a specific communication. |
Country Settings
List country settings |
List country settings. |
Get country settings |
Retrieve information of a country settings object. |
Create country settings |
Create a new country settings object. |
Remove country settings |
Remove a country settings object. |
Update country settings |
Update attributes of a country settings object. |
Device
Available provisioning numbers |
Request the available provisioning numbers for the logged in user. |
Register device |
Register a device (phone or tablet). |
Unregister device |
Remove a device registration. |
Has License |
Check if the registered device is licensed. |
Call Through PBX |
Prepare a call forwarding through the PBX. |
PBX Initiated Call |
Let the PBX initiate a call. |
Twin Call |
Make a call through the twinned phone. |
Get twin number |
Get the twin phone number. |
Set twin number |
Set the twin phone number. |
Get valid twin numbers |
Get phone numbers that are valid for twinning. |
Get running calls |
List the running PBX calls of the device. |
Transfer running calls |
Transfer the two running PBX calls of the device. |
Transfer selected running calls |
Transfer the two selected running PBX calls of the device. |
Get do not disturb |
Get the do not disturb state of this device. |
Set do not disturb |
Set the do not disturb state of this device. |
Confirm Call |
Confirm an incoming call to proceed with given status. |
Get wait until call confirmed |
Get the wait until call confirmed state of this device. |
Set wait until call confirmed |
Set the wait until call confirmed state of this device. |
Get call strategy |
Get the call strategy of this device. |
Set call strategy |
Set the call strategy of this device. |
Get allow GSM dial if busy |
Get the allow GSM dial if busy state of this device. |
Set allow GSM dial if busy |
Set the allow GSM dial if busy state of this device. |
External Chat Gateways
List external chat gateways |
Retrieve a list of external chat gateways. |
Get external chat gateway |
Retrieve an external chat gateway. |
Create external chat gateway |
Create an external chat gateway. |
Remove external chat gateway |
Removes an external chat gateway. |
Update external chat gateway |
Edit the attributes of an external chat gateway. |
Favorites
List favorites |
List favorites. |
Update favorites list |
Add or remove items from the users favorites list. |
Update favorites list item |
Update users favorites list item. |
License
List licenses |
List of licenses. |
Install license |
Install a new license file. |
Order license |
Order a new license from the license server |
Lists
List lists |
List or search the lists. |
Get list |
Retrieve information of a list and its elements. |
Create list |
Create a new empty list. |
Remove list |
Delete a list from the database. |
Update List |
Update the attributes and the elements of a list. |
Locations
List locations |
List of locations. |
Get location |
Retrieve information of a location. |
Create location |
Create a location. |
Remove location |
Remove a location. |
Update location |
Update the attributes of a location. |
Logs
List Logs |
List of action log entries. |
Message Routing
List message routings |
List of message routings. |
Get message routing |
Retrieve information of a message routing. |
Create message routing |
Create a new message routing. |
Remove message routing |
Remove a message routing. |
Update message routing |
Update attributes of a message routing. |
Send message routing |
Send a message through message routing configuration. |
Microsoft 365 / Exchange
Set Microsoft 365 authentication token |
Set initial Microsoft 365 user authentication token. |
Start Microsoft 365 import |
Start initial Microsoft 365 import. |
Start initial Microsoft 365 events import |
Start initial Microsoft 365 events (appointments) import. |
Start initial Microsoft 365 contacts import |
Start initial Microsoft 365 contacts import. |
Subscribe to Microsoft 365 notifications |
Subscribe to Microsoft 365 notifications. |
Subscribe to Microsoft 365 contacts notifications |
Subscribe to Microsoft 365 contacts notifications. |
Subscribe to Microsoft 365 events notifications |
Subscribe to Microsoft 365 events (appointments) notifications. |
Subscribe to Microsoft Teams presence notifications |
Subscribe to Microsoft 365 Teams presence notifications. |
Get Microsoft 365 settings |
Retrieve Microsoft 365 synchronization settings. |
Update Microsoft 365 settings |
Updates Microsoft 365 synchronization settings. |
Check Microsoft 365 Exchange license |
Check the Microsoft365 Exchange license validity. |
Get status of Microsoft 365 subscriptions |
Get the status of Microsoft 365 subscriptions for the user. |
Get full status of Microsoft 365 subscriptions |
Get the full status of Microsoft 365 subscriptions for the user. |
Get status of Microsoft 365 contacts subscriptions |
Get the status of Microsoft 365 contacts subscriptions for the user. |
Get status of Microsoft 365 events subscriptions |
Get the status of Microsoft 365 events subscriptions for the user. |
Get status of Microsoft 365 Teams presence subscriptions |
Get the status of Microsoft 365 Teams presence subscriptions for the user. |
Stop Microsoft 365 Notifications subscriptions |
Stops Microsoft 365 resource notifications subscriptions for the user. |
Stop Microsoft 365 contacts notifications subscriptions |
Stops Microsoft 365 contacts subscriptions for the user. |
Stop Microsoft 365 events notifications subscriptions |
Stops Microsoft 365 events subscriptions for the user. |
Stop Microsoft 365 Teams presence notifications subscriptions |
Stops Microsoft Teams presence subscriptions for the user. |
Music On Hold Categories
List music on hold categories |
List music on hold categories. |
Get music on hold category |
Retrieve information of a music on hold category. |
Create music on hold category |
Create a new music on hold category. |
Remove music on hold category |
Remove a music on hold category. |
Update music on hold category |
Update attributes of a music on hold category. |
New music file |
Add new music/audio file to the music on hold category. |
Upload music on hold category |
Upload music on hold category audio files. |
OMM
List OMM |
List of OMM devices. |
Get OMM |
Retrieve information of an OMM. |
Create OMM |
Create a new OMM. |
Remove OMM |
Remove an OMM. |
Update OMM |
Update attributes of an OMM. |
OMM Message Definition
List OMM message definitions |
List of OMM message definitions. |
Get OMM message definition |
Retrieve information of an OMM message definition. |
Create OMM message definition |
Create a new OMM message definition. |
Remove OMM message definition |
Remove an OMM message definition. |
Update OMM message definition |
Update attributes of an OMM message definition. |
Other Resources
Get enumeration |
Get list of values for a specific enumeration. |
Get version |
Get version information of server. |
Security |
Get, Write or Update security settings of an Entity. |
Peers
List peers |
List of peers. |
Phone
List phones |
List the phones. |
Get phone |
Retrieve information of a phone. |
Create phone |
Create a new phone. |
Remove phone |
Remove a phone. |
Update phone |
Update attributes of a phone. |
Hotdesk phone to line |
Hotdesks a phone to the specified phoneline |
Get phone statistics |
Get statistics of phones |
Phone Lines
List phone lines |
List the phone lines. |
Get phone line |
Retrieve information of a phone line. |
Create phone line |
Create a new phone line. |
Remove phone line |
Remove a phone line. |
Update phone line |
Update attributes of a phone line. |
Clone phone line |
Clone a phone line |
Get phone line night mode |
Retrieve information of the currently active night mode. |
Get phone line current one off override mode |
Retrieve information of the currently selected one off override mode. |
Get phone line one off override options |
Returns the currently selectable one off override options. |
Get phone line selectable statuses |
Return the selectable statusses of the phone line. |
Generate auto attendant text to speech |
Generate the text to speech audio for the auto attendant menu. |
Get voicemail greeting of line |
Get voicemail greeting of line. |
Get auto attendant message of line |
Get auto attendant message of line. |
Phone line / call pickup groups
List phone line groups |
List phone line groups. |
Get phone line group |
Retrieve information of a phone line group. |
Create phone line group |
Create a new phone line group. |
Remove phone line group |
Remove a phone line group. |
Update phone line group |
Update attributes of a phone line group. |
Phone Templates
List phone templates |
List the phone templates. |
Get phone template |
Retrieve information of a phone template. |
Create phone template |
Create a new phone template. |
Remove phone template |
Remove a phone template. |
Update phone template |
Update attributes of a phone template. |
Generate and Update Provisioning Config Files |
Generates and Updates all provisioning config files based on this template |
Generate a phone based on this template |
Generate a phone based from the template |
Presence Groups
List presence groups |
List presence groups. |
Get presence group |
Retrieve information of a presence group. |
Create presence group |
Create a new presence group. |
Remove presence group |
Remove a presence group. |
Update presence group |
Update attributes of a presence group. |
Provisioning
List provisioning |
List the provisioning profiles. |
Get provisioning |
Retrieve information of a provisioning profile. |
Create provisioning |
Create a new provisioning profile. |
Remove provisioning |
Remove a provisioning profile. |
Update provisioning |
Update attributes of a provisioning profile. |
Get phone types |
Retrieve phone types. |
Generate Provisioning Config File |
Generate a provisioning config file |
Resync Phone Provisioning |
Trigger a phone provisioning resync. |
Reboot Phone |
Reboot a phone. |
Factory Reset Phone |
Factory reset a phone. |
Release Phone |
Release a phone. |
Get Provisioning Address |
Get provisioning address from a phone. |
Queries (Query Builder)
List queries |
List queries |
Get query |
Retrieve information of a query. |
Create query |
Create a new query object. |
Update query |
Update attributes of a query. |
Remove query |
Remove a query. |
Generate query CSV |
Generate a CSV with the results of the query. {DEPRECATED, use: Excute Query} |
Execute Query |
Execute a predefined query. |
Report Schedules
List report schedules |
List report schedules |
Get report schedule |
Retrieve information of a report schedule. |
Create report schedule |
Create a new report schedule object. |
Update report schedule |
Update attributes of a report schedule. |
Remove report schedule |
Remove a report schedule. |
Video Conference
Active conference rooms |
Retrieve running video conference rooms. |
Create conference room |
Create a video conference room. |
Get conference room |
Retrieve a video conference room. |
Remove conference room |
Remove an empty video conference room. |
Kill conference room |
Kill video conference room (admin only). |
Server Settings
Get Advanced settings |
Retrieve information of the advanced pbx settings. |
Get Authentication settings |
Retrieve information of the authentication settings. |
Get Call settings |
Retrieve information of the pbx’s call settings. |
Get Provisioning settings |
Retrieve information of the pbx’s provisioning settings. |
Get Locale settings |
Retrieve information of the locale settings. |
Get Email settings |
Retrieve information of the email settings. |
Get Users settings |
Retrieve information of the users settings. |
Get Hotdesking settings |
Retrieve information of the Hotdesking settings. |
Get Community settings |
Retrieve information of the Community settings. |
Update Cloud Provisioning |
Update Cloud Provisioning for the Tenant of the currently logged-in User |
Get LDAP settings |
Retrieve information of the LDAP settings. |
Get Video conference settings |
Retrieve the video conferencing settings. |
Update Advanced settings |
Update the advanced pbx settings. |
Update Authentication settings |
Update the authentication settings. |
Update Call settings |
Update the pbx’s call settings. |
Update Provisioning settings |
Update the pbx’s provisioning settings. |
Update Locale settings |
Update the locale settings. |
Update Email settings |
Update the email settings. |
Update Users settings |
Update the users settings. |
Update Hotdesking settings |
Update the hotdesking settings. |
Update Community settings |
Update the community settings. |
Update LDAP settings |
Update the LDAP settings. |
Update video conference settings |
Update the video conferencing settings. |
Send Test Email |
Sends a test email. |
Get Available Locales |
Get the available locales |
Add And Upload Audio Message |
Add And Upload Audio Message for Hotdesking fields |
Session
Login |
Log in to the server and start a new session. |
Logout |
End the current session. |
Request Reset Password |
Request reset password |
Reset Password |
Reset password |
Renew Session Token |
Renew the session token. |
Capabilities |
Get session capabilities. |
SpeedDial
List speeddials |
List the speeddials. |
Get speeddial |
Retrieve information of a speeddial. |
Create speeddial |
Create a new speeddial. |
Remove speeddial |
Remove a speeddial. |
Update speeddial |
Update attributes of a speeddial. |
Get speeddial type ids |
Retrieve speeddial type ids. |
Statistics {BETA}
Statistics |
Show Server Statistics. |
Dailly Statistics |
Return the Server’s Dailly Statistics Logging. |
Statistics Split Duration |
Set the Duration of an Interval in the Server’s Dailly Statistics Logging. |
Statuses (editable status)
List statuses |
List statuses |
Get status |
Retrieve information of a status. |
Create status |
Create a new status object. |
Update status |
Update attributes of a status. |
Remove status |
Remove a status. |
Switch Time Overrides
List switch time overrides |
List switch time overrides. |
Get switch time overrides |
Retrieve information of a switch time overrides object. |
Create switch time overrides |
Create a new switch time overrides object. |
Update switch time overrides |
Update attributes of a switch time overrides object. |
Remove switch time overrides |
Remove a switch time overrides object. |
Switch Time Templates
List switch time templates |
List switch time templates. |
Get switch time template |
Retrieve information of a switch time template. |
Create switch time template |
Create a new switch time template. |
Update switch time template |
Update attributes of a switch time template. |
Remove switch time template |
Remove a switch time template. |
Sync
Get synced object |
Retrieve entity information of a synced object. |
Sync csv persons |
Import persons by csv string or file into Xelion. |
Sync csv organisations |
Import organisations by csv string or file into Xelion. |
Get csv import settings |
Get the csv import schedule settings and logs. |
Update csv import settings |
Update the csv import schedule settings. |
Manually start csv import |
Manually start a csv import. |
Tenants
List tenants |
List the tenants. |
Get tenant |
Retrieve information of a tenant. |
Write tenant |
Write tenant attributes.{DEPRICATED, USE PATCH/UPDATE} |
Update tenant |
Update tenant attributes. |
Start tenant |
Start a tenant. |
Stop tenant |
Stop a tenant. |
Import tenant |
Import a tenant database.{DEPRICATED, USE Backup Schedules API} |
Read tenant log |
Read the tenant log file. |
Release tenant |
Release a tenant to be re-used. |
Get first available tenant |
Retrieve the information of the first available tenant that is not used, but has a database pre-loaded. |
Login tenant |
Login to tenant from a master session. |
Get tenant provisioning settings |
Retrieve the tenant preload provisioning options from a master session |
Update tenant provisioning settings |
Update the tenant preload provisioning options from a master session |
Get filenames tenant provisioning |
Retrieve a list of filenames, used for the preprovision settings |
Calculate tenant disk usage |
Calculate tenant disk usage |
Update Cloud Provisioning |
Update Cloud Provisioning for all Tenants |
Update Cloud Provisioning for Tenant |
Update Cloud Provisioning for a specific Tenant |
Preload a Tenant |
Preload a specific Tenant |
Todo/Flagged List
Todo list |
Get the users todo list.{DEPRICATED, USE Get todo lines of user} |
Get todo list item |
Get specific item of the users todo list.{DEPRICATED, USE Get todo list item of line} |
Update todo list |
Add or remove items from the users todo list.{DEPRICATED, USE Update line todo list} |
Update todo list item |
Update users todo list item.{DEPRICATED, USE Update line todo list item} |
Get todo lines of user |
Get the todo list lines the user can access. |
Get todo line |
Get the todo list of the selected line. |
Get todo list item of line |
Get specific item of the line todo list. |
Update line todo list |
Add or remove items from the line todo list. |
Update line todo list item |
Update line todo list item. |
Traffic Classes
List traffic classes |
List traffic classes. |
Get traffic class |
Retrieve information of a traffic class. |
Create traffic class |
Create a new traffic class. |
Remove traffic class |
Remove a traffic class. |
Update traffic class |
Update attributes of a traffic class. |
Triggers
List triggers |
List the triggers. |
Get trigger |
Retrieve information of a trigger. |
Create trigger |
Create a new trigger. |
Remove trigger |
Remove a trigger. |
Update trigger |
Update attributes of a trigger. |
Trunks
List trunks |
List the tenant’s trunks. |
Get trunk |
Retrieve information of a trunk. |
Write trunk |
Write trunk attributes.{DEPRICATED, USE PATCH/UPDATE} |
Create a trunk |
Create a new trunk. |
Remove trunk |
Remove a trunk. |
Update trunk |
Update attributes of a trunk. |
Get available trunk numbers |
List with the trunk numbers that are still available. |
Update - Automatic
- List latest updates
-
List of the latest available updates
- List old updates
-
List of the updates that have been installed in the past
- Get update info
-
Retrieve information of an update
- Get schedule
-
Retrieve information of the automatic update schedule
Update - Manual
Upload Update File |
Uploads the selected update file to the server. |
Start Update |
Starts the server update. |
Users
List users |
List the users. |
Get user |
Retrieve information of a user. |
Create user |
Create a new user. |
Remove user |
Remove a user. |
Update user |
Update attributes of a user. |
Get user visible lines |
Retrieve the lines of the selected user. |
Get user statitistics |
Get statistics of users |
Send welcome e-mail |
Send welcome e-mail to the selected user |
Send welcome e-mails |
Send welcome e-mails to all users |
User
User Information |
Retrieve information on the current user. |
Get User Status |
Return the user’s status. |
Set User Status |
Sets the user’s status. |
Set Temporary User Status |
Sets the user’s temporary status. |
Reset User Status |
Resets the user’s status. |
Get User Selectable Statuses |
Return the selectable statusses of the user. |
Get User Presence |
Return the user’s presence. |
Get User Status Message |
Return the user’s status message. |
Set User Status Message |
Sets the user’s status message. |
Get User Location |
Return the user’s location. |
Set User Location |
Sets the user’s location. |
Initiate Call |
Initiate a call from the current user session. |
Lines Of User Phones |
Retrieve lines where one of the user phones is part of. |
User Visible Lines |
Retrieve lines the current user can see. |
User Visible Line Unread Contacts |
Retrieve the unread contacts of a visible line of the user. |
User Managed Lines |
Retrieve lines the current user can manage. |
Get User Lines |
Retrieve the lines of the current user. |
Get User Primary Line |
Retrieve the current user primary/identity/outgoing line. |
Toggle User Line Incoming |
Toggle the incoming flag of the selected user line. |
Toggle User Line Outgoing |
Toggle the outgoing flag of the selected user line. |
Get User Phones |
Retrieve the phones of the current user. |
Get User Phone Do Not Disturb |
Get the do not disturb state of the selected user phone. |
Set User Phone Do Not Disturb |
Set the do not disturb state of the selected user phone. |
Get do not dial if busy |
Get the do not dial if busy state of the current user. |
Set do not dial if busy |
Set the do not dial if busy state of the current user. |
Change user password |
Changes the users password. |
Get running calls |
List running PBX calls of the current user. |
Is call recording |
Is a running user call currently recording. |
Toggle recording of call |
Set recording on/off of a running user call. |
User Message Definition
List user message definitions |
List of user message definitions. |
Get user message definition |
Retrieve information of a user message definition. |
Create user message definition |
Create a new user message definition. |
Remove user message definition |
Remove a user message definition. |
Update user message definition |
Update attributes of a user message definition. |
User phone line settings
Get User Phone Settings |
Return the user’s phone settings. |
Update User Phone Settings |
Partial update of the user’s phone settings. |
Get caller ID |
Return the caller ID of the user. |
Set caller ID |
Set the caller ID of the user. |
Valid caller IDs |
Get the list of valid caller IDs for the user. |
Get voicemail greeting of user |
Get voicemail greeting of user. |
Get User Schedule |
Return the user’s schedule. |
Update User Schedule |
Update of the user’s schedule. |
Wallboards
List wallboards |
List wallboards. |
Get wallboard definitions |
Get wallboard definitions. |
Get wallboard statistics |
Get wallboard statistics. |
User wallboards list |
List the wallboards selected by the user. |
Add to user wallboards list |
Add a wallboard to the user’s wallboards list. |
Remove from user wallboards list |
Remove a wallboard from the user’s wallboards list. |
WhatsApp Gateways
List WhatsApp gateways |
Retrieve a list of WhatsApp gateways. |
Get WhatsApp gateway |
Retrieve a WhatsApp gateway. |
Create WhatsApp gateway |
Create a WhatsApp gateway. |
Remove WhatsApp gateway |
Remove a WhatsApp gateway. |
Update WhatsApp gateway |
Edit the attributes of a WhatsApp gateway. |
Sync WhatsApp templates |
Sync WhatsApp templates of the selected gateway. |
WhatsApp Templates
List WhatsApp templates |
Retrieve a list of WhatsApp templates. |
Get WhatsApp template |
Retrieve a WhatsApp template. |
Send WhatsApp template |
Send a WhatsApp template. |
Zoho
Get Zoho Defaults |
Return the Zoho defaults. |
Update Zoho Defaults |
Update the Zoho defaults. |
Generate Zoho Token |
Generate access token and refresh token for Zoho. |
Start Zoho Import |
Manually start the Zoho import. |