Exposed

The exposed endpoint is called when a new Nuance engagement launches in the client application.

https://{tagserver.domain}/tagserver/v1/dataCollection/exposed

URI	exposed
HTTP Method	POST
Formats	JSON

Parameters

Parameter Name	Description	Required	Data Constraints
tcCustomerID	The customerID is provided by the Nuance Engagement API when the /engagement endpoint is called or by the Nuance Data Collection API when the /startSession endpoint is called.	Yes	String, possible values are: [a-z], [A-Z], [0-9], [-], [_]
siteID	Id of site provided by Nuance and will be a static value for client application	Yes	Integer
businessRuleID	Business rule ID is used to tie this engagement to a business rule for reporting purposes	Yes	String, possible values are: [a-z], [A-Z], [0-9], [-], [_]
viewID	Identifier for the current content displayed (or otherwise provided) to the customer	No	String
sessionID	Id of current session	No	String, possible values are: [a-z], [A-Z], [0-9], [-], [_]
businessUnitID	Id of current business unit provided by Nuance to use Nuance platform. This parameter the same as agentGroupID parameter is used only to determinate hours of operations in call moment. Priority to get hours of operations in case when both agentGroupID and businessUnitID are set is next: get this data by agentGroupID value first and after by businessUnitID parameter. If both business unit level and agent group level settings are configured then only agent group level settings are used. Hours of operation is always true if this field is absent and agentGroupID is also not set.	No	Integer
agentGroupID	Id of current agent group provided by Nuance to use Nuance platform. This parameter the same as businessUnitID parameter is used only to determinate hours of operations in call moment. Priority to get hours of operations in case when both agentGroupID and businessUnitID are set is next: get this data by agentGroupID value first and after by businessUnitID parameter. If both business unit level and agent group level settings are configured then only agent group level settings are used. Hours of operation is always true if this field is absent and businessUnitID is also not set.	No	Integer
conversationID	Id of NDEP async chat conversation, used for async chats only	No	Integer
initialCustomerID	Id of initial customer Id for NDEP async chat conversation, used for async chats only	No	Integer
routingAttributes	List of any name/value routing attributes that you want to associate to this event	No	N/A
routingAttributes:name	Name of this routing attribute	Yes	String
routingAttributes:value	Value of this routing attribute	Yes	String
businessRuleAttributes	List of any name/value business rule attributes that you want to associate to this event	No	N/A
businessRuleAttributes:name	Name of this business rule attribute	Yes	String
businessRuleAttributes:value	Value of this business rule attribute	Yes	String
attributes	List of any modifiable name/value attributes that you want to associate to this customer, engagement or session.	No	N/A
attributes:name	Name of this attribute.	Yes	String
attributes:value	Value of this attribute. Can be multi-valued.	Yes	String
attributes:attributeType	Type of attribute that we are setting or modifying.	Yes	Must be one of: engagementAttribut visitorAttribute applicationAttribute
attributes:action	Action to be performed on this attribute.	No	Must be one of: append set remove Default value is append.
attributes:externalCustomerID	Can be used only for visitor attributes. If this visitor attribute can be used as a unique identifier for this user, please indicate it using a yes value in this field.	No	Must be either yes or no. Default is no.
customVariables	Can be used to store information that can be used for targeting.	No	N/A
customVariables:name	Name of this custom variable.	Yes	String
customVariables:value	Value of this custom variable. Can be multi-valued.	Yes	String
customVariables:action	Action to be performed on this custom variable.	No	Must be one of: append set remove Default is value append
customVariables:persistence	Recommended persistence lifespan.	No	Must be either volatile or persistent. Default value is persistent.
flexibleResponse	If true and response body is empty, returns 204	No	Must be either 'true' or 'false'.

JSON Input data example

{
  "tcCustomerID": "12345",
  "siteID": "6789",
  "businessRuleID": "556234533asd",
  "attributes": [{
      "name": "email",
      "value": "hello@email.com"
      "type": "visitorAttribute"
      "externalCustomerID": "Yes"
    }
  ],
  "customVariables": [{
      "name": "customVar",
      "persistence": 168
    }
  ]
}

JSON schema

{
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "tcCustomerID": {
      "type": "string"
    },
    "tcCustomerId": {
      "type": "string"
    }
    "siteID": {
      "type": "integer"
    },
    "sessionID": {
      "type": "string"
    },
    "sessionId": {
      "type": "string"
    },
    "businessRuleID": {
      "type": "string"
    },
    "viewID": {
      "type": "string"
    },
    "businessUnitID": {
      "type": "integer"
    },
    "agentGroupID": {
      "type": "integer"
    },
    "flexibleResponse": {
      "type": "boolean"
    },
    "businessRuleAttributes": [
      {
        "name": "brattr",
        "value": "BR_1"
      }
    ],
    "customVariables": [
      {
        "name": "attributeName@&^",
        "value": "attributeValue",
        "persistence": 168,
        "action": "append"
      }
    ],
    "attributes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "value": {
            "type": "string"
          },
          "attributeType": {
            "type": "string",
            "enum": [ "visitorAttribute","sessionAttribute" ]
          },
          "action": {
            "type": "string",
            "enum": [ "set","remove","append"]
          },
          "externalCustomerID": {
            "type": "string",
            "enum": [ "yes","no"]
          }
        },
        "required":["name","value","attributeType"]
      }
    },
    "customVariables": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "value": {
            "type": "string"
          },
          "action": {
            "type": "string",
            "enum": [ "set","remove","append"]
          },
          "persistence": {
            "type": "integer"
          }
        },
      "required":["name","value"]
      }
    }
  },
  "oneOf": [
    {
      "required": [
        "tcCustomerID",
        "siteID",
        "businessRuleID"
      ]
    },
    {
      "required": [
        "tcCustomerId",
        "siteID",
        "businessRuleID"
      ]
    }
  ]
 }

Examples

Request

POST https://{tagserver.domain}/tagserver/v1/dataCollection/exposed

POST body:

{
  "tcCustomerID": "465657113802851330",
  "siteID": 306,
  "businessRuleID": "2256234234111",
  "businessUnitID": 22,
  "agentGroupID": 10004091,
  "viewID": "6789231234",
  "sessionID": "55552456234234",
  "flexibleResponse": "true",
  "routingAttributes": [{
      "name": "rattr",
      "value": "convValue1!@#"
    }
  ],
  "businessRuleAttributes": [{
      "name": "brattr",
      "value": "BR_1"
    }
  ],
  "customVariables": [{
      "name": "attributeName@&^",
      "value": "attributeValue",
      "persistence": 168,
      "action": "append"
    }
  ],
  "attributes": [{
      "name": "visAttr2 #^",
      "value": "visAttrValue22 !$>",
      "attributeType": "visitorAttribute",
      "externalCustomerID": "No",
      "action": "set"
    }, {
      "name": "attr1",
      "value": "visAttrValue22 !$>",
      "attributeType": "applicationAttribute",
      "action": "set"
    }
  ]
}

Response

200 OK

Request

POST https://{tagserver.domain}/tagserver/v1/dataCollection/exposed

POST body:

{
  "tcCustomerID": "465657113802851330",
  "siteID": 306,
  "businessRuleID": "2256234234111",
  "sessionID": "2256234234111"
}

Response

200 OK