Basic search
Basic search is activated when URI attribute advanced_search is missing or set to 0, like:
/api/v2/users.json?advanced_search=0
Example of basic search using daterange and search_term attributes (note, multiple filtering parameters can be specified at the same time):
/api/v2/calls.json?daterange=2014/11/01-2014/12/01&search_term=12345
The following table lists the attributes available for basic search.
| Parameter | Description |
|---|---|
| daterange | Filter by date range. Format of daterange is either YYYY/MM/DD-YYYY/MM/DD or YYYY/MM/DD For example, the following query will return all recordings from 2014/11/01 00:00:00 to 2014/12/01 24:00:00: The following query will return all recordings from 00:00:00 to 24:00:00 of 2014/11/01 Note, the query will be executed with REST API user's timezone. If user's timezone is not configured, then groups, tenants or system default timezone will be used. |
| user_id | Filter by user. The following query will return all recordings associated with the user identified by ID. |
| user_login | Filter by user login. The following query will return all recordings associated with the user identified by login: |
| group_id | Filter by group. The following query will return all recordings associated with the specified group: |
| tenant_id | Filter by tenant. The following query will return all recordings associated with the specified tenant: |
| search_term | Search a text in the phone number, phone name and notes. Example: |
| category_id | Filter recordings by category. Example: |
| broadworks_user_id | Filter recordings by Broadworks User ID. Example: |
| broadworks_group_id | Filter recordings by Broadworks Group ID. Example: |
| active_only | Return active calls only. Example: |