> 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/telecom-references/protocols/sip-privacy.md).

# SIP Privacy

#### Supported Standards

* [draft-ietf-sip-privacy-04.txt](http://tools.ietf.org/id/draft-ietf-sip-privacy-04.txt) for support of Remote-Party-ID.
* [RFC3323](http://tools.ietf.org/html/rfc3325) *A Privacy Mechanism for the Session Initiation Protocol (SIP)*<sup>**1**</sup>
* [RFC3325](http://tools.ietf.org/html/rfc3325) *Private Extensions to the Session Initiation Protocol (SIP) for Asserted Identity within Trusted Networks*<sup>**2**</sup>
* [ITU Q.1912.5](http://www.itu.int/itudoc/itu-t/aap/sg11aap/history/q1912.5/index.html) *Interworking between SIP and BICC/ISUP*

\[**1**] Partial support. Support Section 4.1. *Constructing Private Messages*

\[**2**] Partial support. Doesn't support *P-Preferred-Identity*.

#### Acronyms

| **RPID**    | *Remode-Party-ID* header                                                                                                                                                                     |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **PAID**    | *P-Asserted-Identity* header                                                                                                                                                                 |
| **CLI**     | *Calling Party Number* (ISUP or ISDN)                                                                                                                                                        |
| **GN**      | *Generic Number* for additional calling party number (ISUP ITU)                                                                                                                              |
| **APRI**    | *Address Presentation Restricted Indicator* (ISUP) or *Presentation indicator* (ISDN)                                                                                                        |
| **SI**      | *Screening Idicator* (ISUP or ISDN)                                                                                                                                                          |
| **{param}** | [Scripting call parameters](https://github.com/telcobridges-main/tmedia-wiki/tree/main/reference/api/routing-script-tutorial-development-guide/README.md#script-parameters-protocol-mapping) |

## Script call parameter privacy mapping

### ISUP/ISDN

| **SS7 param**            | CLI digits                                                                                                                                                                   | CLI APRI                                                                                                                                                                                   | CLI SI                                                                                                                                                                                  | GN digits    | GN APRI      | GN SI        |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | ------------ |
| **Routing script param** | [{calling}](https://github.com/telcobridges-main/tmedia-wiki/tree/main/reference/api/routing-script-tutorial-development-guide/README.md#script-parameters-protocol-mapping) | [{calling\_presentation}](https://github.com/telcobridges-main/tmedia-wiki/tree/main/reference/api/routing-script-tutorial-development-guide/README.md#script-parameters-protocol-mapping) | [{calling\_screening}](https://github.com/telcobridges-main/tmedia-wiki/tree/main/reference/api/routing-script-tutorial-development-guide/README.md#script-parameters-protocol-mapping) | *not mapped* | *not mapped* | *not mapped* |

The CLI APRI is mapped according to the following table.

| **{calling\_presentation} to ISUP/ISDN**             |                                |   |
| ---------------------------------------------------- | ------------------------------ | - |
| **{calling\_presentation}**                          | **CLI APRI**                   |   |
| "not\_available"                                     | *Address/Number not available* |   |
| "restricted", "addr\_restricted", "name\_restricted" | *Presentation Restricted*      |   |
| "unspecified", "allowed"                             | *Presentation Allowed*         |   |

| **ISUP/ISDN to {calling\_presentation}** |                             |   |
| ---------------------------------------- | --------------------------- | - |
| **CLI APRI**                             | **{calling\_presentation}** |   |
| *Address/Number not available*           | "not\_available"            |   |
| *Presentation Restricted*                | "restricted"                |   |
| *Presentation Allowed*                   | "allowed"                   |   |
| Other value                              | "unspecified"               |   |

The CLI SI is mapped according to the following table.

| **{calling\_screening} to/from ISUP/ISDN** |                                        |   |
| ------------------------------------------ | -------------------------------------- | - |
| **{calling\_screening}**                   | **CLI SI**                             |   |
| "pass"                                     | *User provided, verified and passed*   |   |
| "fail"                                     | *User provided, verified and failed*   |   |
| "no"                                       | *User provided, not screened/verified* |   |
| "network\_provided"                        | *Network Provided*                     |   |

***

### SIP 'Remode-Party-ID' header

The Remote-Party-ID header field is defined as: Remote-Party-ID: "display-name" ;rpi-pty-type;rpi-privacy;rpi-screen

#### RPID URI

The RPID URI display-name is filled from [{private\_display}](https://github.com/telcobridges-main/tmedia-wiki/tree/main/reference/api/routing-script-tutorial-development-guide/README.md#script-parameters-protocol-mapping).

The RPID URI address-spec is filled from [{private\_address}](https://github.com/telcobridges-main/tmedia-wiki/tree/main/reference/api/routing-script-tutorial-development-guide/README.md#script-parameters-protocol-mapping).

#### RPID rpi-screen param

The RPID rpi-screen param is filled according to the following table.

| **{calling\_screening} to SIP**            |                           |   |
| ------------------------------------------ | ------------------------- | - |
| **{calling\_screening}**                   | **RPID rpi-screen param** |   |
| "unspecified", "pass", "network\_provided" | screen=yes                |   |
| "fail", "no"                               | screen=no                 |   |

| **SIP to {calling\_screening}** |                          |   |
| ------------------------------- | ------------------------ | - |
| **RPID rpi-screen param**       | **{calling\_screening}** |   |
| screen=yes                      | "pass"                   |   |
| screen=no                       | "no"                     |   |
| no *screen* param               | "unspecified"            |   |

#### RPID rpi-privacy param

The RPID rpi-privacy param is filled according to the following table.

| **{calling\_presentation} to SIP**         |                            |   |
| ------------------------------------------ | -------------------------- | - |
| **{calling\_presentation}**                | **RPID rpi-privacy param** |   |
| "unspecified", "not\_available", "allowed" | privacy=off                |   |
| "restricted"                               | privacy=full               |   |
| "addr\_restricted"                         | privacy=uri                |   |
| "name\_restricted""                        | privacy=name               |   |

| **SIP to {calling\_presentation}** |                             |   |
| ---------------------------------- | --------------------------- | - |
| **RPID rpi-privacy param**         | **{calling\_presentation}** |   |
| privacy=off                        | "allowed"                   |   |
| privacy=full                       | "restricted"                |   |
| privacy=uri                        | "addr\_restricted"          |   |
| privacy=name                       | "name\_restricted""         |   |
| no *privacy* param                 | "unspecified""              |   |

#### RPID rpi-pty-type param

The RPID rpi-pty-type param is harcoded to: party=calling

***

### SIP 'P-Asserted-Identity' and 'Privacy' headers

The P-Asserted-Identity and Privacy header field are defined as: P-Asserted-Identity: "display-name" Privacy: priv-value

#### PAID URI

The PAID URI display-name is filled from [{private\_display}](https://github.com/telcobridges-main/tmedia-wiki/tree/main/reference/api/routing-script-tutorial-development-guide/README.md#script-parameters-protocol-mapping).

The PAID URI address-spec is filled from [{private\_address}](https://github.com/telcobridges-main/tmedia-wiki/tree/main/reference/api/routing-script-tutorial-development-guide/README.md#script-parameters-protocol-mapping).

#### 'Privacy' header

The 'Privacy' header is filled according to the following table.

| **{calling\_presentation} to SIP**                   |                              |   |
| ---------------------------------------------------- | ---------------------------- | - |
| **{calling\_presentation}**                          | **Privacy priv-value param** |   |
| "unspecified", "not\_available", "allowed"           | none                         |   |
| "restricted", "addr\_restricted", "name\_restricted" | id                           |   |


---

# 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/telecom-references/protocols/sip-privacy.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.
