Page History

...

Option Name	Type	Default Value	Regular Expression	Description
`100rel`	`Custom`	`yes`	`false`	Allow support for RFC3262 provisional ACK tags
`aggregate_mwi`	`Boolean`	`yes`	`false`	Condense MWI notifications into a single NOTIFY.
`allow`	`Codec`		`false`	Media Codec(s) to allow
`allow_overlap`	`Boolean`	`yes`	`false`	Enable RFC3578 overlap dialing support.
`aors`	`String`		`false`	AoR(s) to be used with the endpoint
`auth`	`Custom`		`false`	Authentication Object(s) associated with the endpoint
`callerid`	`Custom`		`false`	CallerID information for the endpoint
`callerid_privacy`	`Custom`	`allowed_not_screened`	`false`	Default privacy level
`callerid_tag`	`Custom`		`false`	Internal id_tag for the endpoint
`context`	`String`	`default`	`false`	Dialplan context for inbound sessions
`direct_media_glare_mitigation`	`Custom`	`none`	`false`	Mitigation of direct media (re)INVITE glare
`direct_media_method`	`Custom`	`invite`	`false`	Direct Media method type
`trust_connected_line`	`Boolean`	`yes`	`false`	Accept Connected Line updates from this endpoint
`send_connected_line`	`Boolean`	`yes`	`false`	Send Connected Line updates to this endpoint
`connected_line_method`	`Custom`	`invite`	`false`	Connected line method type
`direct_media`	`Boolean`	`yes`	`false`	Determines whether media may flow directly between endpoints.
`disable_direct_media_on_nat`	`Boolean`	`no`	`false`	Disable direct media session refreshes when NAT obstructs the media session
`disallow`				Media Codec(s) to disallow
`dtmf_mode`	`Custom`	`rfc4733`	`false`	DTMF mode
`media_address`	`String`		`false`	IP address used in SDP for media handling
`bind_rtp_to_media_address`	`Boolean`	`no`	`false`	Bind the RTP instance to the media_address
`force_rport`	`Boolean`	`yes`	`false`	Force use of return port
`ice_support`	`Boolean`	`no`	`false`	Enable the ICE mechanism to help traverse NAT
`identify_by`	`Custom`	`username,ip`	`false`	Way(s) for the endpoint to be identified
`redirect_method`	`Custom`	`user`	`false`	How redirects received from an endpoint are handled
`mailboxes`	`String`		`false`	NOTIFY the endpoint when state changes for any of the specified mailboxes
`mwi_subscribe_replaces_unsolicited`	`Boolean`	`no`	`false`	An MWI subscribe will replace sending unsolicited NOTIFYs
`voicemail_extension`	`Custom`		`false`	The voicemail extension to send in the NOTIFY Message-Account header
`moh_suggest`	`String`	`default`	`false`	Default Music On Hold class
`outbound_auth`	`Custom`		`false`	Authentication object(s) used for outbound requests
`outbound_proxy`	`String`		`false`	Full SIP URI of the outbound proxy used to send requests
`rewrite_contact`	`Boolean`	`no`	`false`	Allow Contact header to be rewritten with the source IP address-port
`rtp_ipv6`	`Boolean`	`no`	`false`	Allow use of IPv6 for RTP traffic
`rtp_symmetric`	`Boolean`	`no`	`false`	Enforce that RTP must be symmetric
`send_diversion`	`Boolean`	`yes`	`false`	Send the Diversion header, conveying the diversion information to the called user agent
`send_history_info`	`Boolean`	`no`	`false`	Send the History-Info header, conveying the diversion information to the called and calling user agents
`send_pai`	`Boolean`	`no`	`false`	Send the P-Asserted-Identity header
`send_rpid`	`Boolean`	`no`	`false`	Send the Remote-Party-ID header
`rpid_immediate`	`Boolean`	`no`	`false`	Immediately send connected line updates on unanswered incoming calls.
`timers_min_se`	`Unsigned Integer`	`90`	`false`	Minimum session timers expiration period
`timers`	`Custom`	`yes`	`false`	Session timers for SIP packets
`timers_sess_expires`	`Unsigned Integer`	`1800`	`false`	Maximum session timer expiration period
`transport`	`String`		`false`	Explicit transport configuration to use
`trust_id_inbound`	`Boolean`	`no`	`false`	Accept identification information received from this endpoint
`trust_id_outbound`	`Boolean`	`no`	`false`	Send private identification details to the endpoint.
`type`	`None`		`false`	Must be of type 'endpoint'.
`use_ptime`	`Boolean`	`no`	`false`	Use Endpoint's requested packetization interval
`use_avpf`	`Boolean`	`no`	`false`	Determines whether res_pjsip will use and enforce usage of AVPF for this endpoint.
`force_avp`	`Boolean`	`no`	`false`	Determines whether res_pjsip will use and enforce usage of AVP, regardless of the RTP profile in use for this endpoint.
`media_use_received_transport`	`Boolean`	`no`	`false`	Determines whether res_pjsip will use the media transport received in the offer SDP in the corresponding answer SDP.
`media_encryption`	`Custom`	`no`	`false`	Determines whether res_pjsip will use and enforce usage of media encryption for this endpoint.
`media_encryption_optimistic`	`Boolean`	`no`	`false`	Determines whether encryption should be used if possible but does not terminate the session if not achieved.
`g726_non_standard`	`Boolean`	`no`	`false`	Force g.726 to use AAL2 packing order when negotiating g.726 audio
`inband_progress`	`Boolean`	`no`	`false`	Determines whether chan_pjsip will indicate ringing using inband progress.
`call_group`	`Custom`		`false`	The numeric pickup groups for a channel.
`pickup_group`	`Custom`		`false`	The numeric pickup groups that a channel can pickup.
`named_call_group`	`Custom`		`false`	The named pickup groups for a channel.
`named_pickup_group`	`Custom`		`false`	The named pickup groups that a channel can pickup.
`device_state_busy_at`	`Unsigned Integer`	`0`	`false`	The number of in-use channels which will cause busy to be returned as device state
`t38_udptl`	`Boolean`	`no`	`false`	Whether T.38 UDPTL support is enabled or not
`t38_udptl_ec`	`Custom`	`none`	`false`	T.38 UDPTL error correction method
`t38_udptl_maxdatagram`	`Unsigned Integer`	`0`	`false`	T.38 UDPTL maximum datagram size
`fax_detect`	`Boolean`	`no`	`false`	Whether CNG tone detection is enabled
`fax_detect_timeout`	`Unsigned Integer`	`0`	`false`	How long into a call before fax_detect is disabled for the call
`t38_udptl_nat`	`Boolean`	`no`	`false`	Whether NAT support is enabled on UDPTL sessions
`t38_udptl_ipv6`	`Boolean`	`no`	`false`	Whether IPv6 is used for UDPTL Sessions
`t38_bind_udptl_to_media_address`	`Boolean`	`no`	`false`	Bind the UDPTL instance to the media_adress
`tone_zone`	`String`		`false`	Set which country's indications to use for channels created for this endpoint.
`language`	`String`		`false`	Set the default language to use for channels created for this endpoint.
`one_touch_recording`	`Boolean`	`no`	`false`	Determines whether one-touch recording is allowed for this endpoint.
`record_on_feature`	`String`	`automixmon`	`false`	The feature to enact when one-touch recording is turned on.
`record_off_feature`	`String`	`automixmon`	`false`	The feature to enact when one-touch recording is turned off.
`rtp_engine`	`String`	`asterisk`	`false`	Name of the RTP engine to use for channels created for this endpoint
`allow_transfer`	`Boolean`	`yes`	`false`	Determines whether SIP REFER transfers are allowed for this endpoint
`user_eq_phone`	`Boolean`	`no`	`false`	Determines whether a user=phone parameter is placed into the request URI if the user is determined to be a phone number
`moh_passthrough`	`Boolean`	`no`	`false`	Determines whether hold and unhold will be passed through using re-INVITEs with recvonly and sendrecv to the remote side
`sdp_owner`	`String`	`-`	`false`	String placed as the username portion of an SDP origin (o=) line.
`sdp_session`	`String`	`Asterisk`	`false`	String used for the SDP session (s=) line.
`tos_audio`	`Custom`	`0`	`false`	DSCP TOS bits for audio streams
`tos_video`	`Custom`	`0`	`false`	DSCP TOS bits for video streams
`cos_audio`	`Unsigned Integer`	`0`	`false`	Priority for audio streams
`cos_video`	`Unsigned Integer`	`0`	`false`	Priority for video streams
`allow_subscribe`	`Boolean`	`yes`	`false`	Determines if endpoint is allowed to initiate subscriptions with Asterisk.
`sub_min_expiry`	`Unsigned Integer`	`0`	`false`	The minimum allowed expiry time for subscriptions initiated by the endpoint.
`from_user`	`Custom`		`false`	Username to use in From header for requests to this endpoint.
`mwi_from_user`	`String`		`false`	Username to use in From header for unsolicited MWI NOTIFYs to this endpoint.
`from_domain`	`String`		`false`	Domain to user in From header for requests to this endpoint.
`dtls_verify`	`Custom`	`no`	`false`	Verify that the provided peer certificate is valid
`dtls_rekey`	`Custom`	`0`	`false`	Interval at which to renegotiate the TLS session and rekey the SRTP session
`dtls_auto_generate_cert`	`Custom`	`no`	`false`	Whether or not to automatically generate an ephemeral X.509 certificate
`dtls_cert_file`	`Custom`		`false`	Path to certificate file to present to peer
`dtls_private_key`	`Custom`		`false`	Path to private key for certificate file
`dtls_cipher`	`Custom`		`false`	Cipher to use for DTLS negotiation
`dtls_ca_file`	`Custom`		`false`	Path to certificate authority certificate
`dtls_ca_path`	`Custom`		`false`	Path to a directory containing certificate authority certificates
`dtls_setup`	`Custom`		`false`	Whether we are willing to accept connections, connect to the other party, or both.
`dtls_fingerprint`	`Custom`		`false`	Type of hash to use for the DTLS fingerprint in the SDP.
`srtp_tag_32`	`Boolean`	`no`	`false`	Determines whether 32 byte tags should be used instead of 80 byte tags.
`set_var`	`Custom`		`false`	Variable set on a channel involving the endpoint.
`message_context`	`String`		`false`	Context to route incoming MESSAGE requests to.
`accountcode`	`String`		`false`	An accountcode to set automatically on any channels created for this endpoint.
`preferred_codec_only`	`Boolean`	`no`	`false`	Respond to a SIP invite with the single most preferred codec rather than advertising all joint codec capabilities. This limits the other side's codec choice to exactly what we prefer.
`rtp_keepalive`	`Unsigned Integer`	`0`	`false`	Number of seconds between RTP comfort noise keepalive packets.
`rtp_timeout`	`Unsigned Integer`	`0`	`false`	Maximum number of seconds without receiving RTP (while off hold) before terminating call.
`rtp_timeout_hold`	`Unsigned Integer`	`0`	`false`	Maximum number of seconds without receiving RTP (while on hold) before terminating call.
`acl`	`Custom`		`false`	List of IP ACL section names in acl.conf
`deny`	`Custom`		`false`	List of IP addresses to deny access from
`permit`	`Custom`		`false`	List of IP addresses to permit access from
`contact_acl`	`Custom`		`false`	List of Contact ACL section names in acl.conf
`contact_deny`	`Custom`		`false`	List of Contact header addresses to deny
`contact_permit`	`Custom`		`false`	List of Contact header addresses to permit
`subscribe_context`	`String`		`false`	Context for incoming MESSAGE requests.
`contact_user`	`Custom`		`false`	Force the user on the outgoing Contact header to this value.
`asymmetric_rtp_codec`	`Boolean`	`no`	`false`	Allow the sending and receiving RTP codec to differ
`rtcp_mux`	`Boolean`	`no`	`false`	Enable RFC 5761 RTCP multiplexing on the RTP port
`refer_blind_progress`	`Boolean`	`yes`	`false`	Whether to notifies all the progress details on blind transfer
`notify_early_inuse_ringing`	`Boolean`	`no`	`false`	Whether to notifies dialog-info 'early' on InUse&Ringing state
`max_audio_streams`	`Unsigned Integer`	`1`	`false`	The maximum number of allowed audio streams for the endpoint
`max_video_streams`	`Unsigned Integer`	`1`	`false`	The maximum number of allowed video streams for the endpoint
`bundle`	`Boolean`	`no`	`false`	Enable RTP bundling
`webrtc`	`Boolean`	`no`	`false`	Defaults and enables some options that are relevant to WebRTC
`incoming_mwi_mailbox`	`String`		`false`	Mailbox name to use when incoming MWI NOTIFYs are received
`follow_early_media_fork`	`Boolean`	`yes`	`false`	Follow SDP forked media when To tag is different
`accept_multiple_sdp_answers`	`Boolean`	`no`	`false`	Accept multiple SDP answers on non-100rel responses
`suppress_q850_reason_headers`	`Boolean`	`no`	`false`	Suppress Q.850 Reason headers for this endpoint
`ignore_183_without_sdp`	`Boolean`	`no`	`false`	Do not forward 183 when it doesn't contain SDP
`stir_shaken`	`Custom`	`off`	`false`	Enable STIR/SHAKEN support on this endpoint
`stir_shaken_profile`	`String`		`false`	STIR/SHAKEN profile containing additional configuration options
`allow_unauthenticated_options`	`Boolean`	`no`	`false`	Skip authentication when receiving OPTIONS requests
`geoloc_incoming_call_profile`	`String`		`false`	Geolocation profile to apply to incoming calls
`geoloc_outgoing_call_profile`	`String`		`false`	Geolocation profile to apply to outgoing calls

Configuration Option Descriptions

...

Asterisk will send unsolicited MWI NOTIFY messages to the endpoint when state changes happen for any of the specified mailboxes. More than one mailbox can be specified with a comma-delimited string. app_voicemail mailboxes must be specified as [email protected]; for example: [email protected] For mailboxes provided by external sources, such as through the res_mwi_external _mwi module, you must specify strings supported by the external system.

...

When enabled the UDPTL stack will use IPv6.

Anchor

	endpoint_t38_bind_udptl_to_media_address
	endpoint_t38_bind_udptl_to_media_address

t38_bind_udptl_to_media_address

If media_address is specified, this option causes the UDPTL instance to be bound to the specified ip address which causes the packets to be sent from that address.

Anchor

	endpoint_record_on_feature
	endpoint_record_on_feature

...

This option only applies if media_encryption is set to dtls.

It can be one of the following values:

no - meaning no verification is done.
fingerprint - meaning to verify the remote fingerprint.
certificate - meaning to verify the remote certificate.
yes - meaning to verify both the remote fingerprint and certificate.

Anchor

	endpoint_dtls_rekey
	endpoint_dtls_rekey

...

Certain SS7 internetworking scenarios can result in a 183 to be generated for reasons other than early media. Forwarding this 183 can cause loss of ringback tone. This flag emulates the behavior of chan_sip and prevents these 183 responses from being forwarded.

Anchor

	endpoint_stir_shaken
	endpoint_stir_shaken

stir_shaken

Enable STIR/SHAKEN support on this endpoint. On incoming INVITEs, the Identity header will be checked for validity. On outgoing INVITEs, an Identity header will be added.

Anchor

	endpoint_stir_shaken_profile
	endpoint_stir_shaken_profile

stir_shaken_profile

A STIR/SHAKEN profile that is defined in stir_shaken.conf. Contains several options and rules used for STIR/SHAKEN.

Anchor

	endpoint_allow_unauthenticated_options
	endpoint_allow_unauthenticated_options

allow_unauthenticated_options

RFC 3261 says that the response to an OPTIONS request MUST be the same had the request been an INVITE. Some UAs use OPTIONS requests like a 'ping' and the expectation is that they will return a 200 OK.

Enabling allow_unauthenticated_options will skip authentication of OPTIONS requests for the given endpoint.

There are security implications to enabling this setting as it can allow information disclosure to occur - specifically, if enabled, an external party could enumerate and find the endpoint name by sending OPTIONS requests and examining the responses.

Anchor

	endpoint_geoloc_incoming_call_profile
	endpoint_geoloc_incoming_call_profile

geoloc_incoming_call_profile

This geolocation profile will be applied to all calls received by the channel driver from the remote endpoint before they're forwarded to the dialplan.

Anchor

	endpoint_geoloc_outgoing_call_profile
	endpoint_geoloc_outgoing_call_profile

geoloc_outgoing_call_profile

This geolocation profile will be applied to all calls received by the channel driver from the dialplan before they're forwarded the remote endpoint.

auth

Authentication type

Configuration Option Reference

Option Name	Type	Default Value	Regular Expression	Description
`auth_type`	`Custom`	`userpass`	`false`	Authentication type
`nonce_lifetime`	`Unsigned Integer`	`32`	`false`	Lifetime of a nonce associated with this authentication config.
`md5_cred`	`String`		`false`	MD5 Hash used for authentication.
`password`	`String`		`false`	Plain text password used for authentication.
`realm`	`String`		`false`	SIP realm for endpoint
`type`	`None`		`false`	Must be 'auth'
`username`	`String`		`false`	Username to use for account

...

This option specifies which of the password style config options should be read when trying to authenticate an endpoint inbound request. If set to userpass then we'll read from the 'password' option. For md5 we'll read from 'md5_cred'. The following values are valid:

md5
userpass

Info

title	Note

This setting only describes whether the password is in plain text or has been pre-hashed with MD5. It doesn't describe the acceptable digest algorithms we'll accept in a received challenge.

Anchor

	auth_md5_cred
	auth_md5_cred

...

Only used when auth_type is md5. As an alternative to specifying a plain text password, you can hash the username, realm and password together one time and place the hash value here. The input to the hash function must be in the following format:

For incoming authentication (asterisk is the server), the realm must match either the realm set in this object or the default_realm set in in the global object.

For outgoing authentication (asterisk is the UAC), the realm must match what the server will be sending in their WWW-Authenticate header. It can't be blank unless you expect the server to be sending a blank realm in the header. You can't use pre-hashed passwords with a wildcard auth object. You can generate the hash with the following shell command:

$ echo -n "myname:myrealm:mypassword" | md5sum

Note the '-n'. You don't want a newline to be part of the hash.

Anchor

	auth_password
	auth_password

...

Anchor

	auth_realm
	auth_realm

realm

The treatment of this value depends upon how the authentication object is used.

When used as an inbound authentication object, the realm is sent as part of the challenge so the peer can know which key to use when responding. An empty value will use the global sectionFor incoming authentication (asterisk is the UAS), this is the realm to be sent on WWW-Authenticate headers. If not specified, the global object's default_realm value when issuing a challenge.When used as an outbound authentication object, the realm is matched with the received challenge realm to determine which authentication object to use when responding to the challenge. An empty value matches any challenging realm when determining which authentication object matches a received challenge will be used.

For outgoing authentication (asterisk is the UAC), this must either be the realm the server is expected to send, or left blank or contain a single '*' to automatically use the realm sent by the server. If you have multiple auth objects for an endpoint, the realm is also used to match the auth object to the realm the server sent.

Info

title	Note

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.

Info

title	Note

If more than one auth object with the same realm or more than one wildcard auth object associated to an endpoint, we can only use the first one of each defined on the endpoint.

domain_alias

Domain Alias

Configuration Option Reference

...

Option Name	Type	Default Value	Regular Expression	Description
`async_operations`	`Unsigned Integer`	`1`	`false`	Number of simultaneous Asynchronous Operations, can no longer be set, always set to 1
`bind`	`Custom`		`false`	IP Address and optional port to bind to for this transport
`ca_list_file`	`Custom`		`false`	File containing a list of certificates to read (TLS ONLY, not WSS)
`ca_list_path`	`Custom`		`false`	Path to directory containing a list of certificates to read (TLS ONLY, not WSS)
`cert_file`	`Custom`		`false`	Certificate file for endpoint (TLS ONLY, not WSS)
`cipher`	`Custom`		`false`	Preferred cryptography cipher names (TLS ONLY, not WSS)
`domain`	`String`		`false`	Domain the transport comes from
`external_media_address`	`String`		`false`	External IP address to use in RTP handling
`external_signaling_address`	`String`		`false`	External address for SIP signalling
`external_signaling_port`	`Unsigned Integer`	`0`	`false`	External port for SIP signalling
`method`	`Custom`		`false`	Method of SSL transport (TLS ONLY, not WSS)
`local_net`	`Custom`		`false`	Network to consider local (used for NAT purposes).
`password`	`String`		`false`	Password required for transport
`priv_key_file`	`Custom`		`false`	Private key file (TLS ONLY, not WSS)
`protocol`	`Custom`	`udp`	`false`	Protocol to use for SIP traffic
`require_client_cert`	`Custom`		`false`	Require client certificate (TLS ONLY, not WSS)
`type`	`Custom`		`false`	Must be of type 'transport'.
`verify_client`	`Custom`		`false`	Require verification of client certificate (TLS ONLY, not WSS)
`verify_server`	`Custom`		`false`	Require verification of server certificate (TLS ONLY, not WSS)
`tos`	`Custom`	`0`	`false`	Enable TOS for the signalling sent over this transport
`cos`	`Unsigned Integer`	`0`	`false`	Enable COS for the signalling sent over this transport
`websocket_write_timeout`	`Integer`	`100`	`false`	The timeout (in milliseconds) to set on WebSocket connections.
`allow_reload`	`Boolean`	`no`	`false`	Allow this transport to be reloaded.
`allow_wildcard_certs`	`Custom`		`false`	Allow use of wildcards in certificates (TLS ONLY)
`symmetric_transport`	`Boolean`	`no`	`false`	Use the same transport for outgoing requests as incoming ones.

...

If a websocket connection accepts input slowly, the timeout for writes to it can be increased to keep it from being disconnected. Value is in milliseconds; default is 100 ms.

Anchor

	transport_allow_reload
	transport_allow_reload

...

Allow this transport to be reloaded when res_pjsip is reloaded. This option defaults to "no" because reloading a transport may disrupt in-progress calls.

Anchor

	transport_allow_wildcard_certs
	transport_allow_wildcard_certs

allow_wildcard_certs

In combination with verify_server, when enabled allow use of wildcards, i.e. '.' in certs for common,and subject alt names of type DNS for TLS transport types. Names must start with the wildcard. Partial wildcards, e.g. 'f.example.com' and 'foo..com' are not allowed. As well, names only match against a single level meaning '.example.com' matches 'foo.example.com', but not 'foo.bar.example.com'.

Anchor

	transport_symmetric_transport
	transport_symmetric_transport

...

Option Name	Type	Default Value	Regular Expression	Description
`type`	`None`		`false`	Must be of type 'contact'.
`uri`	`String`		`false`	SIP URI to contact peer
`expiration_time`	`Custom`		`false`	Time to keep alive a contact
`qualify_frequency`	`Unsigned Integer`	`0`	`false`	Interval at which to qualify a contact
`qualify_timeout`	`Double`	`3.0`	`false`	Timeout for qualify
`authenticate_qualify`	`Boolean`	`no`	`false`	Authenticates a qualify challenge response if needed
`outbound_proxy`	`String`		`false`	Outbound proxy used when sending OPTIONS request
`path`	`String`		`false`	Stored Path vector for use in Route headers on outgoing requests.
`user_agent`	`String`		`false`	User-Agent header from registration.
`endpoint`	`String`		`false`	Endpoint name
`reg_server`	`String`		`false`	Asterisk Server name
`via_addr`	`String`		`false`	IP-address of the last Via header from registration.
`via_port`	`Unsigned Integer`	`0`	`false`	IP-port of the last Via header from registration.
`call_id`	`String`		`false`	Call-ID header from registration.
`prune_on_boot`	`Boolean`	`no`	`false`	A contact that cannot survive a restart/boot.

...

Option Name	Type	Default Value	Regular Expression	Description
`contact`	`Custom`		`false`	Permanent contacts assigned to AoR
`default_expiration`	`Unsigned Integer`	`3600`	`false`	Default expiration time in seconds for contacts that are dynamically bound to an AoR.
`mailboxes`	`String`		`false`	Allow subscriptions for the specified mailbox(es)
`voicemail_extension`	`Custom`		`false`	The voicemail extension to send in the NOTIFY Message-Account header
`maximum_expiration`	`Unsigned Integer`	`7200`	`false`	Maximum time to keep an AoR
`max_contacts`	`Unsigned Integer`	`0`	`false`	Maximum number of contacts that can bind to an AoR
`minimum_expiration`	`Unsigned Integer`	`60`	`false`	Minimum keep alive time for an AoR
`remove_existing`	`Boolean`	`no`	`false`	Determines whether new contacts replace existing ones.
`remove_unavailable`	`Boolean`	`no`	`false`	Determines whether new contacts should replace unavailable ones.
`type`	`None`		`false`	Must be of type 'aor'.
`qualify_frequency`	`Unsigned Integer`	`0`	`false`	Interval at which to qualify an AoR
`qualify_timeout`	`Double`	`3.0`	`false`	Timeout for qualify
`authenticate_qualify`	`Boolean`	`no`	`false`	Authenticates a qualify challenge response if needed
`outbound_proxy`	`String`		`false`	Outbound proxy used when sending OPTIONS request
`support_path`	`Boolean`	`no`	`false`	Enables Path support for REGISTER requests and Route support for other requests.

...

This option applies when an external entity subscribes to an AoR for Message Waiting Indications. The mailboxes specified will be subscribed to. More than one mailbox can be specified with a comma-delimited string. app_voicemail mailboxes must be specified as [email protected]; for example: [email protected] For mailboxes provided by external sources, such as through the res_mwi_external _mwi module, you must specify strings supported by the external system.

...

Info

title	Note

The rewrite_contact option registers the source address as the contact address to help with NAT and reusing connection oriented transports such as TCP and TLS. Unfortunately, refreshing a registration may register a different contact address and exceed max_contacts. The remove_existing option and remove_unavailable options can help by removing either the soonest to expire or unavailable contact(s) over max_contacts which is likely the old rewrite_contact contact source address being refreshed.

...

Info

title	Note

This should be set to yes and max_contacts set to 1 if you wish to stick with the older chan_sip behaviour.

Anchor

	aor_remove_unavailable
	aor_remove_unavailable

remove_unavailable

The effect of this setting depends on the setting of remove_existing.

If remove_existing is set to no (default), setting remove_unavailable to yes will remove only unavailable contacts that exceed _max_contacts_to allow an incoming REGISTER to complete sucessfully.

If remove_existing is set to yes, setting remove_unavailable to yes will prioritize unavailable contacts for removal instead of just removing the contact that expires the soonest.

Info

title	Note

See remove_existing and max_contacts for further information about how these 3 settings interact.

Anchor

	aor_qualify_frequency
	aor_qualify_frequency

...

Option Name	Type	Default Value	Regular Expression	Description
`timer_t1`	`Unsigned Integer`	`500`	`false`	Set transaction timer T1 value (milliseconds).
`timer_b`	`Unsigned Integer`	`32000`	`false`	Set transaction timer B value (milliseconds).
`compact_headers`	`Boolean`	`no`	`false`	Use the short forms of common SIP header names.
`threadpool_initial_size`	`Unsigned Integer`	`0`	`false`	Initial number of threads in the res_pjsip threadpool.
`threadpool_auto_increment`	`Unsigned Integer`	`5`	`false`	The amount by which the number of threads is incremented when necessary.
`threadpool_idle_timeout`	`Unsigned Integer`	`60`	`false`	Number of seconds before an idle thread should be disposed of.
`threadpool_max_size`	`Unsigned Integer`	`50`	`false`	Maximum number of threads in the res_pjsip threadpool. A value of 0 indicates no maximum.
`disable_tcp_switch`	`Boolean`	`yes`	`false`	Disable automatic switching from UDP to TCP transports.
`follow_early_media_fork`	`Boolean`	`yes`	`false`	Follow SDP forked media when To tag is different
`accept_multiple_sdp_answers`	`Boolean`	`no`	`false`	Follow SDP forked media when To tag is the same
`disable_rport`	`Boolean`	`no`	`false`	Disable the use of rport in outgoing requests.
`type`	`None`		`false`	Must be of type 'system' UNLESS the object name is 'system'.

...

Info

title	Note

This option must also be enabled on endpoints that require this functionality.

Anchor

	system_disable_rport
	system_disable_rport

disable_rport

Remove "rport" parameter from the outgoing requests.

global

Options that apply globally to all SIP communications

...

Option Name	Type	Default Value	Regular Expression	Description
`max_forwards`	`Unsigned Integer`	`70`	`false`	Value used in Max-Forwards header for SIP requests.
`keep_alive_interval`	`Unsigned Integer`	`90`	`false`	The interval (in seconds) to send keepalives to active connection-oriented transports.
`contact_expiration_check_interval`	`Unsigned Integer`	`30`	`false`	The interval (in seconds) to check for expired contacts.
`disable_multi_domain`	`Boolean`	`no`	`false`	Disable Multi Domain support
`max_initial_qualify_time`	`Unsigned Integer`	`0`	`false`	The maximum amount of time from startup that qualifies should be attempted on all contacts. If greater than the qualify_frequency for an aor, qualify_frequency will be used instead.
`unidentified_request_period`	`Unsigned Integer`	`5`	`false`	The number of seconds over which to accumulate unidentified requests.
`unidentified_request_count`	`Unsigned Integer`	`5`	`false`	The number of unidentified requests from a single IP to allow.
`unidentified_request_prune_interval`	`Unsigned Integer`	`30`	`false`	The interval at which unidentified requests are older than twice the unidentified_request_period are pruned.
`type`	`None`		`false`	Must be of type 'global' UNLESS the object name is 'global'.
`user_agent`	`String`	`Asterisk PBX GIT-16-daed5935c8e414`	`false`	Value used in User-Agent header for SIP requests and Server header for SIP responses.
`regcontext`	`String`		`false`	When set, Asterisk will dynamically create and destroy a NoOp priority 1 extension for a given peer who registers or unregisters with us.
`default_outbound_endpoint`	`String`	`default_outbound_endpoint`	`false`	Endpoint to use when sending an outbound request to a URI without a specified endpoint.
`default_voicemail_extension`	`String`		`false`	The voicemail extension to send in the NOTIFY Message-Account header if not specified on endpoint or aor
`debug`	`String`	`no`	`false`	Enable/Disable SIP debug logging. Valid options include yes, no, or a host address
`endpoint_identifier_order`	`String`	`ip,username,anonymous`	`false`	The order by which endpoint identifiers are processed and checked. Identifier names are usually derived from and can be found in the endpoint identifier module itself (res_pjsip_endpoint_identifier_*). You can use the CLI command "pjsip show identifiers" to see the identifiers currently available.
`default_from_user`	`String`	`asterisk`	`false`	When Asterisk generates an outgoing SIP request, the From header username will be set to this value if there is no better option (such as CallerID) to be used.
`default_realm`	`String`	`asterisk`	`false`	When Asterisk generates a challenge, the digest realm will be set to this value if there is no better option (such as auth/realm) to be used.
`mwi_tps_queue_high`	`Unsigned Integer`	`500`	`false`	MWI taskprocessor high water alert trigger level.
`mwi_tps_queue_low`	`Integer`	`-1`	`false`	MWI taskprocessor low water clear alert level.
`mwi_disable_initial_unsolicited`	`Boolean`	`no`	`false`	Enable/Disable sending unsolicited MWI to all endpoints on startup.
`ignore_uri_user_options`	`Boolean`	`no`	`false`	Enable/Disable ignoring SIP URI user field options.
`use_callerid_contact`	`Boolean`	`no`	`false`	Place caller-id information into Contact header
`send_contact_status_on_update_registration`	`Boolean`	`no`	`false`	Enable sending AMI ContactStatus event when a device refreshes its registration.
`taskprocessor_overload_trigger`	`Custom`	`global`	`false`	Trigger scope for taskprocessor overloads
`norefersub`	`Boolean`	`yes`	`false`	Advertise support for RFC4488 REFER subscription suppression
`allow_sending_180_after_183`	`Boolean`	`no`	`false`	Allow 180 after 183

Configuration Option Descriptions

...

global - (default) Any taskprocessor overload will trigger.
pjsip_only - Only pjsip taskprocessor overloads will trigger.
none - No overload detection will be performed.
Warning
title Warning
The "none" and "pjsip_only" options should be used with extreme caution and only to mitigate specific issues. Under certain conditions they could make things worse.

Anchor

	global_allow_sending_180_after_183
	global_allow_sending_180_after_183

allow_sending_180_after_183

Allow Asterisk to send 180 Ringing to an endpoint after 183 Session Progress has been send. If disabled Asterisk will instead send only a 183 Session Progress to the endpoint. (default: "no")

Import Version

This documentation was imported from Asterisk Version GIT-16-daed5935c8e414

Versions Compared

Old Version 122

New Version Current

Key

Configuration Option Descriptions

t38_bind_udptl_to_media_address

stir_shaken

stir_shaken_profile

allow_unauthenticated_options

geoloc_incoming_call_profile

geoloc_outgoing_call_profile

auth

Configuration Option Reference

realm

domain_alias

Configuration Option Reference

allow_wildcard_certs

remove_unavailable

disable_rport

global

Configuration Option Descriptions

allow_sending_180_after_183

Import Version