Integration interfaces

The following changes have been made in the RESTful and integration interfaces.

Restful Configuration Interface (RCI)

The interface has the following improvements and new features:

  • New settings have been added to the userSettingsTemplates resource:
    • ECFUI_HideWrapupTimerStopButton (new field Hide button to stop wrap-up timer in System Configurator, see Hiding Stop wrap-up timer button)
    • ECFUI_EnableSupervisorSilentMonitoring (field Enable Silent Monitoring)
    • ECFUI_CloudAttachmentsEnabled (field Enable Cloud Attachments)
    • ECFUI_E911Enabled (field Enable Emergency Locations)
    • ECFUI_OptionalOfferingScreenItems (field Optional Information in Offering Screen)
    • ECFUI_PdfPrintEnabled (field Show PDF Button)
    • ECFUI_DownloadRecordingEnabled (field Show Download Button for Call Recording and Voicemail)
    • ECFUI_LogRecordingEnabled (field Use Recording Activity Log)
    • ECFUI_LogLevel (field Log Level)
    • ECFUI_EnableMobileApp (field Show QR code for app setup in Communication Panel or Launchpad)

Restful Monitoring Interface (RMI)

GET /RI/rmi/contacts now supports subtypes for phone channel as well.

Restful Contact Management Interface (CMI)

The POST method of the contactData resource now supports also updating CAD in email conversations.

The GET /cmi/customerConsents resource now returns the date and time when consent has been created (field creationTime). This field can also be used to filter consents (query parameters creationTime and creationTimeEnd).

GET /RI/cmi/contacts now supports subtypes for phone channel as well.

Restful License Reporting Interface (LRI)

LRI now returns data for a specified time range, including user name and the number of times they logged in during that period. Use the following query parameter values for lri/data:

  • details=1

    This returns A. and U. features in addition to other features.

  • details=2

    This returns only U. features.

For more information, see LRI.html.

Restful Directory and Presence Interface (DPI)

A new field subtype has been added to the GET method of the template resource. This is related to the support added for conversational messaging apps not based on phone number.

Event-driven integration framework

CALL_ID (known as Group ID in Dashboard) and CallGUID (known as Conversation ID in Dashboard) have been swapped.

Important:

Please check your EDI configurations used for calls. If you're using these IDs in your call-related configurations, your integration will not work correctly:

Property JSON data type Description Reference syntax Example values
ID string

Unique routing leg identifier of the contact

For emails, this is the same as Group ID.

For example:

  • Can be used as the contact identifier for the /contacts resource of CMI and RMI
  • Can be used as the contact identifier for the /emails resource of CMI
  • In Dashboard, this is known as Conversation ID
 {contact.id} 
1166301942A6EE11B3ED58961D1810CC
Group ID string

Unique group identifier of the contact

For emails, this is the same as ID.

For example:

  • Can be used as the group identifier for the /chats resource of CMI
  • Can be used as the contact identifier for /emails resource of CMI
  • In Dashboard, this is known as Group ID.
 {contact.guid} 
5AB6E20342A6EE11B3ED58961D1810CC

EDI now hides all X-headers from logging in case they contain sensitive data.

Event driven integrations can now be triggered also when wrap-up for a conversation ends.