Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Communication

Search by Agent

Returns a page of communication timeline entries for the caller (or the caller's team when teamView=true, requiring ACCESS_ALL_TEAM_LEADS permission), filtered by type and optional time range. The response is a page wrapper with totalCount, offset, limit, and pageData.

post/v1.0/agent/communication

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Request body

type'CALL' | 'TEXT' | 'EMAIL' | 'ALL' required

CALL, EMAIL OR TEXT

startTimeinteger required

startTimestamp

endTimeinteger required

endTimestamp (The maximum time interval for a single query is 24 hours)

offsetinteger

offset default Value 0

limitinteger

limit default Value 10,max value 1000

teamViewboolean

search team lead's communication, default false

Example request

{
  "type": "CALL",
  "startTime": 946710000000,
  "endTime": 946710000000,
  "limit": 50
}

Response

Page of communication entries.

offsetinteger

current offset

limitinteger

limit

pageDataobject[]

page data

hasMoreboolean

has more

Example response

{
  "limit": 500,
  "hasMore": true
}