Configuring JSON response handling

Specifies either the name of an element in the response JSON body or the name of a response header whose value should be used to set a new priority value for the associated contact

You can also use static values instead.

Expected value: an unsigned integer or a value convertible to an unsigned integer.

{
   "priority": "100"
}

JSON configuration:

{"priority": "{response.body.priority}"}

UUID supports uppercase or lowercase, and can optionally include hyphens.

Configuration for:

{"id": "{response.body.queue.id}"}

Expected (part of) response body data:

{
   "queue": {
      "id": "C9177D585DA5EE11B3ED58961D1810CC"
   }
}

Configuration for:

{"address": "{response.body.queue.address}"}

Expected (part of) response body data:

{
   "queue": {
      "address": "chat.queue@acme.com"
   }
}

Specifies either the name of an element in the response JSON body or the name of a response header whose value should be used to set the preferred agent for the contact.

Expected value: a non-empty string based on which an individual agent can be identified

Configuration

{"preferredAgent": "{response.body.agent}"}

Expected (part of) response body data:

{
   "agent": "agent@acme.com"
}

Specifies which parts of data within response payload should be extracted and used to set required agents and required agent timeout for the conversation.

Expected value: For the element containing required agent identifiers, the value is expected to be a list of non-empty strings where each string should contain data with which an individual agent can be identified.

The value of the element containing required agent timeout is expected to be an unsigned integer or a value convertible to an unsigned integer. You can also use static values instead.

Configuration

Response payload contains an array of strings (chat addresses) and timeout:

{
  "requiredAgents": {
    "agents": "{response.body.agents}",
    "timeout": "{response.body.timeout}"
  }
}

Expected (part of) response body data:

{
   "agents": [
      "agent.1@acme.com",
      "agent.2@acme.com"
   ],
   "timeout": 60
}

Configuration

Response body contains an array of objects:

{
  "requiredAgents": {
    "agents": [
      "{response.body[0].address}",
      "{response.body[1].address}"
    ],
    "timeout": "90"
  }
}

Expected response body data:

[   
      {"id": "1", "address": "agent.1@acme.com"},
      {"id": "5", "address": "agent.5@acme.com"}
]

Specifies the parts of data in the response payload that should be extracted and added as conversation attached data (CAD) and the structure for storing the data.

You can also use static values instead (or in conjunction with data extracted from response payload).

Data can be extracted from either response headers or response JSON body, and may also be configured to include, for example, request duration and response HTTP status code as debug information.

{response.headers}

{response.headers.*}

All response header names and their values as a JSON object (with header names in lower case) or null if the response didn't contain header data

Example:

{
  "access-control-allow-origin": "*",
  "alt-svc": "h3=\":443\"; ma=2592000,h3-29=\":443\"; ma=2592000",
  "cache-control": "private",
  "content-encoding": "gzip",
  "content-type": "application/json; charset=utf-8",
  "date": "Fri, 16 Feb 2024 11:53:52 GMT",
  "etag": "W/\"85-j7dJHV5O0eLMg8ehtuAzqwV8a8A\"",
  "server": "Google Frontend",
  "transfer-encoding": "chunked",
  "vary": "Accept-Encoding",
  "x-powered-by": "Express",
  "x-cloud-trace-context": "94b61fe1655cd257fe4ee05fe42b6ef2"
}

{response.headers.<header-name>}

The value of a single response header named <header-name> or null if response header with the specified name does not exist.

To refer to the value of the header with name x-cloud-trace-context, use syntax {response.headers.x-cloud-trace-context} .

{response.body}

{response.body.*}

Example:

{
      "detections": [
          {
              "language": "en",
              "isReliable": true,
              "confidence": 15.75
          }
      ]
}

{response.body.<element-name>}

{response.body.<element-name>.<sub-element-name>}

The value of a single JSON object property in deserialized format, or null if no such named element exists in the response body object hierarchy. Element search path components are delimited using the dot character (.).

To refer to the body property with name detections in the above example, use syntax {response.body.detections}.

{response.body[<element-index>]}

{response.body.<element-name>[<sub-element-index>]}

The value of a single element contained by the specified body element of array type, as indicated by the zero-based element index enclosed in square brackets

For example, to refer to the first element in an array, use syntax [0].

To refer to the first element of the body property with name detections in the above example, use syntax {response.body.detections[0]}. To refer to the confidence property of that element, use syntax {response.body.detections[0].confidence}.