Communication Search Parameters


Communication search parameters

Name Type Description

limit

Integer

The maximum number of objects to return. Default: 15.

order

[ascending|decending]

Sort results in decending or ascending order. Default: descending.

where

[String]

seperate by comma if you want to filter multiple fields

Additional search fields where=[filters], current filters are supported:

-voicemail=[true/false] → filter out voicemail messages
-incoming=[true/false] → filter out incoming or outgoing
-retrieved=[true/false] → filter out retrieved
-displayed=[true/false] → filter out displayed
-flagged=[true/false] → filter out flagged
-obj_type=[object type] → filter on object type (XCCUserChat,CallLog,SMSMessage,XCCMessage)
-callFlowId=[flow id] → filter by call flow id
-callId=[call id] → filter by call id
-phoneLine=[phone line oid] → filter by phone line
-search=[search key] → filter by search key (contents), can only be used in combination with a phoneLine filter. When special characters are added set in the filter, replace them with the URL Encoded character (e.g. + → %2b)

retrieval

Boolean

Set the retrieved boolean of all founded communcations to true. The retrieved boolean is used to count the new received communcations.

only_missed_calls

Only show missed incoming calls.

include

[String]

seperate by comma if you want to include multiple fields

Include fields in the results.

-The option attachments, include=attachments, includes the attachments of the communications.
-The option attachments + thumbnails, include=attachments,thumbnails, includes the attachments of the communications with the base64 of the thumbnail.
-The option messageReferences, include=messageReferences, includes the message references of the communications.
-The option transferredCommunications, include=transferredCommunications, includes the transferred from and transferred to communication objects of the communications.

The option all, include=all, adds the following fields:
- phone
- isConferenceCall
- callAnswerTime
- callAnswerTimeSec
- callEndTime
- onHoldDuration
- trunk
- phoneLine
- wrapUpTime
- user
- participants

Errors

HTTP code Xelion code Description

400

10208

This combination of arguments is not valid