> For the complete documentation index, see [llms.txt](https://prosbcdocs.telcobridges.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://prosbcdocs.telcobridges.com/troubleshooting-and-support/troubleshooting-tips-and-actions/configuring-call-trace/call-trace-filter-parameters.md).

# Call Trace Filter Parameters

#### 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            | SIP Call-Id header. Available for SIP call leg.                                                                                                                                                                                                                                                                                                                   |
| mos                | String            | MOS value from 1.0 to 5.0. Available for SIP call leg.                                                                                                                                                                                                                                                                                                            |
| network\_quality   | Integer           | Percentage from 1 to 100. Available for SIP call leg.                                                                                                                                                                                                                                                                                                             |
| 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           | <p>All calls with a duration (in seconds) under the value of "call\_duration". When the value prefixed by a '>', it will return all calls greater than the value.</p><p>A range can be obtained by inputing 2 values in the format 'x-y', where x is the minimum duration and y is the maximum.</p>                                                               |
| 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 or String | Unix timestamp (in milliseconds) for the beginning of the call. Match calls with a greater timestamp value. An [external website](https://www.epochconverter.com/) can be used for converting the time into a timestamp. Can also use a string in the following format: 'YYYY-mm-dd HH:MM:SS'. Note that the timezone used will be the one on the queried system. |
| end                | Integer or String | Unix timestamp (in milliseconds) for the end of the call. Match calls with a lesser timestamp value. An [external website](https://www.epochconverter.com/) can be used for converting the time into a timestamp. Can also use a string in the following format: 'YYYY-mm-dd HH:MM:SS'. Note that the timezone used will be the one on the queried system.        |
| 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.                                                                                                                                                                                                                     |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://prosbcdocs.telcobridges.com/troubleshooting-and-support/troubleshooting-tips-and-actions/configuring-call-trace/call-trace-filter-parameters.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
