Skip to end of metadata
Go to start of metadata

PJSIP_ENDPOINT()

Synopsis

Get information about a PJSIP endpoint

Description

Syntax

PJSIP_ENDPOINT(name,field)
Arguments
  • name - The name of the endpoint to query.
  • field - The configuration option for the endpoint to query for. Supported options are those fields on the endpoint object in pjsip.conf.
    • 100rel - Allow support for RFC3262 provisional ACK tags
    • aggregate_mwi -
    • allow - Media Codec(s) to allow
    • aors - AoR(s) to be used with the endpoint
    • auth - Authentication Object(s) associated with the endpoint
    • callerid - CallerID information for the endpoint
    • callerid_privacy - Default privacy level
    • callerid_tag - Internal id_tag for the endpoint
    • context - Dialplan context for inbound sessions
    • direct_media_glare_mitigation - Mitigation of direct media (re)INVITE glare
    • direct_media_method - Direct Media method type
    • connected_line_method - Connected line method type
    • direct_media - Determines whether media may flow directly between endpoints.
    • disable_direct_media_on_nat - Disable direct media session refreshes when NAT obstructs the media session
    • disallow - Media Codec(s) to disallow
    • dtmf_mode - DTMF mode
    • media_address - IP address used in SDP for media handling
    • force_rport - Force use of return port
    • ice_support - Enable the ICE mechanism to help traverse NAT
    • identify_by - Way(s) for Endpoint to be identified
    • redirect_method - How redirects received from an endpoint are handled
    • mailboxes - NOTIFY the endpoint when state changes for any of the specified mailboxes
    • moh_suggest - Default Music On Hold class
    • outbound_auth - Authentication object used for outbound requests
    • outbound_proxy - Proxy through which to send requests, a full SIP URI must be provided
    • rewrite_contact - Allow Contact header to be rewritten with the source IP address-port
    • rtp_ipv6 - Allow use of IPv6 for RTP traffic
    • rtp_symmetric - Enforce that RTP must be symmetric
    • send_diversion - Send the Diversion header, conveying the diversion information to the called user agent
    • send_pai - Send the P-Asserted-Identity header
    • send_rpid - Send the Remote-Party-ID header
    • timers_min_se - Minimum session timers expiration period
    • timers - Session timers for SIP packets
    • timers_sess_expires - Maximum session timer expiration period
    • transport - Desired transport configuration
    • trust_id_inbound - Accept identification information received from this endpoint
    • trust_id_outbound - Send private identification details to the endpoint.
    • type - Must be of type 'endpoint'.
    • use_ptime - Use Endpoint's requested packetisation interval
    • use_avpf - Determines whether res_pjsip will use and enforce usage of AVPF for this endpoint.
    • force_avp - 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 - Determines whether res_pjsip will use the media transport received in the offer SDP in the corresponding answer SDP.
    • media_encryption - Determines whether res_pjsip will use and enforce usage of media encryption for this endpoint.
    • inband_progress - Determines whether chan_pjsip will indicate ringing using inband progress.
    • call_group - The numeric pickup groups for a channel.
    • pickup_group - The numeric pickup groups that a channel can pickup.
    • named_call_group - The named pickup groups for a channel.
    • named_pickup_group - The named pickup groups that a channel can pickup.
    • device_state_busy_at - The number of in-use channels which will cause busy to be returned as device state
    • t38_udptl - Whether T.38 UDPTL support is enabled or not
    • t38_udptl_ec - T.38 UDPTL error correction method
    • t38_udptl_maxdatagram - T.38 UDPTL maximum datagram size
    • fax_detect - Whether CNG tone detection is enabled
    • t38_udptl_nat - Whether NAT support is enabled on UDPTL sessions
    • t38_udptl_ipv6 - Whether IPv6 is used for UDPTL Sessions
    • tone_zone - Set which country's indications to use for channels created for this endpoint.
    • language - Set the default language to use for channels created for this endpoint.
    • one_touch_recording - Determines whether one-touch recording is allowed for this endpoint.
    • record_on_feature - The feature to enact when one-touch recording is turned on.
    • record_off_feature - The feature to enact when one-touch recording is turned off.
    • rtp_engine - Name of the RTP engine to use for channels created for this endpoint
    • allow_transfer - Determines whether SIP REFER transfers are allowed for this endpoint
    • sdp_owner - String placed as the username portion of an SDP origin (o=) line.
    • sdp_session - String used for the SDP session (s=) line.
    • tos_audio - DSCP TOS bits for audio streams
    • tos_video - DSCP TOS bits for video streams
    • cos_audio - Priority for audio streams
    • cos_video - Priority for video streams
    • allow_subscribe - Determines if endpoint is allowed to initiate subscriptions with Asterisk.
    • sub_min_expiry - The minimum allowed expiry time for subscriptions initiated by the endpoint.
    • from_user - Username to use in From header for requests to this endpoint.
    • mwi_from_user - Username to use in From header for unsolicited MWI NOTIFYs to this endpoint.
    • from_domain - Domain to user in From header for requests to this endpoint.
    • dtls_verify - Verify that the provided peer certificate is valid
    • dtls_rekey - Interval at which to renegotiate the TLS session and rekey the SRTP session
    • dtls_cert_file - Path to certificate file to present to peer
    • dtls_private_key - Path to private key for certificate file
    • dtls_cipher - Cipher to use for DTLS negotiation
    • dtls_ca_file - Path to certificate authority certificate
    • dtls_ca_path - Path to a directory containing certificate authority certificates
    • dtls_setup - Whether we are willing to accept connections, connect to the other party, or both.
    • dtls_fingerprint - Type of hash to use for the DTLS fingerprint in the SDP.
    • srtp_tag_32 - Determines whether 32 byte tags should be used instead of 80 byte tags.
    • set_var - Variable set on a channel involving the endpoint.
    • message_context - Context to route incoming MESSAGE requests to.
    • accountcode - An accountcode to set automatically on any channels created for this endpoint.

See Also

Import Version

This documentation was imported from Asterisk Version SVN-branch-12-r424312

  • No labels