Search Calls
- Verba Support
- Fenyvesi, Gabor
- Balázs Oláh
Overview
Retrieves all CDRs that match a search filter.The function is available as a HTTP GET or HTTP POST request.
Request
Search Calls:
Search Calls HTTP GET sample:
Detailed description of the API request elements:
| URL parameter | Parameter example | Description | Requirements |
|---|---|---|---|
| action | action=SearchCalls | Name of the HTTP API request. | Mandatory |
| apiKey | apiKey=74c8eea0-50c6-40b2-9f3e-252ed501c3c8 | API key used to identify the application. | Mandatory |
| token | token=09835e02-6c10-11e0-bb22-ba324924019b | Unique identifier for authenticated sessions. After successful authentication, the API sends back a token, which has to be used for each request. | Mandatory if authentication is configured for the given API key. |
| responseType | responseType=XML | Defines the format of the response of the API request. The following valid values apply:
| If the parameter is missing, it defaults to XML. |
| status | status=ongoing | Defines the focus of the call search:
| Optional |
| secondary | secondary=1 | If 1, then the secondary recordings will be returned too. | Optional |
| start | start=2011-01-01 00:00 | Start time of the search period. Format is either "YYYY-MM-DD hh:mm:ss.SSS", "YYYY-MM-DD hh:mm:ss" or "YYYY-MM-DD hh:mm" | Mandatory |
| end | end=2011-11-16 23:59 | End time of the search period. Format is either "YYYY-MM-DD hh:mm:ss.SSS", "YYYY-MM-DD hh:mm:ss" or "YYYY-MM-DD hh:mm" | Mandatory |
| anynum | anynum=2017 | Searched phone number part (searched both in called and caller id) This parameter can be used multiple times to filter for multiple phone numbers. For example: ...&anynum=1222&anynum=3988&... | Optional Must be URL encoded |
| anyname | anyname=Joe | Searched name part (searched both in called and caller name) This parameter can be used multiple times to filter for multiple names. For example: ...&anyname=Joe&anyname=Peter&... | Optional Must be URL encoded |
| orderby | orderby=source_caller_id | Ordering field. Values: same field names as in the result XML CDR (see below) | Optional |
| order | order=asc | Ascending or descending order. Values: "asc" or "desc" | Optional |
| pagefirst | pagefirst=30 | Row number of the first CDR to be included in the results | Optional |
| pagelen | pagelen=10 | Defines how many rows (CDRs) should be presented in one result | Optional |
| returnInvitation | returnInvitation=1 | If 1, then the Lync Invitation details acquired by Verba from the technical account will be returned in the response. | Optional |
| returnSharedItems | returnSharedItems=1 | If 1, then the corresponding shared items will be returned in the response. | Optional |
| f_field_name | f_meeting_id=WHBFM6DD | The results will be filtered by field_name = value | Optional |
| f_field_name_like | f_meeting_id_like=WHBF%25 | the same as f_field_name, but LIKE operation will be used in the SQL filter | Optional |
| returnMetadata | returnMetadata=1 | If 1, then the corresponding custom metadata will be returned in the response. | Optional |
| meta | meta=[Metadata_Template]:[Field Name]=[value] Example: Encoded (correct) form: | This parameter can be specified multiple times (?meta=...&meta=...&meta=...) The default operator is "equals", but it can be changed by meta_relation=... parameter. The Field can be referenced by the Display Name or the value of the Field Identifier field. | Optional |
| returnIM | returnIM=1 | If 1, then the corresponding IM messages will be returned in the response. | Optional |
Response
XML based response sample on success:
XML based response sample on error: