Search historical call logs

This action will search historical call logs within the given unit.

Headers

`X-Auth-App`
`X-Auth-Token`
`X-Auth-Secret`
`X-Auth-Extension`
`X-Auth-Password`
`X-Proxy-Auth-Token`
`X-Proxy-Auth-Secret`

Parameters

`unit_id`	Integer
`call_type`	String
`call_status`	String
`source`	String
`destination`	String
`extension`	String
`start_at`	String
`end_at`	String
`page`	Integer
`with_recordings`	Boolean

Structures

Include extended attributes?	Yes - include extended attributes
Include expansions?	source_channel_extension destination_channel_extension

The request output will be shown here...

URL

https://connectapi.dial9.co.uk/api/v2/logs/search

Access

Must be authenticated as a user or API token. If not authorised, a AccessDenied error will be returned.

Parameters

Parameter	Type	Default
unit_id The ID of the unit	Integer	null
call_type The type of call to search for, either `all`, `incoming` or `external`	String	all
call_status The status of the calls, either `all`, `answered` or `not_answered`	String	all
source The source number to search for	String	null
destination The destination number to search for	String	null
extension The extension username to search for	String	null
start_at When to search from	String	null
end_at When to search to	String	null
page	Integer	1
with_recordings	Boolean	null

Errors

Error	Attributes
UnitNotFound The given unit was not found	id The provided ID

Error

Attributes

UnitNotFound

The given unit was not found

id

The provided ID

Response Data

This action will return an array of log entry structures.

You'll receive all extended data with this structure, by default. You can change this behaviour by passing true or false in the _full parameter on the request. By default, you'll receive all expansions for the structure. You remove any/all of them by providing an array of new expansion names in the _expansions parameter on the request.