# Script Parameters Definition

#### Noa values

The text below represents the value normally used by routing script.\
Incase it's required to use a value that's not defined in the text values below, a integer can be provided and will be used "as-is" in the signaling message.\
Example numeric values for the SS7 protocol are shown in parenthesis.\ <br>

* unknown\_number (2 or 0x2)
* international\_number (4 or 0x4)
* national\_number (3 or 0x3)
* subscriber\_number (1 or 0x1)
* network\_specific (5 or 0x5)
* network\_routing\_national\_format (7 or 0x7)
* network\_routing\_international\_format (8 or 0x8)
* abbreviated\_number (6 or 0x6)
* subscriber\_number\_operator\_requested (113 or 0x71)
* national\_number\_operator\_requested (114 or 0x72)
* international\_number\_operator\_requested (115 or 0x73)
* no\_number\_present\_operator\_requested (116 or 0x74)
* no\_number\_present\_cut\_through\_call\_to\_carrier (117 or 0x75)
* test\_line\_test\_code (119 or 0x77)
* non\_unique\_subscriber\_number (113 or 0x71)
* non\_unique\_national\_number (115 or 0x73)
* non\_unique\_international\_number (116 or 0x74)
* call\_950\_number (118 or 0x76)
* special\_number (115 or 0x73)
* national\_number\_with\_transit\_network\_selection (116 or 0x74)
* international\_number\_with\_transit\_network\_selection (117 or 0x75)

Those values will be remapped to the protocol specific NOA value. To provide protocol specific value:

* call\_params\[:called\_noa] = 0x70

or

* call\_params\[:called\_noa] = 112

#### Npi values

* unknown\_number
* isdn
* telephony
* private
* data
* telex
* national

#### Calling Display Type values

* unspecified => Type is unspecified.
* calling\_party\_name => Type is 0xB1.

Those values will be remapped to the protocol specific Display Information Type value. To provide protocol specific value:

* call\_params\[:calling\_display\_type] = 0xB1

or

* call\_params\[:calling\_display\_type] = 177

#### Calling Display value

* call\_params\[:calling\_display] = "Roger Fluffy"

#### Presentation values for Calling number, Calling Subscriber (Generic Number), Redirecting Number, Original Called Number (OCN) and Location Number

The text below represents the value normally used by routing script.\
Incase it's required to use a value that's not defined in the text values below, a integer can be provided and will be used "as-is" in the signaling message.\
Example numeric values for the SS7 protocol are shown in parenthesis.\ <br>

* unspecified
* not\_available (0x2)
* allowed (0x0)
* restricted (0x1)
* addr\_restricted
* name\_restricted

#### Calling Party Category

The text below represents the value normally used by routing script.\
In case it's required to use a value that's not defined in the text values below, a integer can be provided and will be used "as-is" in the signaling message.<br>

Mapping from routing script to SS7/CAS R2/SIP

| <p>Routing Script string<br></p>      | <p>SS7 raw value<br></p> | <p>R2 CAS scripts<br></p>                       | <p>Default Rx CAS<br></p> | <p>default Tx CAS<br></p> | <p>SIP "cpc="<br></p> |
| ------------------------------------- | ------------------------ | ----------------------------------------------- | ------------------------- | ------------------------- | --------------------- |
| <p>subscriber<br></p>                 | <p>0xa<br></p>           | <p>CATEGORY\_SUBSCRIBER<br></p>                 | <p>1 and 7<br></p>        | <p>7<br></p>              | <p>ordinary<br></p>   |
| <p>subscriber\_with\_priority<br></p> | <p>0xb<br></p>           | <p>CATEGORY\_SUBSCRIBER\_WITH\_PRIORITY<br></p> | <p>2 and 9<br></p>        | <p>2<br></p>              | <p>priority<br></p>   |
| <p>operator\_french<br></p>           | <p>0x1<br></p>           | <p>CATEGORY\_OPERATOR\_FRENCH<br></p>           | <p>5<br></p>              | <p>5<br></p>              | <p>operator<br></p>   |
| <p>operator\_english<br></p>          | <p>0x2<br></p>           | <p>CATEGORY\_OPERATOR\_ENGLISH (5)<br></p>      | <p>5<br></p>              | <p>5<br></p>              | <p>operator<br></p>   |
| <p>operator\_german<br></p>           | <p>0x3<br></p>           | <p>CATEGORY\_OPERATOR\_GERMAN (5)<br></p>       | <p>5<br></p>              | <p>5<br></p>              | <p>operator<br></p>   |
| <p>operator\_russian<br></p>          | <p>0x4<br></p>           | <p>CATEGORY\_OPERATOR\_RUSSIAN (5)<br></p>      | <p>5<br></p>              | <p>5<br></p>              | <p>operator<br></p>   |
| <p>operator\_spanish<br></p>          | <p>0x5<br></p>           | <p>CATEGORY\_OPERATOR\_SPANISH (5)<br></p>      | <p>5<br></p>              | <p>5<br></p>              | <p>operator<br></p>   |
| <p>data<br></p>                       | <p>0xc<br></p>           | <p>CATEGORY\_DATA<br></p>                       | <p>6 and 8<br></p>        | <p>6<br></p>              | <p>datacall<br></p>   |
| <p>test<br></p>                       | <p>0xd<br></p>           | <p>CATEGORY\_TEST<br></p>                       | <p>3<br></p>              | <p>3<br></p>              | <p>test<br></p>       |
| <p>payphone<br></p>                   | <p>0xf<br></p>           | <p>CATEGORY\_PAYPHONE<br></p>                   | <p>none<br></p>           | <p>7<br></p>              | <p>payphone<br></p>   |
| <p>unknown<br></p>                    | <p>0x0<br></p>           | <p>CATEGORY\_UNKNOWN<br></p>                    | <p>4, 11 to 15<br></p>    | <p>7<br></p>              | <p>unknown<br></p>    |
| <p>unspecified<br></p>                | <p>0xa<br></p>           | <p>invalid<br></p>                              | <p>none<br></p>           | <p>none<br></p>           | <p>invalid<br></p>    |

[Link to calling party categories used in CAS R2 scripts](https://docs.telcobridges.com/wiki/CAS_R2_scripting#Category_meanings)

#### Screening values for Calling number, Calling Subscriber (Generic Number), and Location Number

The text below represents the value normally used by routing script.\
In case it is required to use a value that is not defined in the text values below, an integer can be provided and will be used "as-is" in the signaling message.\
Example numeric values for the SS7 protocol are shown in parenthesis.\ <br>

* unspecified
* no (0x0)
* pass (0x1)
* fail (0x2)
* network\_provided (0x3)

#### Redirecting indicator values

SS7:

* no\_redirection
* call\_rerouted
* call\_rerouted\_all\_restricted
* call\_diverted
* call\_diverted\_all\_restricted
* call\_rerouted\_restricted
* call\_diverted\_restricted
* spare

#### Redirecting number, Original Called Number and Diversion Reason

ISDN:

* unknown
* busy
* no\_reply
* deflection
* dte\_out\_of\_order
* forwarding\_by\_called\_dte
* unconditional

SS7:

* unknown
* busy (SIP: user-busy)
* no\_reply (SIP: no-answer)
* unconditional
* deflection
* deflection\_immediate
* mobile\_not\_reachable

#### OLI (originating line information) values

The OLI parameter is a string that represents an integer value from 0 to 255.

#### Information Transfer Capability values

information\_transfer\_capability:

* digital
* restricted\_digital
* digital\_with\_tones
* speech
* 3\_1\_khz\_audio
* video

#### redirecting\_number\_forward\_enabled values

Controls forwarding or discarding of redirecting number (SIP: diversion header) to the outgoing call leg.

Values for this parameter are "0", "1", "false" or "true.

* 0/false: Redirecting number (and original called number) is not forwarded to outgoing call leg
* 1/true: Redirecting number (and original called number) is forwarded to outgoing call leg

The value for this parameter at the input of the routing script depends on the "Forward redirecting number" parameter in the "Advanced" section of the Gateway configuration page of the Web Portal. The script may change this value to override the Gateway configuration.

Note: To "insert" a new redirecting number value on the outgoing leg, redirecting\_number\_forward\_enabled must also be set to true.

#### MLPP Precedence values

mlpp\_look\_for\_busy:

* allowed
* path\_reserved
* not\_allowed

\
mlpp\_precedence\_level:

* flash\_override
* flash
* immediate
* priority
* routine

\
mlpp\_network\_identity:

3 digits value from 0 to 999

\
mlpp\_service\_domain:

24 bits value from 0 to 16777215

#### ISUB subaddress information values

called\_isub\_type: calling\_isub\_type:

* nsap
* nsap\_ia5
* nsap\_bcd
* user

\
called\_isub: calling\_isub:

Digits for the subaddress information.

#### Network Identification Plan

network\_identification\_plan:

* Unknown (value 0)
* cic (3 digits carrier identification code plus circuit code, value 1, SS7 or ISDN)
* user (User, value 2, ISDN only)
* cic4 (4 digits carrier identification code plus circuit code, value 2, SS7 only)
* dnic (public Data Network ID, value 3, SS7 only)
* mnic (public land mobile network, value 6, SS7 only)


---

# Agent Instructions: 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:

```
GET https://prosbcdocs.telcobridges.com/configuration-details/configuration-by-web-portal-category/routing-scripts/development-guides-and-tutorials/script-parameters-definition.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
