Skip to main content
POST

Authorizations

Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Body

application/json
returnedFields
enum<string>[]
required

Fields to fill for each call. callNumbers returns callParams. performanceMetrics, turns, isTakenOver, toolFailed and analytics need extra reads: ask only for what you show.

Minimum array length: 1
Available options:
time,
cost,
status,
channelType,
agentName,
agentId,
callNumbers,
release,
performanceMetrics,
turns,
isTakenOver,
toolFailed,
analytics
Example:
voiceAgentId
string<uuid>

Only this agent's calls.

Example:

"48f7656f-098b-4c43-b165-7cfd2cc8ac30"

take
number
default:10

Calls per page (1-30).

Required range: 1 <= x <= 30
Example:

10

skip
number
default:1

Page number, starting at 1.

Required range: x >= 1
Example:

1

channelType
enum<string>[]

Only calls on these channels.

Minimum array length: 1
Available options:
Web,
Telephone,
HamsaTalk,
Chat Agent
Example:
status
enum<string>[]

Only calls with these statuses. Ignored when returnActiveCalls is true. An IN_PROGRESS call is listed only if it started in the last hour, the same window as returnActiveCalls; other statuses in the filter are not limited.

Minimum array length: 1
Available options:
PENDING,
IN_PROGRESS,
COMPLETED,
NO_ANSWER,
FAILED,
FORWARDED,
TERMINATED
Example:
sortField
enum<string>

Sort by start time, length or cost. Used only together with sortOrder; otherwise newest first.

Available options:
time,
duration,
cost
Example:

"time"

sortOrder
enum<string>
Available options:
asc,
desc
Example:

"desc"

returnActiveCalls
boolean
default:false

true: only calls in progress that started in the last hour.

Example:

false

A call ID or agent ID (exact UUID), or part of the caller's phone number.

Minimum string length: 1
Example:

"+9665"

duration
object

Call length filter, in whole seconds.

versionNumbers
integer[]

Only calls answered by these agent versions.

Minimum array length: 1
Required range: x >= 1
Example:
environmentId
string<uuid>

Only calls that used this environment.

Example:

"a2c4e6f8-1b3d-4f5a-8c7e-9d0b1a2c3e4f"

chosenBySplit
boolean

Only calls where an A/B split picked the version (true), or the others (false).

Example:

true

draft
boolean

true: only draft test calls. false: only calls answered by a version.

Example:

false

isResolved
boolean

Only calls judged resolved (true) or not (false). Calls not analysed yet never match.

Example:

true

isHandedOff
boolean

Only calls handed (or not) to a person.

Example:

false

sentiment
enum<string>[]

Only calls with these sentiments.

Minimum array length: 1
Available options:
positive,
neutral,
negative
Example:
hasErrors
boolean

Only calls with (or without) errors.

Example:

true

hasKbGap
boolean

Only calls with (or without) a knowledge gap.

Example:

true

period
enum<string>
default:TODAY

Time range: LAST_HOUR, TODAY (default), YESTERDAY, THIS_WEEK (weeks start on Sunday), THIS_MONTH, or CUSTOM (send startPeriod and endPeriod). Day, week and month boundaries are computed in timeZone. Applied only with timeZone (or startPeriod for CUSTOM).

Available options:
LAST_HOUR,
TODAY,
YESTERDAY,
THIS_WEEK,
THIS_MONTH,
CUSTOM
Example:

"THIS_WEEK"

startPeriod
string

Start of a CUSTOM range: Unix timestamp in milliseconds (13 digits), as a string.

Pattern: ^[0-9]{13}$
Example:

"1761955200000"

endPeriod
string

End of a CUSTOM range: Unix timestamp in milliseconds (13 digits), as a string.

Pattern: ^[0-9]{13}$
Example:

"1762560000000"

timeZone
string

IANA time zone for the period boundaries, for example Asia/Riyadh. Send it for period to filter: without it, calls from all time are listed.

Minimum string length: 1
Example:

"Asia/Riyadh"

Response

Successful response

success
boolean
Example:

true

message
string
Example:

"success"

data
object