Changelog


v9u2 (xelion) - v1.19 (api)

Date User Description Resource

2024-12-12

Arno

WhatsApp usage can be included when fetching all tenants

GET /tenants?include=statistics.whatsAppUsage

2024-12-11

Kevin

New call to get the provisioning address from a phone provisioning

GET /provisioning/<OID>/provisioning_address

2024-11-25

Arno

New call to get the potential telecom address labels of an Addressable

GET /addressables/<OID>/telecom_address_labels

2024-11-25

Fabian

Added exception when filtering for only_missed_calls or only_voicemails and an incompatible obj_type

GET /communications?where=obj_type=XCCUserChat&only_missed_calls

v9u1 (xelion) - v1.18 (api)

This update contains a breaking change:

The chat send calls are now returning XCCUserChat objects instead of XCCChat objects, see changelog below for details.
This also applies for the GET /chats/<OID>/messages call.
The GET /chats/<OID>/messages/<OID>/attachment is now based on XCCUserChat

Date User Description Resource

2024-10-11

Arno

Employment organisation can also be given when join addressable

GET /addressables/<OID>/join

2024-10-29

Kevin

Added endpoint for Send Welcome Emails

POST /users/send_welcome_email

2024-10-25

Arno

Added status icons for day night mode and auto reply settings when reading a phone line

GET /phonelines/<OID>

2024-10-23

Arno

Added chat auto reply

GET /phonelines/<OID>

2024-10-22

Kevin

Added endpoint for Release phone

POST /provisioning/<OID>/release

2024-10-22

Kevin

Added endpoint for Get and Update Users Settings

GET /server/users
PATCH /server/users

2024-10-22

Kevin

Added endpoint for Send Welcome Email

POST /users/<OID>/send_welcome_email

2024-10-11

Arno

Send chat now returns XCCUserChat

POST /chats/<OID>/messages
POST /addressable/<OID>/chat
POST /chats/<OID>/messages/<OID>/forward
POST /communications/chat/<OID>/forward
POST /chats/<OID>/messages/<OID>/reply
POST /communications/chat/<OID>/reply
POST /whatsapptemplates/<OID>/send

2024-10-11

Arno

Chat messages now returns list of XCCUserChats

GET /chats/<OID>/messages

2024-10-11

Arno

Get chat message attachment now based on XCCUserChat

GET /chats/<OID>/messages/<OID>/attachment

v9 (xelion) - *v1.17 (api)

Date User Description Resource

2024-09-12

Arno

Fix exception when fetching communication by call id

GET /communications/<oid>

2024-09-12

Arno

Extended user info with user role

GET /me/info

2024-09-11

Kevin

Added Reset Password

POST /me/reset_password

2024-09-11

Kevin

Added Request Reset Password

POST /me/request_reset_password

2024-09-09

Kevin

Added Activation Number, -Code, -IP and -Status

GET /provisioning/<oid>

2024-09-09

Kevin

Added possibility to update ChatHuntingPolicy

PATCH /phonelines/<oid>

v8u6 (xelion) - v1.16 (api)

Date User Description Resource

2024-07-24

Kevin

Added lastCallDate, userAgent and registrationContact to XCCLicensedPhone

GET /phones/<oid>

2024-07-19

Arno

User get schedule return 404 when manual night mode active

GET /me/phone/schedule

2024-07-19

Arno

Extended endpoint /communications?include=all userProfile field with Person information

GET /communications

2024-07-18

Kevin

Extended endpoint /tenants/<oid> with isTemplate

GET /tenants/<oid>

2024-07-18

Kevin

Added endpoint /me/microsoft/subscriptions/full_status

GET /me/microsoft/subscriptions/full_status

2024-07-18

Kevin

Added error codes to preload tenant and update tenant 10165 and 10166

Error Codes

2024-07-18

Kevin

Added system to XCCConnectedPhoneLine

GET /phones/<oid>

2024-07-18

Kevin

Added value to XCCPhoneProvisioning

GET /provisioning/<oid>

2024-07-18

Kevin

Added provisioning number, screen display name and ipui number to XCCPhoneProvisioning accounts

GET /provisioning/<oid>

v8u5 (xelion) - v1.15 (api)

This update contains a breaking change:

The Attachment in some resources has been replaced with XCCAudioMessage containing the Attachment. The path for updating the Attachment has been changed:

  • POST /phonelines, PATCH /phonelines/<OID>

    • path /autoAttendant/audioMessage/[commonName,originalLocation,mimeType,contentsB64String] is deprecated, replaced by /autoAttendant/audio/audioMessage/[commonName,originalLocation,mimeType,contentsB64String]

    • path /userPhoneLine/voicemailGreeting/[commonName,originalLocation,mimeType,contentsB64String] is deprecated, replaced by /userPhoneLine/voicemailGreeting/audioMessage/[commonName,originalLocation,mimeType,contentsB64String]

    • path /voicemailDeliveryMessage/[commonName,originalLocation,mimeType,contentsB64String] is deprecated, replaced by /voicemailDeliveryMessage/audioMessage/[commonName,originalLocation,mimeType,contentsB64String]

    • path /announcement/[commonName,originalLocation,mimeType,contentsB64String] is deprecated, replaced by /announcement/audioMessage/[commonName,originalLocation,mimeType,contentsB64String]

    • path /callerAnnouncement/[commonName,originalLocation,mimeType,contentsB64String] is deprecated, replaced by /callerAnnouncement/audioMessage/[commonName,originalLocation,mimeType,contentsB64String]

  • PUT /me/phone/settings, PATCH /me/phone/settings

    • path /voicemailGreeting/[commonName,originalLocation,mimeType,contentsB64String] is deprecated, replaced by /voicemailGreeting/audioMessage/[commonName,originalLocation,mimeType,contentsB64String]

  • POST /speeddials, PATCH /speeddials/<OID>

    • path /audioMessage1/[commonName,originalLocation,mimeType,contentsB64String] is deprecated, replaced by /audioMessage1/audioMessage/[commonName,originalLocation,mimeType,contentsB64String]

    • path /audioMessage2/[commonName,originalLocation,mimeType,contentsB64String] is deprecated, replaced by /audioMessage2/audioMessage/[commonName,originalLocation,mimeType,contentsB64String]

  • PATCH /server/hotdesking

    • path /hotDeskingActivatedMessage/[commonName,originalLocation,mimeType,contentsB64String] is deprecated, replaced by /hotDeskingActivatedMessage/audioMessage/[commonName,originalLocation,mimeType,contentsB64String]

    • path /hotDeskingDeactivatedMessage/[commonName,originalLocation,mimeType,contentsB64String] is deprecated, replaced by /hotDeskingDeactivatedMessage/audioMessage/[commonName,originalLocation,mimeType,contentsB64String]

    • path /hdActivationFailedMessage/[commonName,originalLocation,mimeType,contentsB64String] is deprecated, replaced by /hdActivationFailedMessage/audioMessage/[commonName,originalLocation,mimeType,contentsB64String]

  • PATCH /musiconholdcategories/<OID>

    • path /audioFiles/<OID>/file/[commonName,originalLocation,mimeType,contentsB64String] is deprecated, replaced by /audioFiles/<OID>/file/audioMessage/[commonName,originalLocation,mimeType,contentsB64String]

Date User Description Resource

2024-05-24

Kevin

Added wallboardResetTime to Restricted Phoneline Reader

GET /phonelines/<oid>

2024-05-15

Arno

Ability to reset user status

PUT /me/reset_status

2024-05-15

Kevin

Added enableVoicemailTranscribe to phone line

GET /phonelines/<oid>

2024-04-24

Arno

Ability to manually set a temporary user status

PUT /me/temporary_status
GET /me/phone/settings
PATCH /me/phone/settings

2024-04-19

Kevin

Added active filter to List Tenants

GET /tenants?where=active=true

2024-04-17

Kevin

Added Preload Tenants endpoint

POST /tenants/preload

2024-04-17

Kevin

Added Template, Restore Type to Tenant Provisioning

GET /tenants/provisioning
PATCH /tenants/provisioning

2024-04-17

Kevin

Added isTemplate filter to List Tenants

GET /tenants?where=isTemplate=true

2024-04-16

Kevin

Added dndExceptions to User Phone Line

GET /me/phone/settings
PATCH /me/phone/settings
POST /me/phone/settings

2024-04-16

Arno

Added calls to create / patch Unknown Addressables

POST /addressables
PATCH /addressables/<OID

2024-04-10

Katia

Text to speech implementation for audio messages of:
- callee announcement
- caller anouncement
- auto attendant
- voicemail delivery message
- voicemail greeting
- speed dial
- hotdesking messages
- music on hold category

POST /phonelines
PATCH /phonelines/<OID>
POST /phonelines/<OID>/generate_voicemail_greeting_text_to_speech
POST /phonelines/<OID>/generate_voicemail_delivery_text_to_speech
POST /phonelines/<OID>/generate_announcement_text_to_speech
POST /phonelines/<OID>/generate_caller_announcement_text_to_speech

PUT /me/phone/settings
PATCH /me/phone/settings
POST /me/phone/settings/generate_voicemail_greeting_text_to_speech

POST /speeddials
PATCH /speeddials/<OID>
POST /speeddials/<OID>/generate_speeddial_audiomessage1_text_to_speech
POST /speeddials/<OID>/generate_speeddial_audiomessage2_text_to_speech

PATCH /server/hotdesking POST /server/hotdesking/generate_hotdesking_activated_text_to_speech
POST /server/hotdesking/generate_hotdesking_deactivated_text_to_speech
POST /server/hotdesking/generate_hotdesking_failed_text_to_speech

PATCH /musiconholdcategories/<OID>

2024-04-08

Arno

Added calls to get and update the current user schedule

GET /me/phone/schedule
PUT /me/phone/schedule

2024-04-08

Arno

Added calls to get and set the current user location

GET /me/location
PUT /me/location

2024-03-27

Arno

Me (device) calls extended with extra line info

GET /me/calls
GET /me/device/calls

2024-03-20

Arno

Added Cradle To Grave to communication call

GET /communications/<OID>/cradle_to_grave

2024-03-18

Kevin

Added Serial Number to XCCPhoneProvisioning

GET /provisioning/<OID>

v8u4 (xelion) - v1.14 (api)

This update blocks the /attachments API-endpoint for users.
Nothing changes for Administrators and so they can access this resource.
See the change-log below for alternatives.

Date User Description Resource

2024-03-15

Arnon

Blocked attachments endpoint for non-admins and created endpoints for attachments retrieval at their parent objects.

GET /me/phone/settings/voicemail_greeting
GET /phonelines/<OID>/voicemail_greeting
GET /phonelines/<OID>/auto_attendant_message

2024-01-30

Arnon

Blocked attachments endpoint for non-admins and created endpoints for attachments retrieval at their parent objects.

GET /attachments/<OID>
GET /attachments/<OID>/binary
GET /communications/<OID>/attachment
GET /communications/<OID>/attachments/<OID>
POST /queries/<OID>/execute
GET /chats/<OID>/attachment
GET /chats/<OID>/concept/attachment
POST /reports/<OID>/execute
POST /reports/<OID>/attachments/<OID

2024-01-19

Kevin

Added endpoint to update the Cloud Provisioning for all tenants

POST /tenants/provisioning/update_cloud_provisioning

2024-01-19

Kevin

Added endpoint to update the Cloud Provisioning for a specific tenant

POST /tenants/<oid>/provisioning/update_cloud_provisioning

2024-01-19

Kevin

Added endpoint to update the Cloud Provisioning for the tenant of the session

POST /server/community/provisioning/update_cloud_provisioning

2024-01-11

Kevin

Added the possibility to add a language in the audio file

POST /audiofiles

2024-01-11

Kevin

Added the possibility to clone phone lines

POST /phonelines/<oid>/clone

2024-01-08

Kevin

Added the possibility to filter out phonelines that have certain values enabled or disabled

GET /phonelines?where=…​

2023-01-05

Kevin

Added the possibility to get, update and create users with managed lines

GET /users?include=mangedLines

2023-12-08

Kevin

Added the possibility to filter out phonelines that have wallboard enabled or disabled

GET /phonelines?where=showWaitingQueue=true

2023-12-08

Kevin

Unavailable license returns a 403 now

POST /messageroutings/<OID>/message

2023-12-07

Kevin

PhoneLine API call with includes returns correct autoAttendantOn value

GET /phonelines?include=autoAttendantOn

2023-11-29

Arno

Select seperator when generating CSV file from query

GET /queries/<OID>/generate_csv

2023-11-28

Arno

Sync WhatsApp tempaltes of gateway

GET /whatsappgateways/<OID>/sync_templates

2023-11-24

Arno

WhatsApp capability added

GET /me/capabilities

2023-11-24

Arno

Send WhatsApp templates implementation

GET /whatsapptemplates
GET /whatsapptemplates/<OID>
POST /whatsapptemplates/<OID>
GET /whatsappgateways/<OID>
PATCH /whatsappgateways/<OID>

v8u3 (xelion) - v1.13 (api)

This update contains a important status change:
The status the user can select is based on the call GET /me/selectable_statuses API call.
This call returns a list of statuses the user can select. This was a hard coded list before (available, unavailable, …​).

The presence icon that should be shown is now given in all the presence status responses (presence list / me presence / addressables / …​).
Before the status was determined by the end user app, this was mapped by the status name, replace this with the status icon field.

Date User Description Resource

2023-10-25

Arno

Split backup implementation

GET /backupschedules/<OID>
POST /backupschedules
PATCH /backupschedules/<OID>
GET /backupschedules/<OID>/restore_files
PUT /backupschedules/<OID>/restore

2023-10-25

Katia

Reason is required when stopping a tenant

POST /tenants/<OID>/stop

2023-10-05

Arno

Added dtmfBreakoutEnabled, toWhenNotAnsweredIfNoFreeAgent, dtmfDigitQueueCallback to the phone line api calls

GET /phonelines/<OID>
PATCH /phonelines/<OID>
POST /phonelines/<OID>

2023-10-04

Arno

Communication search calls now always returning the field "voicemailIsHeard"

GET /communications/recent
GET /communications
GET /communications?with=<OID>

2023-09-27

Arno

Trunk sip tls members added to API

XCCTrunk

2023-09-19

Arno

Text to speech implementation for auto attendant audio message

POST /phonelines/<OID>/generate_auto_attendant_text_to_speech
GET /phonelines/<OID>
PATCH /phonelines/<OID>
POST /phonelines/<OID>

2023-09-06

Arno

Select switch time template in a phone line day night mode configuration

PATCH /phonelines/<OID>
POST /phonelines/<OID>

2023-09-06

Arno

Added CRUD operations for switch time template to the API

GET /switchtimetemplates
GET /switchtimetemplates/<OID>
POST /switchtimetemplates
DELETE /switchtimetemplates/<OID>
PATCH /switchtimetemplates/<OID>

2023-08-25

Arno

Select default switch time override in the server settings

GET /server/advanced
PATCH /server/advanced

2023-08-25

Arno

Select switch time override in a phone line day night mode configuration

PATCH /phonelines/<OID>
POST /phonelines/<OID>

2023-08-31

Arno

Added CRUD operations for general switch time overrides to the API

GET /switchtimeoverrides
GET /switchtimeoverrides/<OID>
POST /switchtimeoverrides
DELETE /switchtimeoverrides/<OID>
PATCH /switchtimeoverrides/<OID>

2023-08-25

Arno

A 400 exception is thrown when giving the wrong tenant information

GET /backupschedules/<OID>/restore

2023-08-25

Arno

Backup schedule API calls were not handling the tenants correctly, now the tenant special ID is used

GET /backupschedules/<OID>
POST /backupschedules
PATCH /backupschedules/<OID>

2023-08-15

Arno

Added API call to get the phone line one off override options

GET /phonelines/one_off_override_options

2023-08-09

Arno

Added API call to get the phone line one off override mode

GET /phonelines/one_off_override_mode

2023-08-07

Arno

Added API call to get the phone statistics

GET /phones/statistics

2023-08-03

Arno

Recent communication is also returning the call end time

GET /communications/recent

2023-08-03

Arno

Get communication fields call answer time and call end time were not in UTC

GET /communications/<OID>

2023-07-24

Arno

Toggle user line is returning specific error response code if error occurs

PUT /me/user_lins/<CONNECTED_USER_LINE>/toggle_incoming
PUT /me/user_lins/<CONNECTED_USER_LINE>/toggle_outgoing

2023-07-20

Arno

Added API call to get the user statistics

GET /users/statistics

2023-07-10

Arno

Extend phone line API calls day night mode setting with status and location

GET /phonelines/<OID>
POST /phonelines
PATCH /phonelines/<OID>

2023-07-06

Arno

Log in without giving a user space was resulting in a nullpointer exception, this is now fixed

POST /me/login

2023-07-04

Arno

Read, create, remove, edit app settings for the specific apps

GET /me/appsettings
GET /me/appsettings/<OID>
POST /me/appsettings
PATCH /me/appsettings/<OID>
DELETE /me/appsettings/<OID>

GET /me/appsettings/<OID>/<KEY>
PUT /me/appsettings/<OID>/<KEY>
DELETE /me/appsettings/<OID>/<KEY>

2023-06-29

Arno

Add the original from members to the communication to easily identify the from participant of the original communication

GET /communications/recent
GET /communications
GET /communications?with=<OID>
GET /communications/<OID>

2023-06-26

Arno

API call to request available provisioning numbers for the logged in user (for device registration)

GET /me/device/provisioning_numbers

2023-06-06

Arno

Added CRUD operations for editable statuses to the API

GET /statuses
GET /statuses/<OID>
POST /statuses
DELETE /statuses/<OID>
PATCH /statuses/<OID>

2023-05-26

Arno

The API call to read a (managed) phone line can now include the presence status of the line

GET /phonelines/<OID>?include=status

2023-05-15

Arno

Added API call to get the selectable phone line statuses

GET /phonelines/<OID>/selectable_statuses

2023-05-15

Arno

API calls that are returning a presence list now have a new status icon field. Use this field to determine the icon to be shown

GET /presence
GET /presence/groups/<OID>

2023-05-15

Arno

API calls that are returning addressable object(s) with presence info now have a new status icon field. Use this field to determine the icon to be shown

GET /addressables
GET /addressables/<OID>
GET /addressables/<OID>/colleagues
GET /me/managed_lines

2023-05-15

Arno

API calls that returns presence info now have a special status icon, the icon field was already existing but never filled. Use this field to determine the icon to be shown

GET /me/info
GET /me/presence
GET /callables
GET /me/favorites
GET /me/todo
GET /me/todo_lines

2023-05-15

Arno

Added API call to get the selectable user statuses

GET /me/selectable_statuses

2023-04-25

Marnix

Added reboot, factory reset and resync phone provisioning requests to the API.

POST /provisioning/<OID>/resync
POST /provisioning/<OID>/reboot
POST /provisioning/<OID>/reset

2023-04-20

Arno

Added CRUD operations for Queries to the API

GET /queries
GET /queries/<OID>
POST /queries
DELETE /queries/<OID>
PATCH /queries/<OID>

2023-04-17

Marnix

The presence status can now be included when searching for managed lines

GET /me/managed_lines

2023-04-17

Arno

Addressee reader person member was returning the addressable member instead of the person member

GET /communications/<OID>

2023-04-17

Arno

Importing CSV as plain text special chars were not processed correctly

POST /sync/csv/persons
POST /sync/csv/organisations

2023-04-17

Arno

Sending SMS now returns the fully created communication object

POST /communications/sms

2023-04-14

Arno

Added the disabled flag to the get chat session calls

GET /chats/<OID>
GET /addressables/<OID>/chat

v8u2 (xelion) - v1.12 (api)

This update contains a breaking change:

In the call GET /server/provisioning, the field yealinkCommonCfg is now returning an Comment object instead of a oid.

Date User Description Resource

2023-02-14

Marnix

Fixed a bug where enableVoicemailToEmail and voicemailRecipientAddress couldn’t be set with the create phone line API call

POST /phonelines

2023-02-01

Arno

Number of active todo list items can be retrieved through the line search calls

GET /me/todo_lines?include=activeTodoListItemsCount GET /me/visible_lines?include=activeTodoListItemsCount

2023-02-01

Arno

Extra fields added to todo list items (time, status, assigned to, reminders)

List Item
Todo

2023-02-01

Arno

Phone lines can now have a todo list, these are available for the users that can access the line communication

Phone Line
Todo

2023-01-12

Arno

API call added to read the previous results from an automated report

GET /reports/<OID>/results

2023-01-12

Arno

Read automated reports API calls are made available for users

GET /reports
GET /reports/<OID>

2023-01-12

Arno

API call added to create ad hoc reports from an automated report

POST /reports/<OID>/ad_hoc

2023-01-09

Arno

Sending a special error code when the user space is longer than 200 characters during login

POST /me/login

2023-01-03

Arno

Get tenant should only return licenses that are active

GET /tenants/<OID>

2022-12-28

Arno

Set the after call type of a communication object

PATCH /communications/<OID>

2022-12-28

Arno

Get available after call types of a communication object

GET /communications/<OID>/after_call_types>

2022-12-28

Arno

Read the after call type from a communication object

GET /communications/recent
GET /communications
GET /communications?with=<OID>
GET /communications/<OID>

2022-12-28

Arno

Add/Remove after call types to a phone line

PATCH /phonelines/<OID>
POST /phonelines

2022-12-28

Arno

Added CRUD operations for After Call Types to the API

GET /aftercalltypes
GET /aftercalltypes/<OID>
POST /aftercalltypes
DELETE /aftercalltypes/<OID>
PATCH /aftercalltypes/<OID>

2022-12-20

Arno

When reading an addressable the search keys are also returned, user keys can also be added, modified, removed

GET /addressables/<OID>

2022-12-09

Marnix

Made List API calls available to users

GET /lists
GET /lists/<OID>
POST /lists
DELETE /lists/<OID>
PATCH /lists/<OID>

2022-12-09

Arno

Communication user profile person information also given when requesting the recent communication

GET /communications/recent

2022-12-08

Arno

External chat feedback is returned when chat session is requested by line manager

GET /chats/<OID>

2022-11-24

Wesley

Fixed the return value of the yealinkCommonCfg field

GET /server/provisioning

2022-11-13

Arno

Group chat administrators can be retrieved and modified

GET /chats/group/<OID>/participants
PUT /chats/group/<SESSION_ID>/participants>/<PARTICIPANT_OID>/admin

2022-11-08

Arno

Capapility blindTransferEnabled was not returned correctly

GET /me/capabilities

2022-11-04

Arno

Receiving a disabled chat session does not result in an error anymore

GET /chats/<OID>
GET /addressables/<OID>/chat

2022-11-02

Arno

When a user is searching for phones (me/phones), the users collection can be included to determine if this is a softphone

GET /me/phones

2022-11-01

Arno

The primary line information of a user is also returned when reading a user profile

GET /users/<OID>

2022-10-26

Arno

User Profile can be included in the addressable/person search calls

GET /addressable?include=userProfile
GET /persons?include=userProfile

2022-10-25

Marnix

Added CRUD operations for WhatsApp gateways to the API

GET /whatsappgateways
GET /whatsappgateways/<OID>
POST /whatsappgateways
DELETE /whatsappgateways/<OID>
PATCH /whatsappgateways/<OID>

2022-10-24

Arno

Original communication contentSummary and contentSummaryComplete members are now also returned in the communication calls

GET /communications/recent
GET /communications
GET /communications?with=<OID>

2022-10-21

Marnix

Added CRUD operations for external chat gateways to the API

POST /externalchatgateways
GET /externalchatgateways
GET /externalchatgateways/<OID>
PATCH /externalchatgateways/<OID>
DELETE /externalchatgateways/<OID>

2022-10-14

Arno

External chat session through external chat session gateways, the existing External Chat Session will be depricated

External Chat Session From Gateway

2022-10-13

Marnix

Added search for the lists containing a specified addressable

GET /addressables/<OID>/listed_on

2022-09-30

Arno

Capabilities extended with softphone and todo list availability

GET /me/capabilities

2022-09-29

Marnix

Added functionality to get, add and remove group chat participants

GET /chats/group/<OID>/participants
POST /chats/group/<OID>/participants
DELETE /chats/group/<OID>/participants/<OID>

2022-09-22

Marnix

Added create group chat functionality to the API

POST /chats/group

2022-09-22

Arno

Added filter for voicemails for recent communication

GET /communications/recent

2022-09-21

Arno

Retrieve the pbx peers

Peer

2022-09-20

Arno

Video conference api calls

Video Conference

2022-09-19

Arno

Password added to phone search

GET /phones?include=password

2022-09-19

Arno

Save call recording added to phone line search

GET /phonelines?include=saveCallRecording

2022-09-14

Arno

Decline new chat notification

POST /chats/<OID>/decline_invitation

2022-09-14

Arno

Setup linehunting and status flow for external chat sessions

Chats External
POST /phonelines
PATCH /phonelines/<OID>

2022-08-03

Arno

User status can also be set empty in appointments / workschedule

POST /appointments
PATCH /appointments/<OID>
POST /phonelines
PATCH /phonelines/<OID>

2022-07-14

Arno

Person is also added to the communication particpants (addressee), this can show the person who answers a chat from a general line

GET /communications
GET /communications?with=<OID>
GET /communications/<ID>

2022-07-13

Arno

Recent communication also gives the chat session active user, which can be used to show which user is currently active for the line

GET /communications/recent

2022-07-12

Arno

Reassign user to an phoneline/external chat session

PUT /chats/<OID>/reassign

2022-07-12

Arno

Get the list of available users for the phoneline/external chat session

GET /chats/<OID>/available_users

2022-07-12

Arno

The active user is now visible when fetching the chat session (only phoneline and external sessions)

GET /chats/<OID>

v8u1 (xelion) - v1.11 (api)

This update contains a breaking change:

The GET /me/favorites is now returning a list of X1ListItems instead of AddressableInfos.

The Calls DELETE /me/favorites/<OID>, GET /me/favorites/<OID> and PUT /me/favorites/<OID> have been removed.

Date User Description Resource

2022-06-10

Arno

Marking communication as retrieved is only done when the participant filter differs from the line associated addressable

GET /communications?with=<OID>

2022-04-11

Arno

Phone line addressable info or caller name can also be included when searching for the user managed lines

GET /me/managed_lines

2022-04-11

Arno

Added line external number to list of user lines

GET /me/user_lines

2022-04-11

Arno

Capabilities extended the call pick up code/number

GET /me/capabilities

2022-04-11

Arno

Get/Set allow GSM dial if busy state for device

GET /me/device/allow_gsm_dial_if_busy
PUT /me/device/allow_gsm_dial_if_busy

2022-04-05

Arno

Added recordingStatus to GET communication calls

GET /communications/recent
GET /communications
GET /communications?with=<OID>
GET /communications/<ID>

2022-04-05

Wesley

Added update for favorites list

PATCH /me/favorites

2022-04-01

Wesley

Changed the return types of the favorites list and added a call to edit the ordernumber of the favorites

GET /me/favorites
PATCH /me/favorites/<OID>

2022-03-25

Arno

Add member chat attachment retention days, to configure how long the attachments are saved

GET /server/advanced
PATCH /server/advanced

2022-03-23

Arno

Scheduled CSV import has option to upload to default, which make configuration easier

GET /sync/csv
POST /sync/csv/persons
POST /sync/csv/organisations

2022-03-22

Arno

Added function caller announcement, which plays an announcement for the caller before receiving agent(s) are called

XCCPhoneLine

2022-03-18

Arno

Request the recording state of a running user call.

GET /me/calls/<CALL_ID>/is_recording

2022-03-16

Arno

Added transferred from/to name and addressable members to communication. Also add the transferred from/to reason

GET /communications/recent
GET /communications
GET /communications?with=<OID>
GET /communications/<ID>

2022-03-14

Arno

Set recording on/off of a running user call.

PUT /me/calls/<CALL_ID>/toggle_recording

2022-03-14

Arno

Get the trunk numbers that are currently available.

GET /trunks/available_numbers

2022-02-22

Arno

Set device name when registering a device.

GET /me/device/register

2022-02-18

Arno

Capabilities extended to see if callApi, sip or call direct is available as call strategy.

GET /me/capabilities

2022-02-18

Arno

Server settings to disable the call strategies direct(GSM), callApi (webrtc) and sip.

GET /server/pbx
PATCH /server/pbx

2022-02-01

Wesley

Added PacketsLogs fields to Communication

GET /communications_get
PATCH /communications_update

2022-01-28

Arno

Read transferred from and transferred from members of a call log because of secured call logs

GET /communications/<OID>

2022-01-28

Wesley

Added API call to change the user password

POST /me/change_user_password

2022-01-24

Wesley

Added the YealinkCommonCfg field

PATCH /server/provisioning

2022-01-24

Wesley

Removed all the redirection service passwords and added the field yealinkCommonCfg

GET /server/provisioning

2022-01-21

Arno

Presence group entries are ordered by order number

GET /presence/groups/<OID>

2022-01-19

Arno

List of presence groups is ordered by index

GET /presencegroups

2022-01-03

Arno

Chat concept can have an entity reference

PUT /chats/<OID>/concept
GET /chats/<OID>/concept

2022-01-03

Arno

New chat message can have an entity reference

POST /chats/<OID>/messages

2021-12-21

Arno

API call to get the listen in information for an active channel

GET /communications/listen_in_info?<channel_name>

2021-08-26

Arno

Transferred to and transferred from extended with some phone line information when searching for communication.

Communication
GET /communication/<OID>
GET /communications
GET /communications?with=<OID>
GET /communications/recent

2021-08-26

Arno

Added message references (like sended chat contacts) to communication objects.

Communication

2021-11-02

Wesley

Added resellerName to includes and as a search parameter

GET /tenants[?parameters]

v8 (xelion) - v1.10 (api)

This update contains a breaking change: outlookImportDisabled and outlookMaxImports is removed from the server advanced settings
GET server/advanced
PATCH server/advanced

The calls PATCH /server/updates/schedule and PATCH /server/updates/<OID> have been removed, as this data can’t be set by admins anymore.

The field "hdDeactivationFailedMessage" is removed from the GET/PATCH /server/hotdesking, this field was not used in the Xelion configuration.
GET server/hotdesking
PATCH server/hotdesking

Date User Description Resource

2021-08-26

Arno

Removed the unused field hotdesking deactivation failed message.

GET /server/hotdesking
PATCH /server/hotdesking

2021-08-20

Arno

Seperate call to retrieve the unread recent contacts of a user visible line.

GET /me/visible_lines/<OID>/unread_recent_contacts_count

2021-07-20

Wesley

Changed authorization of the phone type list to user.

GET /provisioning/phone_type

2021-07-07

Arno

Added option to include to unread recent contacts of a phone line (include=unreadRecentContactsCount).

GET /lines
GET /me/visible_lines
GET /users/<OID>/visible_lines

2021-06-25

Arno

Added filter isCreatedForGroup chat to get user lines or get user visible lines.

GET /me/visible_lines
GET /me/user_lines
GET /users/<OID>/visible_lines

2021-06-16

Arno

Extended me/info with the personal line information.

GET /me/info

2021-06-14

Arno

Added filter only_users to only search for users in the list addressables call.

GET /addressables

2021-05-25

Arno

Added search filter to the communication object search calls to search on content.

Communication API

2021-05-15

Arno

Added filters missed calls, type, flagged, retrieved and displayed to the communication object search calls.

Communication API

2021-05-11

Arno

Added processed to the communication object and added option to the recent contacts to ignore the contacts where the last communication is processed.

Communication API

2021-05-10

Arno

Added displayed user to communication objects. This shows the name of the user where communication is displayed to. Only implemented for chats to a line (user to line, whatsapp, external web chat).

Communication

2021-05-07

Arno

Get attachment as a binary.

GET /attachments/<OID>/binary

2021-05-07

Arno

Added member outlookDisabled instead of outlookImportDisabled. This disables the installation of the call outlook menu.

GET server/advanced
PATCH server/advanced

2021-05-06

Arno

Added Organisation of the person the recent contacts, had contact with, addressables list, favorites and todo list.

GET /communications/recent
GET /addressables/<OID>/contacts
GET /addressables
GET /me/favorites
GET /me/todo

2021-05-04

Wesley

Added security for provisioningfield which can be updated bij an admin or the user

XCCPhoneProvisioning

2021-04-23

Arno

Added provisioning info to the phones search call.

GET /phones
GET /me/user_phones

2021-03-29

Arno

Added do not disturb selected user phone API calls and extended me/phones with some extra includes.

GET /me/phones/<OID>do_not_disturb
PUT /me/phones/<OID>do_not_disturb
GET /me/user_phones

2021-03-22

Arno

Mark chat session as read if end user patches the communication object as displayed.

PATCH /communications/<OID>

2021-03-19

Arno

Added do not dial if busy API calls.

GET /me/do_not_dial_if_busy
PUT /me/do_not_dial_if_busy

2021-03-10

Arno

Added id to the communication object which is the identifier of the call.

Communication

2021-03-10

Arno

Fetch communication by call id sometimes failed when communication object had a caller_ prefix in the id.

GET /communication<CALLID>

2021-03-04

Arno

Added call to fetch the current user primary line

GET /me/primary_line

2021-03-04

Arno

Added call for toggling the incoming and outgoing flag of the current user lines (user based lines implementation).

PUT me/user_lines/<OID>/toggle_incoming
PUT me/user_lines/<OID>/toggle_outgoing

2021-03-04

Arno

Added call for getting the lines of the current user (user based lines implementation).

GET me/user_lines

2021-03-04

Arno

Speed dial for hot desking user to phone and speed dial to toggle the incoming flag of the user in a user based phone line. (user based lines implementation)

SpeedDial

2021-03-04

Arno

Lines can be added to a user, user based lines implementation

LIST GET CREATE UPDATE User Profile

2021-03-04

Arno

Users can be added to a line, user based lines implementation

LIST GET CREATE UPDATE Phone Line

2021-02-10

Arno

Added time zone to GET local server settings

GET /server/local

2021-01-19

Arno

Anonymous calls are not stacked in the recent communication

GET /communications/recent

2021-01-19

Arno

if domain cannot be read, no domain is returned instead of security exception

GET /me/info

2020-12-22

Arno

Added trigger for tenant started, stopped and status

Trigger event type

v7u4p3 (xelion) - v1.9 (api)

Date User Description Resource

2021-02-10

Arno

Added call to easily fetch the current user presence information

GET /me/presence

2021-01-21

Arno

Transfer 2 selected calls from the device

POST /me/device/calls/<CHANNEL_ID>/transfer

2021-01-07

Arno

me/device/calls is changed and is now returning full call information.
Breaking Change!

List running calls

v7u4 (xelion) - v1.9 (api)

This update contains a breaking change:

The GET /chats/<OID or GET /addressables/<OID>/chat is returning a chatsession. The chatmessages could also be retrieved with this call, this option is removed from this version.

The GET /chats/<OID>/messages is returning chat messages in an ascending order, this now changed to a descending order, the last chat is shown as the first entry.

The PATCH /speeddials/<OID> request could update the audio messages by refering to an attachment and the PATCH /server/hotdesking could update the audio messages by refering to an Audio File, now an attachment patch could be performed by setting a base64String, Audio File or an Attachment. Read the Write Attachment documentation for more information.

The mailFromAddress in Report Schedule is now an aggregate individual Telecom Address and not linked from another address. When creating or updating a report schedule make sure to create or update the telecom address.

The Recent Communication API call was only showing incoming messages. This is now removed and incoming and outgoing messages are shown. To filter on only incoming or only outgoing at the parameter "where=incoming=true" or "where=incoming=false".

Date User Description Resource

2020-10-23

Arno

Phone line search can be filtered by isChatable

Search Phone Line

2020-10-16

Arno

Person patch title is using the correct enumeration
Added missing person titles and removed "None", "Ra", "Unkown"

Update Person
Person Title

2020-10-13

Wesley

Added security calls for lists

Security

2020-10-13

Wesley

Added calls for automatic update

Update - Automatic

2020-09-29

Arno

Fields transferredFrom and transferredTo added to communication object

Communication
Communication API

2020-09-29

Arno

Added phones group for reading phone line phones collections with a phones group

Get Phone Line

2020-09-25

Arno

Added phone line BLF subscription to provisioning

Get Provisioning
Create Provisioning
Update Provisioning

2020-09-22

Arno

Recent Communication default incoming filter is removed
Breaking Change!

Recent Communication

2020-09-22

Arno

Filter communciation search calls on incoming and phone line

Recent Communication
Search Communication
Search communication With

2020-09-22

Arno

Chat concept can have attachments and attachments can be uploaded through an inputstream

Send Chat
Set Chat Concept
Chat Concept Upload Attachment

2020-08-25

Arno

External chat typing, delivered and read status implemented

External Chat

2020-08-21

Arno

User search for phone lines can include associated addressable

Search Lines List

2020-08-18

Arno

Zoho resources added

Zoho

2020-08-17

Wesley

Changed field name in documentation from account to phones, as accounts was in correct and didn’t do anything

Provisioning

2020-07-30

Arno

Fixed list provisioning include phones / accounts, was returning only the last phone/account

Provisioning List

2020-06-30

Arno

Patching object attachment audio upload can be done through contentsBase64String / contentsAudioFile or contentsRef
Breaking Change!

Write Attachment
PATCH /speeddials/<OID>
PATCH /phonelines/<OID>
PATCH /server/advanced
PATCH /server/pbx
PATCH /server/hotdesking

2020-06-19

Arno

Send chat response incoming flag was incorrect

Send Chat Message

2020-06-19

Arno

Chat session delivered call added

Set Chat Delivered

2020-06-18

Arno

Search communication "retrieval" parameter is updating corresponding chat sessions

Communication Search Parameters

2020-06-18

Arno

Chat messages are marked as delivered when recent communication is requested

GET /communications/recent

2020-06-18

Arno

Retrieved parameter can be added to get communication

GET /communications/<OID>

2020-06-17

Arno

Added chat session to Commuunication object

Communication
GET /communications/<OID>
GET /communications
GET /communications?with=<OID>
GET /communications/recent

2020-06-17

Arno

Added deliverd to receiver + read by receiver fields to Commuunication object

Communication
GET /communications/<OID>
GET /communications
GET /communications?with=<OID>
GET /communications/recent

2020-06-12

Wesley

Security can be set for addressables

Security

2020-06-10

Arno

Reply chat messages

POST /chats/<OID>/messages/<OID>/reply
POST /communications/chat/<OID>/reply

2020-06-10

Arno

Forward chat messages

POST /chats/<OID>/messages/<OID>/forward
POST /communications/chat/<OID>/forward

2020-05-27

Arno

Added automated report templates for user report and chat reports, also added user filter to automated report

Automated Reports

2020-05-26

Arno

Added lastUsedOn to telecomAddress, use this to order telecom addresses on the last used date

Telecom Address
GET /addressables/<OID>

2020-05-19

Arno

Get chat messages are now returned in a descending order
Breaking Change!

GET /chats/<OID>/messages

2020-05-19

Arno

Get chatsession not returning messages anymore
Breaking Change!

GET /chats/<OID
GET /addressables/<OID>/chat

2020-05-19

Arno

The wallboard API calls are extended with Chat parameters

Get Wallboard Definitions
Get Wallboard Statistics
Get / Set Phone Line wallboard

2020-05-18

Arno

Download thumbnails seperatly with the Get attachment api call including the parameter "only_thumbnail"

GET /attachments/<OID>?only_thumbnail

2020-05-17

Arno

hasThumbnail flag added to attachment results (like communicatons, contacts, etc)

GET /communications/recent
GET /communications
GET /communications?with=<OID>
GET /communications/<OID>

2020-05-13

Arno

Chat concept messages can be saved and retrieved

chats/<OID>/concept
Get, Set

2020-05-07

Arno

Added thumbnails to communcation API calls, use include attachments,thumbnails to query the thumbnails.

GET /communications/recent
GET /communications
GET /communications?with=<OID>
GET /communications/<OID>

2020-05-07

Arno

New chat message can have text + an attachment

POST /chats/<OID>/messages

2020-04-28

Wesley

Added useTftpProvisioning to provisioning

Provisioning

v7u3 (xelion) - v1.8 (api)

This update contains a breaking change:

Fields that are used for provisioning hardphones, have been removed from the Phone object and moved to a new Provisioning object. Also the generate configuration and the get phone types call have been changed and moved to provisioning
Provisioning

Name of "wallpaperLocation" field is changed to "phoneWallpaperUrl".
Provisioning

The GET phone call is giving a full userprofile in the member "user" and "users". The full userprofile must be requested in a seperate API call.
GET /phones/<OID>.

The fields: gigasetProvisioningUrl, gigasetServerName, gigasetRpsUrl, panasonicRpsUrl, snomServerName, snomRpsUrl in Provisioning Settings are removed.
GET PATCH /server/provisioning.

The Automated Report scheduling and export fields are moved to the Report Schedule object.
GET CREATE PATCH /reports.
GET CREATE PATCH /reportschedules.

Date User Description Resource

2020-04-08

Arno

Read / write / update wallboard entry of type FORMULA

Phone Line

2020-03-23

Luca

Rename "wallpaperLocation" field to "phoneWallpaperUrl"
Breaking Change!

Provisioning

2020-02-27

Luca

Add Exchange / Microsoft 365 import, notification subscription, authentication token update, settings retrieval, settings update

Exchange / Microsoft 365

2020-02-27

Luca

Add Authentication settings calls

Server Settings

2020-02-26

Arno

Added wallboard member to phone line for security purposes

Phone Line

2020-02-21

Arno

Administrator can read, write, update user preferences wallboard collection

/users/<OID>
Get, Create, Update

2020-02-21

Arno

Bugfix: Uploading music can hold category files can be done by a tenant Administrator

PUT /musiconholdcategories/<OID>/upload

2020-02-21

Arno

Added special error code if chat session is disabled

Chat

2020-02-21

Arno

Get chat session also shows the chat session end date

GET /chats/<OID>
GET /addressables/<OID>/chat

2020-02-21

Arno

Send a chat returns the created communication id

POST /chats/<OID>/messages
POST /addressables/<OID>/messages

2020-02-21

Arno

Chat session type added to communication calls

/communication/*
Recent, List, With, Get

2020-02-18

Arno

Location Create Delete Update calls added

/locations/<OID>
Create, Delete, Update

2020-02-17

Arno

Automated reports scheduling is now seperated in Report Schedule object
Breaking Change!

Automated Reports
Report Schedules

2020-01-30

Arnon

Add maxVoicemailLengthSec to PBX settings

PBX settings

2020-01-28

Arno

List of valid caller id’s can also contain an empty option to show the "default" option

GET valid caller IDs

2020-01-28

Arnon

Added an option to include attachments in communication list

GET Communications

2020-01-06

Arno

Temporarily recordings export, remove calls

Export/Remove Attachments

2019-12-24

Arnon

Update user attribute countrySettings

PATCH User

2019-11-21

Wesley

Added provisioning

Provisioning

2019-11-21

Wesley

Moved fields from the phone object to the (new) provisioning object
Breaking Change!

Phones

2019-11-12

Arno

Bug fix, phone line change call log users, was not updating domain correctly

PATCH /phonelines/<OID>

2019-11-06

Arno

Added user filter to phones search

GET /phones

2019-11-06

Arno

List user’s phones

GET /me/phones

2019-11-05

Arno

Simple attachments (like voicemail / annoucement) can be created / changed

write attachments

2019-11-04

Arno

Phone registration / unregistration date was not correctly received

GET /phones

2019-11-04

Arno

Username can now be included in the user search call

GET /users

2019-11-04

Arno

OMM configuration

/omms/<OID>
List, Create, Get, Delete, Update

2019-11-01

Arno

OMM message definition configuration

/ommmessagedefinitions/<OID>
List, Create, Get, Delete, Update

2019-10-31

Arno

User message definition configuration

/usermessagedefinitions/<OID>
List, Create, Get, Delete, Update

2019-10-30

Arno

Message routing configuration

/messageroutings/<OID>
List, Create, Get, Delete, Update

2019-10-17

Wesley

Added MacId field to Phone for use with gigaset only

GET /phones/<OID>
PATCH /phones/<OID>

2019-10-16

Arno

Bug fix: presence group all now showing all presence list entries

GET /presence/groups/<OID>

v7u2 (xelion) - v1.7 (api)

This update contains a breaking change: The external device configuration of a backup schedule, automated report or csv import schedule is changed.
GET PATCH POST /backupschedules
GET PATCH POST /reports
GET PATCH /sync/csv.

The field matchByIpAddress in the trunk configuration is removed.
GET PATCH /trunks.

HTTPS is required now, so make sure you use HTTPS to connect with the API!

Date User Description Resource

2019-09-05

Arno

Added gigaset/panasonic provisioning fields
ldap fields, hardphone pickup fields

GET /server/provisioning
PATCH /server/provisioning
GET /server/ldap
PATCH /server/ldap
GET /server/pbx
PATCH /server/pbx

2019-09-12

Hans

Trunk member matchByIpAddress replaced by acceptUnknownNumbers

Create, Get, Update

2019-09-05

Arno

Community cloud configuration

GET /users/<OID>
POST /users
PATCH /users/<OID>
GET /server/community
PATCH /server/community

2019-09-05

Arno

Renewal token added to renew tokens

POST /me/login
POST /me/renew

2019-08-15

Arnon

The phone-lines may be included in a phones search request.

get /phones

2019-08-09

Arnon

Lists management

List, Create, Get, Delete, Update

2019-08-09

Arno

Bug fix, creating active hotdesking speed dials was not possible

POST /speeddials

2019-08-06

Arno

Countrysettings added to triggers to change number to a local format

GET, POST, PATCH /triggers

2019-07-19

Arno

List licenses can also be retrieved by tenant administrator

GET /licenses

2019-07-19

Arno

Person reader also gives linked user profile if there is any

GET /addressables/<OID>

2019-07-09

Arno

added voicemailRecipientAddress + enableVoicemailToEmail to phone line API reader / updater

GET /phonelines/<OID>
PATCH /phonelines

2019-07-09

Arno

Added call flow id and call id to get communication

GET /communications/<OID>

2019-07-08

Arnon

List user’s managed phone lines

GET /me/managed_lines

2019-06-28

Arnon

The app key is added to the login credentials

Login Credentials
POST /me/login

2019-06-28

Arnon

Wallboard agents data is merged by person

GET /wallboards/<OID>
GET /wallboards/<OID>/stats

2019-06-28

Arno

Changed external device configuration and added FTP option here

GET PATCH POST /backupschedules
GET PATCH POST /reports
GET PATCH /sync/csv

2019-05-27

Arno

Added icon id to presence list calls

GET /presence
GET /presence/goups/<OID>

2019-04-16

Arno

Added hide calls overview option to the capabilities

GET /me/capabilities

2019-04-05

Arno

Bug fix, search communication including participants with a high limit was not showing participants

GET /communications

v7u1p1 (xelion) - v1.6p1 (api)

Date User Description Resource

2019-04-11

Arno

Bug fix, person updater wrong member error when updating common name/comment + a personal member (like personal addresses)

PATCH /addressables/<OID>

v7u1 (xelion) - v1.6 (api)

Date User Description Resource

2019-03-21

Arno

Employee department name + job title is given when employment is included in addressable search

GET /addressables

2019-03-15

Arno

Get visible lines of user

GET /me/visible_lines

2019-03-12

Arno

Updated API with new database members in update 7.1

multiple resources

2019-03-11

Wesley

Member "type" can be updated correctly in the PATCH phone call

PATCH /phones/<OID>

2019-10-06

Arno

Member "customProvisioningOptions" is now read and written correctly (with the contents) in the GET phone template call

GET /phonetemplates/<OID>

2019-03-06

Arno

Search entity by charachters within name and filter by syncsource

Common Search Parameters

2019-03-05

Arno

Attachment export, remove, shrink calls

Export/Remove/Shrink Attachments

2019-02-15

Arno

Added action to calculate the tenant disk usage

POST /tenants/calculate_disk_usage

2019-02-15

Arno

Added extra disk usage fields for tenant (only postgres databases)

GET /tenants?include=<usage field>
GET /tenants/<OID>

2019-02-13

Arno

Paging went wrong when sorting on number(oid) and number was increasing to more digits

All search requests

2019-02-11

Arno

Participants added when searching for communication with include all

GET /communications?include=all

2019-02-11

Arno

Get lines of user

GET /me/lines

2019-02-08

Arno

Include flat fields for search addressables

GET /addressables
GET /addressables/persons
GET /addressables/organisations
GET /addressables/objects
GET /addressables/<OID>/colleagues

2019-02-07

Arno

Get/Set call strategy for device

GET /me/device/call_strategy
PUT /me/device/call_strategy

2019-01-30

Arno

From, until date and phone line filters added for search communication

GET /communications
GET /communications?with=<OID>

2019-01-30

Arno

Before and after filters can also be an UTC date

GET /communications?with

2019-01-29

Arno

Chat is typing event added

POST /chats/<OID>/messages

2019-01-15

Arno

Bug fix, Restore backup was checking on the wrong tenant id

PUT /backupschedules/<OID>/restore

2019-01-15

Arno

Join addressable adds the unknown number to the selected addressable (if it is not there yet)

POST /addressables/<OID>/join

2019-01-15

Arno

Create object is returning the object read value, quiet option is added when only the entity values needs to be returned

POST request for creating objects

2018-01-11

Arno

Phone line reader missing some direct field values (externalnumber, voicemail settings)

GET /phonelines/<OID

2018-12-07

Arno

Appointment starttime and endtime patch is now handled atomic

PATCH /appointments/<OID

2018-12-05

Arno

Added call to get the current night mode

GET /phonelines/<OID>/night_mode

2018-11-29

Arno

Maximum attachment size added

GET /me/capabilities, Send Chat

2018-11-26

Arno

Userprofile added to call logs

GET /communications/…​

2018-11-21

Arno

Anonymize moved to communicatons and perdiod filter added, the addressables/[id]/anonymize call is now depricated

POST /communications/anonymize

2018-11-14

Wesley

Added dialPrefix field to trunks calls

Trunks

2018-10-31

Arno

Last contact with is not returning the selected addressable anymore

GET /addressables/<OID>/contacts

2018-10-25

Arno

Presence group admin API calls

Presence Groups

2018-10-23

Arno

Phone line day night mode switch day is now saturday, not saterday

Phone Lines, Days Enum

2018-10-23

Arno

External phone user can be set

POST /phones

2018-10-23

Arno

Filter communications by voicemail

GET /communications?where=voicemail=true

2018-10-23

Arno

List Phone Lines, Phones and Users is extended with multiple include fields

Phone line, phones, users list resources

2018-10-16

Arno

Communication objects can also be received by call id

GET /communications/[id]

2018-10-15

Arno

Extended capabilities with scheduled call, blind transfer, twin through softphone, outlook, pause call recording, call parking number, licnese expired

GET /me/capabilities

2018-10-12

Arno

Member "customProvisioningOptions" is now read correctly (with the contents) in the GET phone call

GET /phones/[oid]

2018-10-12

Arno

Recent contacts of addressable are sorted by date and are paged

GET /addressables/[oid]/contacts

2018-10-12

Arno

Colleagues can be sorted by name and are paged

GET /addressables/[oid]/colleagues

2018-10-04

Wesley

Added the field defaultLine to the Trunks

Trunks

2018-10-04

Wesley

Added an ordernumber to the assignedNumbers field of a Trunk

Trunks

v7u0p5 (xelion) - v1.5p1 (api)

Date User Description Resource

2018-10-29

Wesley

Added call to get a list of log entries calls

Get logs

2018-10-23

Arno

Phone lines with auto attendant audio message can be requested

GET /phoneslines/[oid]

2018-10-05

Arno

Added order + search by name to the default search/list calls

All common search/list resources

v7u0 (xelion) - v1.5 (api)

This update contains a breaking change: The normalization rules of the server locale settings are replaced by the new country settings object.

Date User Description Resource

2018-09-11

Arnon

Manage phone channels. (Beta)

Resources - Channels

2018-09-04

Arnon

For HTTP responses with payload: the charset (utf-8) is specfied in the Content-Type header

2018-09-03

Wesley

Fixed a bug where the voicemailToEmailSender field couldn’t be updated

Update Settings - Email

2018-08-31

Arno

Chat content can have a maximum of 4000 characters, improved error message

Send Chat

2018-08-30

Arnon

Search by phone-number option in search phone-lines

List Phone Lines

2018-08-29

Arno

Added order number member to employee, telecomAddresses, phone line extensions, phone line allowed number collections

resources

2018-08-28

Arno

Wait until call confirmed state can be set for device

Device

2018-08-20

Arno

Added user id to user info call

GET /me/info

2018-08-05

Arno

Added country settings API calls

Country Settings

2018-07-19

Arno

Added agent show inbound, outbound or total number of calls booleans are added to the wallboard definitions

GET /wallboard/[oid]

2018-07-18

Arno

Added anonymize communication of an addressable

POST /addressable/[oid]/anonymize_commiunication

2018-07-13

Arno

Added busy flag to the addressable search results, this shows the busy status of the addressable

GET /addressables

2018-07-11

Arno

Bugfix: Chattable MRU search was not showing the correct icon id

GET /addressables?type=chattables

2018-07-09

Arno

When a chat session is opened with a group or user, it is shown on top on the next chattable MRU search

GET /addressables?type=chattables

2018-07-05

Arno

Added traffic classes API calls

Traffic Classes

2018-06-27

Arno

Bug fix for patching all end/start day appointments, time was not handled correctly

PATCH /appointments

2018-06-21

Arno

Bugfix, created trunks where not visible in admin and not used by Xelion

POST /trunk

2018-06-21

Arno

Extended addressable patch resources to be compatible with the current API model (addresses, telecomAddresses, employments)

PATCH /addressable/[oid]

2018-06-20

Arnon

A resource to list organisations

GET /addressables/organisations

2018-06-20

Arnon

A resource to list objects

GET /addressables/objects

2018-06-20

Arnon

A resource to list persons

GET /addressables/persons

2018-06-20

Arnon

Send SMS returns object-id and object-type only (no contents, etc.)

POST /communications/sms

2018-06-07

Arno

Bug fix, tenant license counts without license are now ignored

GET /tenants/[oid]

2018-06-07

Arno

Added the 'provision tenant licenses on use' to tenant provisioning settings requests

/tenants/provisioning

2018-06-01

Arno

Added the host information and failed login information to the userprofile get request

GET /users/[oid]

2018-05-23

Arno

Bug fix for all end/start day appointments, time was not handled correctly

POST /appointments

2018-05-23

Arno

Added the login and logout date to the userprofile get request

GET /users/[oid]

v6u22 (xelion) - v1.4 (api)

Date User Description Resource

2018-05-01

Wesley

Added the phones field to the userprofile

Users

2018-04-26

Arno

Added license server logout and list resellers calls

Order License File

2018-04-25

Wesley

Added the user field to phone calls, as the current users field is only available for softphone objects

Phones

2018-04-23

Arno

Bug fix, sometimes objecttype was unavailable on backend which made API calls broken

All Resources

2018-04-20

Arno

Added call to confirm an incoming call

Confirm Call

2018-04-20

Arno

Recent communication only returns contacts with from participants

Recent Communication

2018-04-20

Arno

Recent communication contact addressee is filled when no addressable is found, this is a phone number or contact name

Recent Communication

2018-04-20

Arno

Addressee commonname is filled with the most accurate caller name

Communication

2018-04-16

Arno

Added message routing calls for sending messages from xelion

Message Routing

2018-04-16

Arno

Initate calls from the current user session

Initiate Call

2018-04-13

Arno

Added csv import schedule calls

Csv Import Schedule

2018-04-11

Arno

Send chat message response date is in UTC

Send Chat Message

2018-04-06

Arno

Espa Call and XCC Message now has correct participants and filled contents

Communication

2018-04-05

Arno

Added temporary status and location to user phone line

User Phone Line Settings

v6u21 (xelion) - v1.3 (api)

This update contains a breaking change: The participants of an appointment
are linked now through a relation object.

Date User Description Resource

2018-02-28

Wesley

Added all automated report calls

Automated Reports

2018-02-23

Arno

Added all audio file calls

Audio files

2018-02-23

Arno

Audio files link is changed from audioFiles to audiofiles

GET /audiofiles

2018-02-23

Arnon

The change-type is no longer needed when creating objects

all create-object resources (HTTP POST [resource])

2018-02-23

Arnon

The participants of an appointment
are linked now through a relation object.
Breaking Change!

GET /appointments/[oid]

2018-02-16

Wesley

Fixed bug where the status of the master tenant was NOT_LOADED and should have been IN_USE

GET Tenant

2018-02-16

Arno

Bug fix communication search (addressee oid was incorrect
addressable was set when non existing

GET Communications

2018-02-15

Wesley

Added hotdesking of a phone to a phoneline

Server Settings

2018-02-01

Wesley

Added the Updating and Getting of TFTP IpTable Rules to Provisioning settings

Server Settings

2018-01-19

Wesley

Added the updating of numbermapping to Trunk

PATCH /trunks

2018-01-17

Wesley

Get list of audio files call

GET /audioFiles

2018-01-17

Wesley

Added hotdesking settings calls

Server Settings

2018-01-15

Wesley

Added tenant provisioning calls

Tenants

2018-01-12

Wesley

Added phonetemplate field to reader, writer, updater of Phone

Phone

2018-01-11

Wesley

Added documentation for server settings

Server Settings

2018-01-09

Arno

Added calls for phone line / call pickup groups

Phone line / call pickup groups

2018-01-08

Arno

Added calls for music on hold categories

Music on hold categories

2018-01-05

Arno

Added calls for backup schedules

Backup schedules

2018-01-04

Wesley

Added function to generate phone from template

Create Phone from Template

2018-01-04

Wesley

Added phone template calls

Phone Templates

2018-01-02

Arno

Communication search / read results are extended with extra call information

Communication

2017-11-22

Arno

Added function to set up a call between two numbers

POST /communications/call

2017-12-20

Arno

Phone can be set on do not disturb

Do not disturb phone

2017-12-11

Arno

Security settings can be read / edited for specific objects

Security

2017-12-05

Arno

Bug fix, location in workschedule could not be read

GET /me/phone/settings

2017-12-05

Arno

Added speed dial property updater

PATCH /speeddials/<OID>

2017-12-05

Arno

Added calls for triggers

Triggers

2017-11-29

Wesley

Added the uploading and starting of an update file

Update Server

2017-11-23

Arno

Added option to show the first employment of a person in the addressable search results

GET /addressables

2017-11-23

Arno

Added keywords to mru search results

GET /addressables

2017-11-23

Arnon

Before-date option for recent communication

GET /communications/recent

2017-11-22

Wesley

Added inbound, outbound and average call time to agent statistics

GET Wallboard statistics

2017-11-22

Wesley

Fixed an error in the example documentation for adding phone numbers

PATCH /trunks

2017-11-17

Arno

Added option to show the status of an addressable

Addressables

2017-11-14

Arnon

Filter users list with the user-name

GET /users

2017-11-13

Arno

Added icon to colleagues

GET /addressables/<OID>/colleagues

2017-11-06

Wesley

Added Speed-dials calls

2017-10-28

Arno

Bug fix: me phone settings could not be determined when workschedule with template was enabled.

2017-11-03

Arno

Bug fix: telecom type could not be written when telecom address was added.

2017-11-03

Arno

Bug fix: to participants of email where shown as contact in the recent communication.

v6u20 (xelion) - v1.2

Date User Description Resource

2017-10-04

Arno

Added version call

2017-10-03

Arno

Added unknown addressable for from email addresses

2017-10-02

Wesley

Added the field phone to communication / calllog

2017-09-29

Arno

User search also returns administrators

2017-09-29

Arno

Patch todo list communication

2017-09-29

Arno

Added gzip compression

2017-09-29

Arno

Added documentation for recent communication / inbox

2017-09-28

Arno

Added voicemail and voicemailIsHeard to communication

2017-09-28

Arno

Added retrieval to communication, set for communication list

2017-09-22

Arno

Extended capabilities

2017-09-19

Arnon

Adjusted statistics logging: session restoring time is measured apart, leaving the request elapse time to measure the request only.

GET /server/statistics

2017-09-08

Arnon

Added methods to retrieve server statistics

GET /server/statistics

2017-09-08

Arno

Added patch communication, added manager and call log security to phone line, add enumeration getter

2017-09-08

Arnon

The login response contains the API build number.

POST /me/login

2017-09-05

Arnon

Added an update request for persons and organisations

PATCH /addressable/OID

2017-09-01

Arnon

Added a filter to presence list request to query the phone line name.

GET /presence

2017-08-30

Arno

Colleague list can now also be determined by organisation

2017-08-29

Arno

Added extra, user line settings, voicemail, queue, wallboard, auto attendant, workschedule to the phone line.

2017-08-25

Arnon

Tenant updater can edit licenses.

PATCH /tenants/<ID>

2017-08-24

Arnon

The requested resource is returned in an error response in the info attribute.

ErrorResponse

2017-08-24

Arnon

The attribute StatusEnum is added to the tenants list.

GET /tenants

2017-08-23

Arno
Arnon

Added license calls get/install/order.

2017-08-18

Arno
Arnon

Added call to login to tenant from master tenant session.

POST /tenants/<ID>/login

2017-08-18

Arno

Added automatic transfer / forward caller id map to the phone line.

2017-08-16

Wesley

Changed the get phone from phone to phones

2017-08-16

Wesley

Changed the get calendar from addressable call from calendar to calendars

2017-08-16

Wesley

Changed the appointment call to appointments

2017-08-16

Wesley

Phone patch call to add function keys is changed

2017-08-03

Arno

Phoneline patch call to add and remove a phone or number is changed.

2017-08-03

Arno

Todo patch call to add an item is changed.

2017-08-03

Arno

Patch is also shown in field serverVersion when login call is returned.

2017-07-27

Wesley

Added a type parameter to Get Phone Types from a certain brand

2017-07-27

Wesley

Added calls to generate provisioning cfg files on the server

2017-07-27

Wesley

Added calls to get phoneTypes

2017-07-27

Wesley

Added calls to read, create, update & delete a phone

2017-07-27

Wesley

BugFix: Recurring appointments weren’t returned if terminationtype was endDate or forever.

2017-07-27

Wesley

BugFix: Couldn’t find un-normalized addressables (e.g: couldn’t find 06-12345678, instead you had to use +31612345678.)

2017-07-27

Wesley

Created apointments are now always Read-Only

2017-07-26

Arno

Added calls for configuring the day night mode of a phone line.

2017-07-17

Arno

when addressable has no employments an empty list is returned when getting colleagues.

2017-06-26

Arno

Also filter on enddate when getting colleagues.

v6u19 (xelion) - v1.1 (api)

Date User Description

2017-05-28

Wesley

Changed appointment calls. Instead of /calendar/<addressable oid>/<appoinment oid> use /appointment/<appointment oid>.

2017-05-28

Wesley

Added calls to give the first available pre loaded tenant

2017-05-05

Arno

All the todo list calls are changed for redesign.

2017-05-05

Arno

Number of contacts are given when colleague list is requested.

2017-05-05

Arno

Bugfix: Associated addressable in chat communication objects was of type comment.

2017-05-05

Arno

Bugfix: Before and after calls in communication with call was incorrect.

2017-05-05

Arno

Added calls to import CSV files for automatic CSV import.

v6u18 (xelion) - v1.1 (api)

Date User Description

2017-04-30

Arno

Added basic phone line calls.

2017-03-20

Arno

Added basic user profile calls.

2017-03-20

Arno

Added sync informtion to entity + new call to get an object by syncid.