...
Option Name | Type | Default Value | Regular Expression | Description |
---|---|---|---|---|
| | | Allow support for RFC3262 provisional ACK tags | |
| | | Condense MWI notifications into a single NOTIFY. | |
| |
| | Media Codec(s) to allow |
| | | | Enable RFC3578 overlap dialing support. |
|
| | AoR(s) to be used with the endpoint | |
|
| | Authentication Object(s) associated with the endpoint | |
|
| | CallerID information for the endpoint | |
| | | Default privacy level | |
| |
| | Internal id_tag for the endpoint |
| | | | Dialplan context for inbound sessions |
| | | Mitigation of direct media (re)INVITE glare | |
| | | Direct Media method type | |
| | | | Accept Connected Line updates from this endpoint |
| | | | Send Connected Line updates to this endpoint |
| | | Connected line method type | |
| | | | Determines whether media may flow directly between endpoints. |
| | | | Disable direct media session refreshes when NAT obstructs the media session |
|
|
|
| Media Codec(s) to disallow |
| | | DTMF mode | |
|
| | IP address used in SDP for media handling | |
| | | Bind the RTP instance to the media_address | |
| | | | Force use of return port |
| | | | Enable the ICE mechanism to help traverse NAT |
| | | Way(s) for Endpoint the endpoint to be identified | |
| | | How redirects received from an endpoint are handled | |
|
| | NOTIFY the endpoint when state changes for any of the specified mailboxes | |
| | | | An MWI subscribe will replace sending unsolicited NOTIFYs |
| |
| | The voicemail extension to send in the NOTIFY Message-Account header |
| | | | Default Music On Hold class |
|
| | Authentication object(s) used for outbound requests | |
| |
| | Proxy through which Full SIP URI of the outbound proxy used to send requests , a full SIP URI must be provided |
| | | Allow Contact header to be rewritten with the source IP address-port | |
| | | | Allow use of IPv6 for RTP traffic |
| | | | Enforce that RTP must be symmetric |
| | | | Send the Diversion header, conveying the diversion information to the called user agent |
| | | | Send the History-Info header, conveying the diversion information to the called and calling user agents |
| | | | Send the P-Asserted-Identity header |
| | | | Send the Remote-Party-ID header |
| | | Immediately send connected line updates on unanswered incoming calls. | |
| | | Minimum session timers expiration period | |
| | | Session timers for SIP packets | |
| | | Maximum session timer expiration period | |
|
| | Desired Explicit transport configuration to use | |
| | | Accept identification information received from this endpoint | |
| | | Send private identification details to the endpoint. | |
| |
| | Must be of type 'endpoint'. |
| | | | Use Endpoint's requested packetisation packetization interval |
| | | Determines whether res_pjsip will use and enforce usage of AVPF for this endpoint. | |
| | | Determines whether res_pjsip will use and enforce usage of AVP, regardless of the RTP profile in use for this endpoint. | |
| | | Determines whether res_pjsip will use the media transport received in the offer SDP in the corresponding answer SDP. | |
| | | Determines whether res_pjsip will use and enforce usage of media encryption for this endpoint. | |
| | | Determines whether encryption should be used if possible but does not terminate the session if not achieved. | |
| | | Force g.726 to use AAL2 packing order when negotiating g.726 audio | |
| | | Determines whether chan_pjsip will indicate ringing using inband progress. | |
|
| | The numeric pickup groups for a channel. | |
|
| | The numeric pickup groups that a channel can pickup. | |
|
| | The named pickup groups for a channel. | |
|
| | The named pickup groups that a channel can pickup. | |
| | | The number of in-use channels which will cause busy to be returned as device state | |
| | | Whether T.38 UDPTL support is enabled or not | |
| | | T.38 UDPTL error correction method | |
| | | T.38 UDPTL maximum datagram size | |
| | | Whether CNG tone detection is enabled | |
| | | How long into a call before fax_detect is disabled for the call | |
| | | Whether NAT support is enabled on UDPTL sessions | |
| | | Whether IPv6 is used for UDPTL Sessions | |
| |
| | Set which country's indications to use for channels created for this endpoint. |
| |
| | Set the default language to use for channels created for this endpoint. |
| | | | Determines whether one-touch recording is allowed for this endpoint. |
| | | The feature to enact when one-touch recording is turned on. | |
| | | The feature to enact when one-touch recording is turned off. | |
| | | | Name of the RTP engine to use for channels created for this endpoint |
| | | | Determines whether SIP REFER transfers are allowed for this endpoint |
| | | | Determines whether a user=phone parameter is placed into the request URI if the user is determined to be a phone number |
| | | | Determines whether hold and unhold will be passed through using re-INVITEs with recvonly and sendrecv to the remote side |
| | | | String placed as the username portion of an SDP origin (o=) line. |
| | | | String used for the SDP session (s=) line. |
| | | DSCP TOS bits for audio streams | |
| | | DSCP TOS bits for video streams | |
| | | Priority for audio streams | |
| | | Priority for video streams | |
| | | | Determines if endpoint is allowed to initiate subscriptions with Asterisk. |
| | | | The minimum allowed expiry time for subscriptions initiated by the endpoint. |
| |
| | Username to use in From header for requests to this endpoint. |
| |
| | Username to use in From header for unsolicited MWI NOTIFYs to this endpoint. |
| |
| | Domain to user in From header for requests to this endpoint. |
| | | Verify that the provided peer certificate is valid | |
| | | Interval at which to renegotiate the TLS session and rekey the SRTP session | |
|
| | Path to certificate file to present to peer | |
|
| | Path to private key for certificate file | |
|
| | Cipher to use for DTLS negotiation | |
|
| | Path to certificate authority certificate | |
|
| | Path to a directory containing certificate authority certificates | |
|
| | Whether we are willing to accept connections, connect to the other party, or both. | |
|
| | Type of hash to use for the DTLS fingerprint in the SDP. | |
| | | Determines whether 32 byte tags should be used instead of 80 byte tags. | |
|
| | Variable set on a channel involving the endpoint. | |
|
| | Context to route incoming MESSAGE requests to. | |
|
| | An accountcode to set automatically on any channels created for this endpoint. | |
| | | Number of seconds between RTP comfort noise keepalive packets. | |
| | | Maximum number of seconds without receiving RTP (while off hold) before terminating call. | |
| | | Maximum number of seconds without receiving RTP (while on hold) before terminating call. | |
|
| | List of IP ACL section names in acl.conf | |
|
| | List of IP addresses to deny access from | |
|
| | List of IP addresses to permit access from | |
|
| | List of Contact ACL section names in acl.conf | |
|
| | List of Contact header addresses to deny | |
|
| | List of Contact header addresses to permit | |
|
| | Context for incoming MESSAGE requests. | |
|
| | Force the user on the outgoing Contact header to this value. | |
| | | Allow the sending and receiving RTP codec to differ | |
| | | Enable RFC 5761 RTCP multiplexing on the RTP port | |
| | | Whether to notifies all the progress details on blind transfer | |
| | | Whether to notifies dialog-info 'early' on InUse&Ringing state | |
|
| | Mailbox name to use when incoming MWI NOTIFYs are received | |
| | | Follow SDP forked media when To tag is different | |
| | | Accept multiple SDP answers on non-100rel responses | |
| | | Suppress Q.850 Reason headers for this endpoint | |
| | | Do not forward 183 when it doesn't contain SDP |
Configuration Option Descriptions
...
This is a comma-delimited list of auth sections defined in pjsip.conf
to be used to verify inbound connection attempts.
Endpoints without an authentication object configured will allow connections without vertification.verification.
Info | ||
---|---|---|
| ||
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. |
Anchor | ||||
---|---|---|---|---|
|
...
Method used when updating connected line information.
invite
- When set toinvite
, check the remote's Allow header and if UPDATE is allowed, send UPDATE instead of INVITE to avoid SDP renegotiation. If UPDATE is not Allowed, send INVITE.reinvite
- Alias for theinvite
value.update
- If set toupdate
, send UPDATE regardless of what the remote Allows.
Anchor | ||||
---|---|---|---|---|
|
...
rfc4733
- DTMF is sent out of band of the main audio stream. This supercedes the older RFC-2833 used within the olderchan_sip
.inband
- DTMF is sent as part of audio stream.info
- DTMF is sent as SIP INFO packets.auto
- DTMF is sent as RFC 4733 if the other side supports it or as INBAND if not.auto_info
- DTMF is sent as RFC 4733 if the other side supports it or as SIP INFO if not.
Anchor | ||||
---|---|---|---|---|
|
...
Info | ||
---|---|---|
| ||
Be aware that the |
Anchor | ||||
---|---|---|---|---|
|
bind_rtp_to_media_address
If media_address is specified, this option causes the RTP instance to be bound to the specified ip address which causes the packets to be sent from that address.
Anchor | ||||
---|---|---|---|---|
|
identify_by
An endpoint Endpoints and AORs can be identified in multiple ways. Currently, the only supported option is username
, which matches the endpoint This option is a comma separated list of methods the endpoint can be identified.
Info | ||
---|---|---|
| ||
This option controls both how an endpoint is matched for incoming traffic and also how an AOR is determined if a registration occurs. You must list at least one method that also matches for AORs or the registration will fail. |
username
- Matches the endpoint or AOR ID based on the username and domain in the From header (or To header for AORs). If an exact match on both username and domain/realm fails, the match is retried with just the username.auth_username
- Matches the endpoint or AOR ID based on the username and realm in the Authentication header. If an exact match on both username and domain/realm fails, the match is retried with just the username.Info title Note
...
This method of identification has some security considerations because an Authentication header is not present on the first message of a dialog when digest authentication is used. The client can't generate it until the server sends the challenge in a 401 response. Since Asterisk normally sends a security event when an incoming request can't be matched to an endpoint, using this method requires that the security event be deferred until a request is received with the Authentication header and only generated if the username doesn't result in a match. This may result in a delay before an attack is recognized. You can control how many unmatched requests are received from a single ip address before a security event is generated using the
unidentified_request
parameters in the "global" configuration object.ip
- Matches the endpoint based on the source IP address.
This method of identification is not
...
- configured here but simply allowed by this configuration option. See the documentation for the
identify
configuration section for more details on
...
- this method of endpoint identification.
...
header
- Matches the endpoint based on a configured SIP header value.
This method of identification is not configured here but simply allowed by this configuration option. See the documentation for theidentify
configuration section
...
username
- for more details on this method of endpoint identification.
Anchor | ||||
---|---|---|---|---|
|
...
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.
For endpoints that SUBSCRIBE for MWI, use the mailboxes
option in your AOR configuration.
Anchor | ||||
---|---|---|---|---|
|
outbound_auth
This is a comma-delimited list of auth sections defined in pjsip.conf
used to respond to outbound connection authentication challenges.
Info | ||
---|---|---|
| ||
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. |
Anchor | ||||
---|---|---|---|---|
|
...
On inbound SIP messages from this endpoint, the Contact header or an appropriate Record-Route header will be changed to have the source IP address and port. This option does not affect outbound messages send sent to this endpoint. This option helps servers communicate with endpoints that are behind NATs. This option also helps reuse reliable transport connections such as TCP and TLS.
Anchor | ||||
---|---|---|---|---|
|
rpid_immediate
When enabled, immediately send 180 Ringing or 183 Progress response messages to the caller if the connected line information is updated before the call is answered. This can send a 180 Ringing response before the call has even reached the far end. The caller can start hearing ringback before the far end even gets the call. Many phones tend to grab the first connected line information and refuse to update the display if it changes. The first information is not likely to be correct if the call goes to an endpoint not under the control of this Asterisk box.
When disabled, a connected line update must wait for another reason to send a message with the connected line information to the caller before the call is answered. You can trigger the sending of the information by using an appropriate dialplan application such as Ringing.
Anchor | ||||
---|---|---|---|---|
|
timers_min_se
Minimium Minimum session timer expiration period. Time in seconds.
Anchor | ||||
---|---|---|---|---|
|
timers
forced
no
yes
required
yes
always
forced
- Alias of always
Anchor | ||||
---|---|---|---|---|
|
timers_sess_expires
Maximium Maximum session timer expiration period. Time in seconds.
Anchor | ||||
---|---|---|---|---|
|
transport
This will set the desired force the endpoint to use the specified transport configuration to send SIP data through.
...
messages. You need to already know what kind of transport (UDP/TCP/IPv4/etc) the endpoint device will use.
Info | ||
---|---|---|
| ||
Not specifying a transport will DEFAULT to select the first configured transport in |
...
If set to no
, res_pjsip will use the AVP or SAVP RTP profile for all media offers on outbound calls and media updates, but will accept either and will decline media offers not using the AVP /AVPF or SAVP /SAVPF RTP profile for all inbound media offers.
Anchor | ||||
---|---|---|---|---|
|
...
no
- res_pjsip will offer no encryption and allow no encryption to be setup.sdes
- res_pjsip will offer standard SRTP setup via in-SDP keys. Encrypted SIP transport should be used in conjunction with this option to prevent exposure of media encryption keys.dtls
- res_pjsip will offer DTLS-SRTP setup.
Anchor | ||||
---|---|---|---|---|
|
media_encryption_optimistic
This option only applies if media_encryption is set to sdes
or dtls
.
Anchor | ||||
---|---|---|---|---|
|
g726_non_standard
When set to "yes" and an endpoint negotiates g.726 audio then use g.726 for AAL2 packing order instead of what is recommended by RFC3551. Since this essentially replaces the underlying 'g726' codec with 'g726aal2' then 'g726aal2' needs to be specified in the endpoint's allowed codec list.
Anchor | ||||
---|---|---|---|---|
|
...
none
- No error correction should be used.fec
- Forward error correction should be used.redundancy
- Redundacy Redundancy error correction should be used.
...
This option can be set to send the session to the fax extension when a CNG tone is detected.
Anchor | ||||
---|---|---|---|---|
|
fax_detect_timeout
The option determines how many seconds into a call before the fax_detect option is disabled for the call. Setting the value to zero disables the timeout.
Anchor | ||||
---|---|---|---|---|
|
...
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 | ||||
---|---|---|---|---|
|
...
Many options for acceptable ciphers. See link for more:
http://www.openssl.org/docs/apps/ciphers.html#CIPHER\_STRINGS
...
active
- res_pjsip will make a connection to the peer.passive
- res_pjsip will accept connections from the peer.actpass
- res_pjsip will offer and accept connections from the peer.
Anchor | ||||
---|---|---|---|---|
|
dtls_fingerprint
This option only applies if media_encryption is set to dtls
.
SHA-256
SHA-1
Anchor | ||||
---|---|---|---|---|
|
...
If specified, any channel created for this endpoint will automatically have this accountcode set on it.
Anchor | ||||
---|---|---|---|---|
|
rtp_keepalive
At the specified interval, Asterisk will send an RTP comfort noise frame. This may be useful for situations where Asterisk is behind a NAT or firewall and must keep a hole open in order to allow for media to arrive at Asterisk.
Anchor | ||||
---|---|---|---|---|
|
rtp_timeout
This option configures the number of seconds without RTP (while off hold) before considering a channel as dead. When the number of seconds is reached the underlying channel is hung up. By default this option is set to 0, which means do not check.
Anchor | ||||
---|---|---|---|---|
|
rtp_timeout_hold
This option configures the number of seconds without RTP (while on hold) before considering a channel as dead. When the number of seconds is reached the underlying channel is hung up. By default this option is set to 0, which means do not check.
Anchor | ||||
---|---|---|---|---|
|
acl
This matches sections configured in acl.conf
. The value is defined as a list of comma-delimited section names.
Anchor | ||||
---|---|---|---|---|
|
deny
The value is a comma-delimited list of IP addresses. IP addresses may have a subnet mask appended. The subnet mask may be written in either CIDR or dotted-decimal notation. Separate the IP address and subnet mask with a slash ('/')
Anchor | ||||
---|---|---|---|---|
|
permit
The value is a comma-delimited list of IP addresses. IP addresses may have a subnet mask appended. The subnet mask may be written in either CIDR or dotted-decimal notation. Separate the IP address and subnet mask with a slash ('/')
Anchor | ||||
---|---|---|---|---|
|
contact_acl
This matches sections configured in acl.conf
. The value is defined as a list of comma-delimited section names.
Anchor | ||||
---|---|---|---|---|
|
contact_deny
The value is a comma-delimited list of IP addresses. IP addresses may have a subnet mask appended. The subnet mask may be written in either CIDR or dotted-decimal notation. Separate the IP address and subnet mask with a slash ('/')
Anchor | ||||
---|---|---|---|---|
|
contact_permit
The value is a comma-delimited list of IP addresses. IP addresses may have a subnet mask appended. The subnet mask may be written in either CIDR or dotted-decimal notation. Separate the IP address and subnet mask with a slash ('/')
Anchor | ||||
---|---|---|---|---|
|
subscribe_context
If specified, incoming SUBSCRIBE requests will be searched for the matching extension in the indicated context. If no subscribe_context is specified, then the context setting is used.
Anchor | ||||
---|---|---|---|---|
|
contact_user
On outbound requests, force the user portion of the Contact header to this value.
Anchor | ||||
---|---|---|---|---|
|
asymmetric_rtp_codec
When set to "yes" the codec in use for sending will be allowed to differ from that of the received one. PJSIP will not automatically switch the sending one to the receiving one.
Anchor | ||||
---|---|---|---|---|
|
rtcp_mux
With this option enabled, Asterisk will attempt to negotiate the use of the "rtcp-mux" attribute on all media streams. This will result in RTP and RTCP being sent and received on the same port. This shifts the demultiplexing logic to the application rather than the transport layer. This option is useful when interoperating with WebRTC endpoints since they mandate this option's use.
Anchor | ||||
---|---|---|---|---|
|
refer_blind_progress
Some SIP phones (Mitel/Aastra, Snom) expect a sip/frag "200 OK" after REFER has been accepted. If set to no
then asterisk will not send the progress details, but immediately will send "200 OK".
Anchor | ||||
---|---|---|---|---|
|
notify_early_inuse_ringing
Control whether dialog-info subscriptions get 'early' state on Ringing when already INUSE.
Anchor | ||||
---|---|---|---|---|
|
incoming_mwi_mailbox
If an MWI NOTIFY is received from this endpoint, this mailbox will be used when notifying other modules of MWI status changes. If not set, incoming MWI NOTIFYs are ignored.
Anchor | ||||
---|---|---|---|---|
|
follow_early_media_fork
On outgoing calls, if the UAS responds with different SDP attributes on subsequent 18X or 2XX responses (such as a port update) AND the To tag on the subsequent response is different than that on the previous one, follow it. This usually happens when the INVITE is forked to multiple UASs and more than one sends an SDP answer.
Info | ||
---|---|---|
| ||
This option must also be enabled in the |
Anchor | ||||
---|---|---|---|---|
|
accept_multiple_sdp_answers
On outgoing calls, if the UAS responds with different SDP attributes on non-100rel 18X or 2XX responses (such as a port update) AND the To tag on the subsequent response is the same as that on the previous one, process the updated SDP. This can happen when the UAS needs to change ports for some reason such as using a separate port for custom ringback.
Info | ||
---|---|---|
| ||
This option must also be enabled in the |
Anchor | ||||
---|---|---|---|---|
|
suppress_q850_reason_headers
Some devices can't accept multiple Reason headers and get confused when both 'SIP' and 'Q.850' Reason headers are received. This option allows the 'Q.850' Reason header to be suppressed.
Anchor | ||||
---|---|---|---|---|
|
ignore_183_without_sdp
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.
auth
Authentication type
Configuration Option Reference
Option Name | Type | Default Value | Regular Expression | Description |
---|---|---|---|---|
| | | Authentication type | |
| | | | Lifetime of a nonce associated with this authentication config. |
|
| | MD5 Hash used for authentication. | |
|
| | PlainText Plain text password used for authentication. | |
|
| | SIP realm for endpoint | |
| |
| | Must be 'auth' |
| |
| | Username to use for account |
...
Only used when auth_type is userpass
.
Anchor | ||||
---|---|---|---|---|
|
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 section'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.
Info | ||
---|---|---|
| ||
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. |
domain_alias
Domain Alias
Configuration Option Reference
...
Option Name | Type | Default Value | Regular Expression | Description |
---|---|---|---|---|
| | | | Number of simultaneous Asynchronous Operations |
| |
| | IP Address and optional port to bind to for this transport |
| |
| | File containing a list of certificates to read (TLS ONLY, not WSS) |
| |
| | Path to directory containing a list of certificates to read (TLS ONLY, not WSS) |
|
| | Certificate file for endpoint (TLS ONLY, not WSS) | |
|
| | Preferred Cryptography Cipher cryptography cipher names (TLS ONLY, not WSS) | |
| |
| | Domain the transport comes from |
|
| | External IP address to use in RTP handling | |
| |
| | External address for SIP signalling |
| | | | External port for SIP signalling |
|
| | Method of SSL transport (TLS ONLY, not WSS) | |
|
| | Network to consider local (used for NAT purposes). | |
| |
| | Password required for transport |
| |
| | Private key file (TLS ONLY, not WSS) |
| | | Protocol to use for SIP traffic | |
| |
| | Require client certificate (TLS ONLY, not WSS) |
| |
| | Must be of type 'transport'. |
| |
| | Require verification of client certificate (TLS ONLY, not WSS) |
| |
| | Require verification of server certificate (TLS ONLY, not WSS) |
| | | Enable TOS for the signalling sent over this transport | |
| | | Enable COS for the signalling sent over this transport | |
| | | The timeout (in milliseconds) to set on WebSocket connections. | |
| | | Allow this transport to be reloaded. | |
| | | Use the same transport for outgoing requests as incoming ones. |
Configuration Option Descriptions
Anchor | ||||
---|---|---|---|---|
|
cert_file
A path to a .crt or .pem file can be provided. However, only the certificate is read from the file, not the private key. The priv_key_file
option must supply a matching key file.
Anchor | ||||
---|---|---|---|---|
|
cipher
Many options for acceptable ciphers see Comma separated list of cipher names or numeric equivalents. Numeric equivalents can be either decimal or hexadecimal (0xX).
There are many cipher names. Use the CLI command pjsip list ciphers
to see a list of cipher names available for your installation. See link for more:
http://www.openssl.org/docs/apps/ciphers.html#CIPHER\_STRINGSSUITE\_NAMES
Anchor | ||||
---|---|---|---|---|
|
...
Anchor | ||||
---|---|---|---|---|
|
method
default
- The default as defined by PJSIP. This is currently TLSv1, but may change with future releases.unspecified
- This option is equivalent to setting 'default'tlsv1
tlsv1_1
tlsv1_2
sslv2
sslv3
sslv23
Anchor | ||||
---|---|---|---|---|
|
...
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 | ||||
---|---|---|---|---|
|
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 | ||||
---|---|---|---|---|
|
symmetric_transport
When a request from a dynamic contact comes in on a transport with this option set to 'yes', the transport name will be saved and used for subsequent outgoing requests like OPTIONS, NOTIFY and INVITE. It's saved as a contact uri parameter named 'x-ast-txp' and will display with the contact uri in CLI, AMI, and ARI output. On the outgoing request, if a transport wasn't explicitly set on the endpoint AND the request URI is not a hostname, the saved transport will be used and the 'x-ast-txp' parameter stripped from the outgoing packet.
contact
A way of creating an aliased name to a SIP URI
...
Option Name | Type | Default Value | Regular Expression | Description |
---|---|---|---|---|
| |
| | Must be of type 'contact'. |
| |
| | SIP URI to contact peer |
|
| | Time to keep alive a contact | |
| | | Interval at which to qualify a contact | |
| | | Timeout for qualify | |
| | | Authenticates a qualify challenge response if needed | |
|
| | Outbound proxy used when sending OPTIONS request | |
| |
| | Stored Path vector for use in Route headers on outgoing requests. |
|
| | User-Agent header from registration. | |
|
| | Endpoint name | |
|
| | Asterisk Server name | |
|
| | IP-address of the last Via header from registration. | |
| | | IP-port of the last Via header from registration. | |
|
| | Call-ID header from registration. | |
| | | A contact that cannot survive a restart/boot. |
Configuration Option Descriptions
...
Interval between attempts to qualify the contact for reachability. If 0
never qualify. Time in seconds.
Anchor | ||||
---|---|---|---|---|
|
qualify_timeout
If the contact doesn't respond to the OPTIONS request before the timeout, the contact is marked unavailable. If 0
no timeout. Time in fractional seconds.
Anchor | ||||
---|---|---|---|---|
|
authenticate_qualify
If true and a qualify request receives a challenge response then authentication is attempted before declaring the contact available.
Info | ||
---|---|---|
| ||
This option does nothing as we will always complete the challenge response authentication if the qualify request is challenged. |
Anchor | ||||
---|---|---|---|---|
|
...
The User-Agent is automatically stored based on data present in incoming SIP REGISTER requests and is not intended to be configured manually.
Anchor | ||||
---|---|---|---|---|
|
endpoint
The name of the endpoint this contact belongs to
Anchor | ||||
---|---|---|---|---|
|
reg_server
Asterisk Server name on which SIP endpoint registered.
Anchor | ||||
---|---|---|---|---|
|
via_addr
The last Via header should contain the address of UA which sent the request. The IP-address of the last Via header is automatically stored based on data present in incoming SIP REGISTER requests and is not intended to be configured manually.
Anchor | ||||
---|---|---|---|---|
|
via_port
The IP-port of the last Via header is automatically stored based on data present in incoming SIP REGISTER requests and is not intended to be configured manually.
Anchor | ||||
---|---|---|---|---|
|
call_id
The Call-ID header is automatically stored based on data present in incoming SIP REGISTER requests and is not intended to be configured manually.
Anchor | ||||
---|---|---|---|---|
|
prune_on_boot
The option is set if the incoming SIP REGISTER contact is rewritten on a reliable transport and is not intended to be configured manually.
aor
The configuration for a location of an endpoint
...
Option Name | Type | Default Value | Regular Expression | Description |
---|---|---|---|---|
|
| | Permanent contacts assigned to AoR | |
| | | | Default expiration time in seconds for contacts that are dynamically bound to an AoR. |
|
| | Allow subscriptions for the specified mailbox(es) | |
| |
| | The voicemail extension to send in the NOTIFY Message-Account header |
| | | Maximum time to keep an AoR | |
| | | Maximum number of contacts that can bind to an AoR | |
| | | Minimum keep alive time for an AoR | |
| | | Determines whether new contacts replace existing ones. | |
| |
| | Must be of type 'aor'. |
| | | Interval at which to qualify an AoR | |
| | | Timeout for qualify | |
| | | Authenticates a qualify request challenge response if needed | |
|
| | Outbound proxy used when sending OPTIONS request | |
| | | 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.
...
Anchor | ||||
---|---|---|---|---|
|
maximum_expiration
Maximium Maximum time to keep a peer with explicit expiration. Time in seconds.
...
Maximum number of contacts that can associate with this AoR. This value does not affect the number of contacts that can be added with the "contact" option. It only limits contacts added through external interaction, such as registration.
Info | ||
---|---|---|
| ||
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 can help by removing the soonest to expire contact(s) over max_contacts which is likely the old rewrite_contact contact source address being refreshed. |
Info | ||
---|---|---|
| ||
This should be set to |
...
Minimum time to keep a peer with an explict explicit expiration. Time in seconds.
...
On receiving a new registration to the AoR should it remove enough existing contacts not added or updated by the registration to satisfy max_contacts? Any removed contacts will expire the soonest.
Info | ||
---|---|---|
| ||
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 can help by removing the soonest to expire contact(s) over max_contacts which is likely the old rewrite_contact contact source address being refreshed. |
Info | ||
---|---|---|
| ||
This should be set to |
...
Interval between attempts to qualify the AoR for reachability. If 0
never qualify. Time in seconds.
Anchor | ||||
---|---|---|---|---|
|
qualify_timeout
If the contact doesn't respond to the OPTIONS request before the timeout, the contact is marked unavailable. If 0
no timeout. Time in fractional seconds.
Anchor | ||||
---|---|---|---|---|
|
authenticate_qualify
If true and a qualify request receives a challenge or authenticate response then authentication is attempted before declaring the contact available.
Info | ||
---|---|---|
| ||
This option does nothing as we will always complete the challenge response authentication if the qualify request is challenged. |
Anchor | ||||
---|---|---|---|---|
|
...
Option Name | Type | Default Value | Regular Expression | Description |
---|---|---|---|---|
| | | Set transaction timer T1 value (milliseconds). | |
| | | Set transaction timer B value (milliseconds). | |
| | | | Use the short forms of common SIP header names. |
| | | | Initial number of threads in the res_pjsip threadpool. |
| | | | The amount by which the number of threads is incremented when necessary. |
| | | | Number of seconds before an idle thread should be disposed of. |
| | | | Maximum number of threads in the res_pjsip threadpool. A value of 0 indicates no maximum. |
| | | Disable automatic switching from UDP to TCP transports. | |
| | | Follow SDP forked media when To tag is different | |
| | | Follow SDP forked media when To tag is the same | |
| | | Disable the use of rport in outgoing requests. | |
| |
| | Must be of type 'system' UNLESS the object name is 'system'. |
Configuration Option Descriptions
...
Timer B determines the maximum amount of time to wait after sending an INVITE request before terminating the transaction. It is recommended that this be set to 64 * Timer T1, but it may be set higher if desired. For more information on this timer, see RFC 3261, Section 17.1.1.1.
Anchor | ||||
---|---|---|---|---|
|
disable_tcp_switch
Disable automatic switching from UDP to TCP transports if outgoing request is too large. See RFC 3261 section 18.1.1.
Anchor | ||||
---|---|---|---|---|
|
follow_early_media_fork
On outgoing calls, if the UAS responds with different SDP attributes on subsequent 18X or 2XX responses (such as a port update) AND the To tag on the subsequent response is different than that on the previous one, follow it.
Info | ||
---|---|---|
| ||
This option must also be enabled on endpoints that require this functionality. |
Anchor | ||||
---|---|---|---|---|
|
accept_multiple_sdp_answers
On outgoing calls, if the UAS responds with different SDP attributes on non-100rel 18X or 2XX responses (such as a port update) AND the To tag on the subsequent response is the same as that on the previous one, process the updated SDP.
Info | ||
---|---|---|
| ||
This option must also be enabled on endpoints that require this functionality. |
Anchor | ||||
---|---|---|---|---|
|
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 |
---|---|---|---|---|
| | | | Value used in Max-Forwards header for SIP requests. |
| | | | The interval (in seconds) to send keepalives to active connection-oriented transports. |
| | | | The interval (in seconds) to check for expired contacts. |
| | | Disable Multi Domain support | |
| | | | 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. |
| | | The number of seconds over which to accumulate unidentified requests. | |
| | | The number of unidentified requests from a single IP to allow. | |
| | | | The interval at which unidentified requests are older than twice the unidentified_request_period are pruned. |
| |
| | Must be of type 'global' UNLESS the object name is 'global'. |
| | | | Value used in User-Agent header for SIP requests and Server header for SIP responses. |
| |
| | When set, Asterisk will dynamically create and destroy a NoOp priority 1 extension for a given peer who registers or unregisters with us. |
| | | | Endpoint to use when sending an outbound request to a URI without a specified endpoint. |
| |
| | The voicemail extension to send in the NOTIFY Message-Account header if not specified on endpoint or aor |
| | | | Enable/Disable SIP debug logging. Valid options include yes, no, or a host address |
| | | 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. | |
| | | | 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. |
| | | | 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 taskprocessor high water alert trigger level. | |
| | | MWI taskprocessor low water clear alert level. | |
| | | Enable/Disable sending unsolicited MWI to all endpoints on startup. | |
| | | Enable/Disable ignoring SIP URI user field options. | |
| | | Place caller-id information into Contact header | |
| | | | Enable sending AMI ContactStatus event when a device refreshes its registration. |
| | | Trigger scope for taskprocessor overloads | |
| | | | Advertise support for RFC4488 REFER subscription suppression |
Configuration Option Descriptions
Anchor | ||||
---|---|---|---|---|
|
disable_multi_domain
If disabled it can improve realtime performance by reducing the number of database requests.
Anchor | ||||
---|---|---|---|---|
|
unidentified_request_period
If unidentified_request_count
unidentified requests are received during unidentified_request_period
, a security event will be generated.
Anchor | ||||
---|---|---|---|---|
|
unidentified_request_count
If unidentified_request_count
unidentified requests are received during unidentified_request_period
, a security event will be generated.
Anchor | ||||
---|---|---|---|---|
|
endpoint_identifier_order
Info | ||
---|---|---|
| ||
One of the identifiers is "auth_username" which matches on the username in an Authentication header. This method has some security considerations because an Authentication header is not present on the first message of a dialog when digest authentication is used. The client can't generate it until the server sends the challenge in a 401 response. Since Asterisk normally sends a security event when an incoming request can't be matched to an endpoint, using auth_username requires that the security event be deferred until a request is received with the Authentication header and only generated if the username doesn't result in a match. This may result in a delay before an attack is recognized. You can control how many unmatched requests are received from a single ip address before a security event is generated using the unidentified_request parameters. |
Anchor | ||||
---|---|---|---|---|
|
mwi_tps_queue_high
On a heavily loaded system you may need to adjust the taskprocessor queue limits. If any taskprocessor queue size reaches its high water level then pjsip will stop processing new requests until the alert is cleared. The alert clears when all alerting taskprocessor queues have dropped to their low water clear level.
Anchor | ||||
---|---|---|---|---|
|
mwi_tps_queue_low
On a heavily loaded system you may need to adjust the taskprocessor queue limits. If any taskprocessor queue size reaches its high water level then pjsip will stop processing new requests until the alert is cleared. The alert clears when all alerting taskprocessor queues have dropped to their low water clear level.
Info | ||
---|---|---|
| ||
Set to -1 for the low water level to be 90% of the high water level. |
Anchor | ||||
---|---|---|---|---|
|
mwi_disable_initial_unsolicited
When the initial unsolicited MWI notification are enabled on startup then the initial notifications get sent at startup. If you have a lot of endpoints (thousands) that use unsolicited MWI then you may want to consider disabling the initial startup notifications.
When the initial unsolicited MWI notifications are disabled on startup then the notifications will start on the endpoint's next contact update.
Anchor | ||||
---|---|---|---|---|
|
ignore_uri_user_options
If you have this option enabled and there are semicolons in the user field of a SIP URI then the field is truncated at the first semicolon. This effectively makes the semicolon a non-usable character for PJSIP endpoint names, extensions, and AORs. This can be useful for improving compatibility with an ITSP that likes to use user options for whatever reason.
Code Block | ||||
---|---|---|---|---|
| ||||
sip:1235557890;[email protected];user=phone
|
Code Block | ||||
---|---|---|---|---|
| ||||
1235557890;phone-context=national
|
Code Block | ||||
---|---|---|---|---|
| ||||
1235557890
|
Info | ||
---|---|---|
| ||
The caller-id and redirecting number strings obtained from incoming SIP URI user fields are always truncated at the first semicolon. |
Anchor | ||||
---|---|---|---|---|
|
use_callerid_contact
This option will cause Asterisk to place caller-id information into generated Contact headers.
Anchor | ||||
---|---|---|---|---|
|
taskprocessor_overload_trigger
This option specifies the trigger the distributor will use for detecting taskprocessor overloads. When it detects an overload condition, the distrubutor will stop accepting new requests until the overload is cleared.
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.
Import Version
This documentation was imported from Asterisk Version SVNGIT-branch13-13-r423723.15.0-rc1-2825-g408d08a