SIP Line Appearances

Last Updated : Dec 11, 2023 |

These settings allow the SIP line to emulate the use of line appearances on phones that support line appearance buttons. Those buttons can then be used to make or receive calls. For details, see SIP Line Appearances.

SIP line appearances are not supported over a multi-site network/SCN or in resiliency.

General Settings

Name

Description

SIP Line Appearances

Default = Disabled

When enabled, SIP line appearances can be configured. Note, if you disable this setting and save the configuration, all configured SIP line appearance values are removed.

Incoming Group

Default = 0, Range 0 to 99999.

This value is used to match incoming to the Line Group ID of an incoming call route entry.

Outgoing Group

Default = 0, Range 0 to 99999.

Short codes that specify a number to dial to a line specify a Line Group ID. This is used to match to lines with the same Outgoing Group value.

Credentials

Default = 0:<None>

This field is used to select from a list of the account credentials configured on the line's SIP Credentials tab.

Max Sessions

Default =10

This field sets the maximum number of simultaneous calls that can use the URI before the system returns busy to any further calls.

Incoming Sessions

Default = 3

The maximum number of incoming call sessions.

Outgoing Sessions

Default = 3

The maximum number of outgoing call sessions. .

The remaining sections are arranged as a table of values. These set which SIP headers are used for calls routed by the SIP URI entry.

The table also sets the source of the values used in the SIP URI values in those headers. A typical SIP URI takes the following form: display <sip:content@hostname> where:

  • display is the displayed name value for the caller/called party.

  • content is the call target name or number.

  • hostname is the host from/to which the calls are sent. For details of how the hostname used by the IP Office system is set, see Setting the SIP URI Host.

Headers

The first column indicates the headers used for calls matched to this SIP URI entry.

Name

Description

Local URI

Default = Auto

This field sets the From field for outgoing SIP calls using this URI.

Contact

Default = Auto

This field sets the From field for outgoing SIP calls using this URI.

P Asserted ID

Default = Disabled

When selected, identity information is provided in P-Asserted-Identity (PAI) headers.

P Preferred ID

Default = Disabled

When selected, identity information is provided in a P-Preferred-Identity header.

Diversion Header

Default = Disabled

When selected, information from the Diversion Header is provided in the SIP messages.

Remote Party ID

Default = Disabled

When selected, Remote Party ID header are provided with calls.

Display

This column sets the source for the display part of the SIP URI used in the selected headers.

Setting

Description

Auto

If Auto is selected, the system automatically determines the appropriate value to use. It uses external numbers when forwarding incoming calls, and internal extension numbers for calls made by a local user.

  • On incoming calls, the system looks for matches against extension numbers and system short codes.

  • On outgoing calls, the system allows short code manipulation of the caller number and name. For example: S to explicitly set the caller number, W to set withheld, A to allow (override any previous withhold setting), Z to set the caller name.

Use Internal Data

Use the SIP settings of the user (User > SIP), group (Group > SIP) or voicemail services (System > Voicemail > SIP) making or receiving the call:

  • Use the SIP Display Name (Alias) setting.

  • If the Anonymous is selected, use that value instead.

Manual Entry

If required, you can manually type in a value to use. The value is then used by other fields configured as Explicit. This is typically used to set the DDI to be associated with SIP line appearances.

Credential Values

If a Credentials entry has been selected above, then the User name, Authentication Name and Contact values from the selected credentials entry can be selected as values. The value is then used by other fields configured as Explicit.

  • URI values should only be set using credentials when required by the line provider. For example, some line providers require the From header to always contains the credentials used for registration, whilst other headers are used to convey information about the caller ID.

Content

This column sets the source for the content part of the SIP URI used in the selected headers.

Setting

Description

Auto

If Auto is selected, the system automatically determines the appropriate value to use. It uses external numbers when forwarding incoming calls, and internal extension numbers for calls made by a local user.

  • On incoming calls, the system looks for matches against extension numbers and system short codes.

  • On outgoing calls, the system allows short code manipulation of the caller number and name. For example: S to explicitly set the caller number, W to set withheld, A to allow (override any previous withhold setting), Z to set the caller name.

Use Internal Data

Use the SIP settings of the user (User > SIP), group (Group > SIP) or voicemail services (System > Voicemail > SIP) making or receiving the call:

  • Use the SIP Display Name (Alias) setting.

  • If the Anonymous is selected, use that value instead.

Manual Entry

If required, you can manually type in a value to use. The value is then used by other fields configured as Explicit. This is typically used to set the DDI to be associated with SIP line appearances.

Credential Values

If a Credentials entry has been selected above, then the User name, Authentication Name and Contact values from the selected credentials entry can be selected as values. The value is then used by other fields configured as Explicit.

  • URI values should only be set using credentials when required by the line provider. For example, some line providers require the From header to always contains the credentials used for registration, whilst other headers are used to convey information about the caller ID.

Field Meaning

These values are used to set the source or value for headers based on the call direction.

Field

Description

Outgoing Calls

Set the source for URI header information on outgoing external calls.

Incoming Calls

Set the source for URI header information on incoming external calls.

The following values can be selected for the different fields.

Field

Description

Explicit

Use the manual entered values from the header Display and Content fields, or the credentials values selected from those drop-downs.

None

Do not send the header.
Related information
Call Details