Search

POST

/search

The /search API is a GraphQL endpoint that enables customers to fetch data from Webex Contact Center.

Mandatory parameters are FROM and TO, which accept datetime in epoch format. The FROM parameter cannot be older than 36 months from the current time. The TO parameter, if given as a future time, will be set to the current time. Optional parameters such as filter and aggregation are accepted for each query.

Response Compression: For this API, response compression using gzip can be enabled by including the 'Accept-Encoding' header in the request with its value as 'gzip'. The response will be compressed only if its size exceeds 1 MB. If the header is not present in the request or if gzip is not listed as one of the encodings in the header's value (comma-separated encodings), then the API response will not be compressed, impacting latency as observed from clients.

orgId
string
Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.
Example: "97cdbf45-ebe2-4687-8341-44d5c7abf101"

variables
object
The variables definition are the part that looks like task(from: $startTime, to: $endTime) in the query. It works just like the argument definitions for a function in a typed language. These variables are applicable only for persisted queries that has these variables. An example of persisted query with variables - { task (from: $startTime, to: $endTime, filter: { and : [ {channelType : {equals: telephony}} ] } , pagination: {cursor:"0"}) { tasks { id channelType } } }.
Example: {"startTime":1629369769066,"endTime":1629458280000}
query
string
A graphQL query specifying the task attributes needed in the response for the specified time window. from: Start time for the query (in epoch milliseconds) and it cannot be older than 36 months from the current time. to: End time for the query (in epoch milliseconds) and it cannot be greater than the current time. The duration between to and from must not be more than 365 days. .
Example: "query($startTime: Long!,$endTime: Long!) { task (from: $startTime, to: $endTime, filter: { and : [ {channelType : {equals: telephony}} {status: {equals: \"created\"}} {owner: {equals: {id: \"owner-id\"}}} {customer: {equals: {name: \"customer-name\"}}} ]} , pagination: {cursor:\"0\"}) { tasks { id channelType}}}"

Code	Status / Description
200	OK
400	Validation Error
401	Unauthorized Operation
403	Forbidden
404	Not Found
409	Conflict
413	Content Too Large
422	Unprocessable Entity
429	Too many requests have been sent in a given amount of time and the request has been rate limited.
500	An Unexpected Error Occurred
503	The service is currently unavailable to serve the requests

POST

/search

Response

1{
2  "data": {
3    "task": {
4      "tasks": [
5        {
6          "id": "fb53f6d1-5535-4ac8-b081-53834e17d6f5",
7          "channelType": "telephony",
8          "createdTime": 1629450000000,
9          "endedTime": 1630380960406,
10          "captureRequested": true,
11          "isActive": false,
12          "status": "ended",
13          "queue": [
14            {
15              "id": "e434a654-df4c-42dc-908b-3d9d0206a616",
16              "name": "cb_outdial_queue"
17            }
18          ],
19          "owner": {
20            "name": "callbackorg2user1 callbackorg2user1",
21            "id": "74ab6507-a32a-479c-bda7-15ff0b6c6c3c"
22          }
23        }
24      ]
25    }
26  }
27}

GraphiQL

Maximize the screen to use the GraphQL editor

Search

Query Parameters

Request Body

Response Codes