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
`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

...

This option only applies if media_encryption is set to dtls.

It can be one of the following values:

no - meaning no verificaton 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

...

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.
`refresh_token`	`String`		`false`	OAuth 2.0 refresh token
`oauth_clientid`	`String`		`false`	OAuth 2.0 application's client id
`oauth_secret`	`String`		`false`	OAuth 2.0 application's secret
`realm`	`String`		`false`	SIP realm for endpoint
`type`	`None`		`false`	Must be 'auth'
`username`	`String`		`false`	Username to use for account

...

Option Name	Type	Default Value	Regular Expression	Description
`async_operations`	`Unsigned Integer`	`1`	`false`	Number of simultaneous Asynchronous Operations
`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.
`symmetric_transport`	`Boolean`	`no`	`false`	Use the same transport for outgoing requests as incoming ones.

...

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.
`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.

...

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-17-e9b91417023cc2`	`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

...

Code Block

title	Example: Sample SIP URI
linenumbers	true

							sip:1235557890;[email protected];user=phone

Code Block

title	Example: Sample SIP URI user field
linenumbers	true

							1235557890;phone-context=national

Code Block

title	Example: Sample SIP URI user field truncated
linenumbers	true

1235557890

Info

title	Note

The caller-id and redirecting number strings obtained from incoming SIP URI user fields are always truncated at the first semicolon.

...

This documentation was imported from Asterisk Version GIT-17-e9b91417023cc2

Versions Compared

Old Version 76

New Version Current

Key

disable_rport

global