You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Current »

Retrieve all Calls

This function retrieves all calls from the client account.

URL

GET {baseURL}/calls

Parameters

None.

Responses

If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.

Returned Data (200 OK)

A JSON Structure containing the following fields:

FieldTypeData
recordsCall []An array of Call objects.
countIntegerThe number of records returned.
orderByStringCurrently, calls are ordered by UFN.
statusIntegerThe return code (also provided by the http status code).

Example

{
    "records": [
        {
            "bOutbound": 0,
            "CurrentAgentCountLoggedInToAcd": null,
            "AcdCallMonitoring_bCallRequest": null,
            "AcdSecondaryDistributionAlgorithmID": 1,
            "LanguagesID": 2,
...
            "dtCallStart": "2022-07-08T11:33:18.900977Z",
            "CallingPartyNumberType": 1,
            "dtAcdFirstQueueStart": null,
            "ResellersID": 1,
            "dtAcdCallRecordingAnnouncementStart": null
        }
    ],
    "count": 1,
    "orderBy": "UFN",
    "status": 200
}
  • No labels