Call History

The Call History API provides a comprehensive solution for managing and retrieving call records from a Private Branch Exchange (PBX) system. This API allows users to perform key operations such as retrieving detailed call logs, subscribing to call history notifications, and deleting call records for a specified directory number.

The call history API information are as follows:

Table 1. Call History API Information
Version	1.0.4
Base URLs	`http://{serviceNode}:22227/v1.0` `https://{serviceNode}:22228/v1.0`
Authentication	The API uses Digest Authentication to authenticate requests using a phone number and password.

Components

The CallItem object contains details about individual call history entries.

Table 2. CallItem Object
Parameter	Supported Value	Description
directoryNumber	String	Indicates the unique identity of a callee. Supports maximum of 24 digits as an input.
name	String	Indicates the user name of the directory number that is UTF-8 encoded. Supports maximum of 40 characters as an input.
callIdentity	String	Indicates the unique identity of the call. Supports maximum of 24 digits as an input.
dateTime	String	Indicates the date and time of the call in ISO format (UTC).
timeZone	String	Indicates the ISO time zone. For example, GMT.
duration	String	Indicates the length of the call in Hour:Minute format.
typeOfCall	String	Indicates the call type. Allowed values: incoming-answered, incoming-missed, and outgoing.
transferredCall	Boolean	Indicates if the call was transferred.
divertedCall	Boolean	Indicates if the call was diverted.
firstDialledNumber	String	Indicates the number initially dialed (for example, in case of diversion).
remoteNumber	String	Indicates the public subscriber number (maximum 20 digits).
directoryNumber2	String	Indicates the extra number related to the call (for example, redirected-to number, maximum 24 digits).
name2	String	Indicates the user name associated with the second directory number.
infoText2	String	Indicates the information text or reason related to the second directory number.

↑