Filter parameters reference guide A
From TBwiki
(Difference between revisions)
(add category Revise on Major) |
Lucas Joyal (Talk | contribs) (Explain detail about calling and called numbers in string) |
||
| Line 25: | Line 25: | ||
|called | |called | ||
|String | |String | ||
| − | |Called number. | + | |Called number. Will match partial substrings of phone numbers. |
|- | |- | ||
|calling | |calling | ||
|String | |String | ||
| − | |Calling number. | + | |Calling number. Will match partial substrings of phone numbers. |
|- | |- | ||
|nap | |nap | ||
Revision as of 16:39, 1 December 2017
Filter parameter
When using the Call trace API to select a subset of calls, these are the parameter that can be used in the query.
| Parameter | Format | Description |
|---|---|---|
| uct_call_id | Hexadecimal | Will return the call matching this ID. |
| direction | Integer | Incoming (1), outgoing (2), Mixer(3), Media only (4) . |
| max | Integer | Max number of call that will be matched by the filter. |
| called | String | Called number. Will match partial substrings of phone numbers. |
| calling | String | Calling number. Will match partial substrings of phone numbers. |
| nap | String | Nap used by the call. |
| protocol | String | Protocol used by the call (SS7, SIP, ISDN, CAS). |
| route | String | Name of the route used by the call. |
| call_id | String | Call Id. |
| recorded | String | String can either be "RECORDED" or "NOTRECORDED". |
| call_state | String | "ACTIVE" or "INACTIVE" |
| terminate_reason | String or Integer | "NORMAL", "NOT_NORMAL" or the cause Integer value. |
| call_duration | Integer | All calls with a duration (in seconds) under the value of "call_duration". |
| intercepted | Boolean | True or false: Match all legs that are intercepted (if true) or all that are not (if false). |
| interception_leg | Boolean | Match all legs that are Interception legs |
| interception_liid | String | Match all legs that match the interception LIID |
| start | Integer | Unix timestamp (in seconds) for the beginning of the call. Match calls with a greater timestamp value. An external website can be used for converting the time into a timestamp |
| end | Integer | Unix timestamp (in seconds) for the end of the call. Match calls with a lesser timestamp value. An external website can be used for converting the time into a timestamp |
| drop_call | Boolean | Flag used to signify that all calls matching the filter parameters will be terminated. Use with caution when dropping multiple calls at once. |
