Skip to end of metadata
Go to start of metadata

SIP resource for outbound registrations

This configuration documentation is for functionality provided by res_pjsip_outbound_registration.

Overview

Outbound Registration

This module allows res_pjsip to register to other SIP servers.

pjsip.conf

registration

The configuration for outbound registration

Configuration Option Reference

Option Name

Type

Default Value

Regular Expression

Description

auth_rejection_permanent

Boolean

yes

false

Determines whether failed authentication challenges are treated as permanent failures.

client_uri

String

 

false

Client SIP URI used when attemping outbound registration

contact_user

String

 

false

Contact User to use in request

expiration

Unsigned Integer

3600

false

Expiration time for registrations in seconds

max_retries

Unsigned Integer

10

false

Maximum number of registration attempts.

outbound_auth

Custom

 

false

Authentication object(s) to be used for outbound registrations.

outbound_proxy

String

 

false

Full SIP URI of the outbound proxy used to send registrations

retry_interval

Unsigned Integer

60

false

Interval in seconds between retries if outbound registration is unsuccessful

forbidden_retry_interval

Unsigned Integer

0

false

Interval used when receiving a 403 Forbidden response.

fatal_retry_interval

Unsigned Integer

0

false

Interval used when receiving a Fatal response.

server_uri

String

 

false

SIP URI of the server to register against

transport

String

 

false

Transport used for outbound authentication

line

Boolean

no

false

Whether to add a 'line' parameter to the Contact for inbound call matching

endpoint

String

 

false

Endpoint to use for incoming related calls

type

None

 

false

Must be of type 'registration'.

support_path

Boolean

no

false

Enables Path support for outbound REGISTER requests.

Configuration Option Descriptions

auth_rejection_permanent

If this option is enabled and an authentication challenge fails, registration will not be attempted again until the configuration is reloaded.

client_uri

This is the address-of-record for the outbound registration (i.e. the URI in the To header of the REGISTER).

For registration with an ITSP, the client SIP URI may need to consist of an account name or number and the provider's hostname for their registrar, e.g. [email protected] This may differ between providers.

For registration to generic registrars, the client SIP URI will depend on networking specifics and configuration of the registrar.

max_retries

This sets the maximum number of registration attempts that are made before stopping any further attempts. If set to 0 then upon failure no further attempts are made.

outbound_auth

This is a comma-delimited list of auth sections defined in pjsip.conf used to respond to outbound authentication challenges.

Note

Icon

Using the same auth section for inbound and outbound authentication is not recommended. There is a difference in meaning for an empty realm setting between inbound and outbound authentication uses. See the auth realm description for details.

forbidden_retry_interval

If a 403 Forbidden is received, chan_pjsip will wait forbidden_retry_interval seconds before attempting registration again. If 0 is specified, chan_pjsip will not retry after receiving a 403 Forbidden response. Setting this to a non-zero value goes against a "SHOULD NOT" in RFC3261, but can be used to work around buggy registrars.

fatal_retry_interval

If a fatal response is received, chan_pjsip will wait fatal_retry_interval seconds before attempting registration again. If 0 is specified, chan_pjsip will not retry after receiving a fatal (non-temporary 4xx, 5xx, 6xx) response. Setting this to a non-zero value may go against a "SHOULD NOT" in RFC3261, but can be used to work around buggy registrars.

Note

Icon

if also set the forbidden_retry_interval takes precedence over this one when a 403 is received. Also, if auth_rejection_permanent equals 'yes' then a 401 and 407 become subject to this retry interval.

server_uri

This is the URI at which to find the registrar to send the outbound REGISTER. This URI is used as the request URI of the outbound REGISTER request from Asterisk.

For registration with an ITSP, the setting may often be just the domain of the registrar, e.g. sip:sip.example.com.

transport

Note

Icon

A transport configured in pjsip.conf. As with other res_pjsip modules, this will use the first available transport of the appropriate type if unconfigured.

line

When enabled this option will cause a 'line' parameter to be added to the Contact header placed into the outgoing registration request. If the remote server sends a call this line parameter will be used to establish a relationship to the outbound registration, ultimately causing the configured endpoint to be used.

endpoint

When line support is enabled this configured endpoint name is used for incoming calls that are related to the outbound registration.

support_path

When this option is enabled, outbound REGISTER requests will advertise support for Path headers so that intervening proxies can add to the Path header as necessary.

Import Version

This documentation was imported from Asterisk Version GIT-13-9c8424a97

  • No labels