The VIVR VXML Connector server exposes a web service as a RESTful service, to retrieve routing information for a specific customer Interaction. Routing information exposed by the web service includes:

  • Transfer Destination: The transfer destination provided by the VXML script.
  • Transfer AAI: Application to Application Info provided by the VXML script.

URI Syntax and Example
http://[host:port]/interact/agent/version/2/account/vivr/interactiondata/[interaction unique id]/variableSet/routingDataSet
For example:
http://example.vivr:8982/interact/agent/version/2/account/vivr/interactiondata/95959595/
variableSet/routingDataSet

HTTP Method
GET

Request Headers
A dedicated application key with permissions to invoke the API is provided with VIVR VXML Connector. This application key and the VIVR VXML Connector account ID must be sent as a request header when invoking the service. The required headers are:

  • Application-Key: agentappkey
  • Tenant-Id: vivr

Request Example

GET interact/ /agent/version/2/account/vivr/interactiondata/95959595
/variableSet/routingDataSet
HTTP/1.1
Host: example.vivr:8982
Accept: application/json, application/*+json
Application-Key: agentappkey
Tenant-Id: vivr
Connection: keep-alive
User-Agent: Java/1.7.0_09

Response
HTTP OK 200
The response body will hold a JSON object describing the routing data in a key-value format.
The response will hold the

Transfer Destination

and

Transfer AAI

parameters that were defined in the transfer command in the vxml.

Response Example

{
  "voice" : {
    "data" : {
      "transferDestination" : "tel:+12223334444",
      "transferAai" : "application to application information"
    }
  }
}

Revision:

Comments