Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Rest API Trigger Data

The API trigger allows you to automatically execute your Rest REST API during specific points of an interaction.   The configuration of API trigger allows you to specify When and what REST API dataData to trigger.   Please Before proceeding through this document - refer to the documentation on REST API which contains details on which data elements can be passed.

The “When” allows for control of the timing for an API call/push to occur. This is related to an event in the ECS interaction flow or lifecycle.

When:

Image Added

  • Interaction Starts: The Selected API call calls will trigger at the start of an interaction. 
    • If the selected API call is a POST, please be aware certain values may not yet be available. (I.E. Disposition Code).
  • Interaction Ends: The Selected API call calls will trigger at the end of an interaction.
  • Internal Transfer: The Selected API call calls will trigger on each internal transfer from an agent or supervisor.
  • Segment Change: The Selected API call will trigger on each segment change, example list below.
    • Handling -> Agent Selecting
    • Agent Selecting -> Overflow
    • Agent Selecting -> Abandoned
    • Handling -> Handled

...

    • Interaction Starts (Channel)
    • Interaction Starts (Business Process)
    • Interaction Starts (Agent)
    • Offered (Channel)
    • Offered (Business Process)
    • Offered (Agent)
    • Agent Selecting (In Queue)
    • Consulting
    • In Conference
    • Handling (Channel)
    • Handling (Business Process)
    • Handling (Agent)
    • Wrap Up
    • Dialing
    • Rejected
    • Overflow
    • Missed
    • Preview
    • Interaction Ends (Channel)
    • Interaction Ends (Business Process)
    • Interaction Ends (Agent)

Rest API Data: A drop-down list listing of your available configured REST API datacalls.Image Removed

Image Added