8x8 Contact Center Data Augmentation API

Base URL

All URLs referenced in the documentation have the following base:

https://<your cluster>/api/tstats/interaction/data

Revise your query URL based on the login URL of your Tenant. Refer to the Platform URL Guide to retrieve your login URL.

Authentication

The API is authenticated with HTTP Basic Authentication, which needs tenantId as the username and action token of the tenant as the password.

Examples

Example 1: The following example shows how to set variables for an interaction. The interaction is identified by the SIP call Id of the eIVR leg:

{
    "variables": [{
        "name": "_queueId",
        "value": "201",
        "ivr": "true"
    }, {
           "name": "_SSN",
            "value": "111-22-3333",
            "ivr": "true",
            "privacy": "true"
    }, {
            "name": "_amount",
            "value": "110.55",
            "display": "true",
            "displayName": "Amount Due"
    }, {
            "name": "_dueDate",
            "value": "04 July 2019",
            "ivr": "true",
            "display": "true",
            "displayName": "Due Date",
            "dataType": "date"
    }]
}

Example 2: The following example shows how to set variables for an interaction. The interaction is identified by the interaction guid of the call:

{
    "variables": [{
        "name": "_queueId",
        "value": "201",
        "ivr": "true"
    }, {
        "name": "_SSN",
        "value": "111-22-3333",
        "ivr": "true",
        "privacy": "true"
    }, {
        "name": "_amount",
        "value": "110.55",
        "display": "true",
        "displayName": "Amount Due"
    }, {
        "name": "_dueDate",
        "value": "04 July 2019",
        "ivr": "true",
        "display": "true",
        "displayName": "Due Date",
        "dataType": "date"
    }]
}

Example 3: The following example shows how to get all the context associated with an interaction.  The interaction context will be returned as a json object (the format is described below). The interaction is identified by the interaction guid of the call:

curl -H "Content-Type: application/json" -X GET -u acme:00a5c5dd78ba119df8e361288b709e4c2d19ef440c0f2af96d48ead1faa78c9b 'https://vcc-sb1.8x8.com/api/v1/interaction/data/guid/int-1628bb9dbf7-YUTGAUsGrJDvPC9DqMgJr01iy-phone-01-acme'

 NOTE: Using curl on Windows you will need to replace the single quotes (') in the example above to standard quotation marks (").

Query Parameters

The following parameters are allowed as POST/GET parameters to be passed along with the Interaction Data Augmentation URL. All the parameter data should be URL encoded.

Input JSON description

The API allows the client application to set any number of variables bypassing the data in JSON format. There is no limit on how many number of name/value data can be used to compose the json string. The API supports setting certain metadata about a variable, that allows the caller to control how the variable is used within the application. A description of the meta data is provided in the table below. The following json is used as an example for describing the json format:

{
    "variables": [{
            "name": "_queueId",
            "value": "201",
            "ivr": "true"
        },
        {
            "name": "_SSN",
            "value": "111-22-3333",
            "ivr": "true",
            "privacy": "true"
        },
        {
            "name": "_amount",
            "value": "110.55",
            "display": "true",
            "displayName": "Amount Due"
        },
        {
            "name": "_dueDate",
            "value": "04 July 2019",
            "ivr": "true",
            "display": "true",
            "displayName": "Due Date",
            "dataType": "date"
        }
    ]
}

Output json description

The API allows a client application to retrieve all context data associated with an interaction. The description of the content of the json object is described in the table below.

Response Codes