CHANNEL()

Synopsis

Gets/sets various pieces of information about the channel.

Description

Gets/sets various pieces of information about the channel, additional item may be available from the channel driver; see its documentation for details. Any item requested that is not available on the current channel will return an empty string.

Syntax

CHANNEL(item)

Arguments

item - Standard items (provided by all channel technologies) are:
- amaflags - R/W the Automatic Message Accounting (AMA) flags on the channel. When read from a channel, the integer value will always be returned. When written to a channel, both the string format or integer value is accepted.
  - 1 - OMIT
  - 2 - BILLING
  - 3 - DOCUMENTATION
- accountcode - R/W the channel's account code.
- audioreadformat - R/O format currently being read.
- audionativeformat - R/O format used natively for audio.
- audiowriteformat - R/O format currently being written.
- dtmf_features - R/W The channel's DTMF bridge features. May include one or more of 'T' 'K' 'H' 'W' and 'X' in a similar manner to options in the Dial application. When setting it, the features string must be all upper case.
- callgroup - R/W numeric call pickup groups that this channel is a member.
- pickupgroup - R/W numeric call pickup groups this channel can pickup.
- namedcallgroup - R/W named call pickup groups that this channel is a member.
- namedpickupgroup - R/W named call pickup groups this channel can pickup.
- channeltype - R/O technology used for channel.
- checkhangup - R/O Whether the channel is hanging up (1/0)
- after_bridge_goto - R/W the parseable goto string indicating where the channel is expected to return to in the PBX after exiting the next bridge it joins on the condition that it doesn't hang up. The parseable goto string uses the same syntax as the Goto application.
- hangup_handler_pop - W/O Replace the most recently added hangup handler with a new hangup handler on the channel if supplied. The assigned string is passed to the Gosub application when the channel is hung up. Any optionally omitted context and exten are supplied by the channel pushing the handler before it is pushed.
- hangup_handler_push - W/O Push a hangup handler onto the channel hangup handler stack. The assigned string is passed to the Gosub application when the channel is hung up. Any optionally omitted context and exten are supplied by the channel pushing the handler before it is pushed.
- hangup_handler_wipe - W/O Wipe the entire hangup handler stack and replace with a new hangup handler on the channel if supplied. The assigned string is passed to the Gosub application when the channel is hung up. Any optionally omitted context and exten are supplied by the channel pushing the handler before it is pushed.
- language - R/W language for sounds played.
- musicclass - R/W class (from musiconhold.conf) for hold music.
- name - The name of the channel
- parkinglot - R/W parkinglot for parking.
- rxgain - R/W set rxgain level on channel drivers that support it.
- secure_bridge_signaling - Whether or not channels bridged to this channel require secure signaling
- secure_bridge_media - Whether or not channels bridged to this channel require secure media
- state - R/O state for channel
- tonezone - R/W zone for indications played
- transfercapability - R/W ISDN Transfer Capability, one of:
  - SPEECH
  - DIGITAL
  - RESTRICTED_DIGITAL
  - 3K1AUDIO
  - DIGITAL_W_TONES
  - VIDEO
- txgain - R/W set txgain level on channel drivers that support it.
- videonativeformat - R/O format used natively for video
- trace - R/W whether or not context tracing is enabled, only available if CHANNEL_TRACE is defined.
  chan_sip provides the following additional options:
- peerip - R/O Get the IP address of the peer.
- recvip - R/O Get the source IP address of the peer.
- recvport - R/O Get the source port of the peer.
- from - R/O Get the URI from the From: header.
- uri - R/O Get the URI from the Contact: header.
- useragent - R/O Get the useragent.
- peername - R/O Get the name of the peer.
- t38passthrough - R/O 1 if T38 is offered or enabled in this channel, otherwise 0
- rtpqos - R/O Get QOS information about the RTP stream
  This option takes two additional arguments:
  Argument 1:
  audio Get data about the audio stream
  video Get data about the video stream
  text Get data about the text stream
  Argument 2:
  local_ssrc Local SSRC (stream ID)
  local_lostpackets Local lost packets
  local_jitter Local calculated jitter
  local_maxjitter Local calculated jitter (maximum)
  local_minjitter Local calculated jitter (minimum)
  {{local_normdevjitter}}Local calculated jitter (normal deviation)
  local_stdevjitter Local calculated jitter (standard deviation)
  local_count Number of received packets
  remote_ssrc Remote SSRC (stream ID)
  {{remote_lostpackets}}Remote lost packets
  remote_jitter Remote reported jitter
  remote_maxjitter Remote calculated jitter (maximum)
  remote_minjitter Remote calculated jitter (minimum)
  {{remote_normdevjitter}}Remote calculated jitter (normal deviation)
  {{remote_stdevjitter}}Remote calculated jitter (standard deviation)
  remote_count Number of transmitted packets
  rtt Round trip time
  maxrtt Round trip time (maximum)
  minrtt Round trip time (minimum)
  normdevrtt Round trip time (normal deviation)
  stdevrtt Round trip time (standard deviation)
  all All statistics (in a form suited to logging, but not for parsing)
- rtpdest - R/O Get remote RTP destination information.
  This option takes one additional argument:
  Argument 1:
  audio Get audio destination
  video Get video destination
  text Get text destination
  Defaults to audio if unspecified.
- rtpsource - R/O Get source RTP destination information.
  This option takes one additional argument:
  Argument 1:
  audio Get audio destination
  video Get video destination
  text Get text destination
  Defaults to audio if unspecified.
- Technology: PJSIP
  - rtp - R/O Retrieve media related information.
    - type - When rtp is specified, the type parameter must be provided. It specifies which RTP parameter to read.
      - src - Retrieve the local address for RTP.
      - dest - Retrieve the remote address for RTP.
      - direct - If direct media is enabled, this address is the remote address used for RTP.
      - secure - Whether or not the media stream is encrypted.
        
        0 - The media stream is not encrypted.
        
        1 - The media stream is encrypted.
      - hold - Whether or not the media stream is currently restricted due to a call hold.
        
        0 - The media stream is not held.
        
        1 - The media stream is held.
    - media_type - When rtp is specified, the media_type parameter may be provided. It specifies which media stream the chosen RTP parameter should be retrieved from.
      - audio - Retrieve information from the audio media stream.
        
        Note
        Icon
        
        If not specified, audio is used by default.
      - video - Retrieve information from the video media stream.
  - rtcp - R/O Retrieve RTCP statistics.
    - statistic - When rtcp is specified, the statistic parameter must be provided. It specifies which RTCP statistic parameter to read.
      - all - Retrieve a summary of all RTCP statistics.
        The following data items are returned in a semi-colon delineated list:
        
        ssrc - Our Synchronization Source identifier
        
        themssrc - Their Synchronization Source identifier
        
        lp - Our lost packet count
        
        rxjitter - Received packet jitter
        
        rxcount - Received packet count
        
        txjitter - Transmitted packet jitter
        
        txcount - Transmitted packet count
        
        rlp - Remote lost packet count
        
        rtt - Round trip time
      - all_jitter - Retrieve a summary of all RTCP Jitter statistics.
        The following data items are returned in a semi-colon delineated list:
        
        minrxjitter - Our minimum jitter
        
        maxrxjitter - Our max jitter
        
        avgrxjitter - Our average jitter
        
        stdevrxjitter - Our jitter standard deviation
        
        reported_minjitter - Their minimum jitter
        
        reported_maxjitter - Their max jitter
        
        reported_avgjitter - Their average jitter
        
        reported_stdevjitter - Their jitter standard deviation
      - all_loss - Retrieve a summary of all RTCP packet loss statistics.
        The following data items are returned in a semi-colon delineated list:
        
        minrxlost - Our minimum lost packets
        
        maxrxlost - Our max lost packets
        
        avgrxlost - Our average lost packets
        
        stdevrxlost - Our lost packets standard deviation
        
        reported_minlost - Their minimum lost packets
        
        reported_maxlost - Their max lost packets
        
        reported_avglost - Their average lost packets
        
        reported_stdevlost - Their lost packets standard deviation
      - all_rtt - Retrieve a summary of all RTCP round trip time information.
        The following data items are returned in a semi-colon delineated list:
        
        minrtt - Minimum round trip time
        
        maxrtt - Maximum round trip time
        
        avgrtt - Average round trip time
        
        stdevrtt - Standard deviation round trip time
      - txcount - Transmitted packet count
      - rxcount - Received packet count
      - txjitter - Transmitted packet jitter
      - rxjitter - Received packet jitter
      - remote_maxjitter - Their max jitter
      - remote_minjitter - Their minimum jitter
      - remote_normdevjitter - Their average jitter
      - remote_stdevjitter - Their jitter standard deviation
      - local_maxjitter - Our max jitter
      - local_minjitter - Our minimum jitter
      - local_normdevjitter - Our average jitter
      - local_stdevjitter - Our jitter standard deviation
      - txploss - Transmitted packet loss
      - rxploss - Received packet loss
      - remote_maxrxploss - Their max lost packets
      - remote_minrxploss - Their minimum lost packets
      - remote_normdevrxploss - Their average lost packets
      - remote_stdevrxploss - Their lost packets standard deviation
      - local_maxrxploss - Our max lost packets
      - local_minrxploss - Our minimum lost packets
      - local_normdevrxploss - Our average lost packets
      - local_stdevrxploss - Our lost packets standard deviation
      - rtt - Round trip time
      - maxrtt - Maximum round trip time
      - minrtt - Minimum round trip time
      - normdevrtt - Average round trip time
      - stdevrtt - Standard deviation round trip time
      - local_ssrc - Our Synchronization Source identifier
      - remote_ssrc - Their Synchronization Source identifier
    - media_type - When rtcp is specified, the media_type parameter may be provided. It specifies which media stream the chosen RTCP parameter should be retrieved from.
      - audio - Retrieve information from the audio media stream.
        
        Note
        Icon
        
        If not specified, audio is used by default.
      - video - Retrieve information from the video media stream.
  - endpoint - R/O The name of the endpoint associated with this channel. Use the PJSIP_ENDPOINT function to obtain further endpoint related information.
  - pjsip - R/O Obtain information about the current PJSIP channel and its session.
    - type - When pjsip is specified, the type parameter must be provided. It specifies which signalling parameter to read.
      - secure - Whether or not the signalling uses a secure transport.
        
        0 - The signalling uses a non-secure transport.
        
        1 - The signalling uses a secure transport.
      - target_uri - The request URI of the INVITE request associated with the creation of this channel.
      - local_uri - The local URI.
      - remote_uri - The remote URI.
      - t38state - The current state of any T.38 fax on this channel.
        
        DISABLED - T.38 faxing is disabled on this channel.
        
        LOCAL_REINVITE - Asterisk has sent a re-INVITE to the remote end to initiate a T.38 fax.
        
        REMOTE_REINVITE - The remote end has sent a re-INVITE to Asterisk to initiate a T.38 fax.
        
        ENABLED - A T.38 fax session has been enabled.
        
        REJECTED - A T.38 fax session was attempted but was rejected.
      - local_addr - On inbound calls, the full IP address and port number that the INVITE request was received on. On outbound calls, the full IP address and port number that the INVITE request was transmitted from.
      - remote_addr - On inbound calls, the full IP address and port number that the INVITE request was received from. On outbound calls, the full IP address and port number that the INVITE request was transmitted to.
        chan_iax2 provides the following additional options:
- osptoken - R/O Get the peer's osptoken.
- peerip - R/O Get the peer's ip address.
- peername - R/O Get the peer's username.
- secure_signaling - R/O Get the if the IAX channel is secured.
- secure_media - R/O Get the if the IAX channel is secured.
  chan_dahdi provides the following additional options:
- dahdi_channel - R/O DAHDI channel related to this channel.
- dahdi_span - R/O DAHDI span related to this channel.
- dahdi_type - R/O DAHDI channel type, one of:
  - analog
  - mfc/r2
  - pri
  - pseudo
  - ss7
- keypad_digits - R/O PRI Keypad digits that came in with the SETUP message.
- reversecharge - R/O PRI Reverse Charging Indication, one of:
  - -1 - None
  - {{ 1}} - Reverse Charging Requested
- no_media_path - R/O PRI Nonzero if the channel has no B channel. The channel is either on hold or a call waiting call.
- buffers - W/O Change the channel's buffer policy (for the current call only)
  This option takes two arguments:
  Number of buffers,
  Buffer policy being one of:
  full
  immediate
  half
- echocan_mode - W/O Change the configuration of the active echo canceller on the channel (if any), for the current call only.
  Possible values are:
  {{on}}Normal mode (the echo canceller is actually reinitalized)
  {{off}}Disabled
  {{fax}}FAX/data mode (NLP disabled if possible, otherwise completely disabled)
  {{voice}}Voice mode (returns from FAX mode, reverting the changes that were made)
  chan_ooh323 provides the following additional options:
- faxdetect - R/W Fax Detect
  Returns 0 or 1
  Write yes or no
- t38support - R/W t38support
  Returns 0 or 1
  Write yes or no
- h323id_url - R/0 Returns caller URL
- caller_h323id - R/0 Returns caller h323id
- caller_dialeddigits - R/0 Returns caller dialed digits
- caller_email - R/0 Returns caller email
- callee_email - R/0 Returns callee email
- callee_dialeddigits - R/0 Returns callee dialed digits
- caller_url - R/0 Returns caller URL

Import Version

This documentation was imported from Asterisk Version SVN-branch-13-r420538

Asterisk Project : Asterisk 13 Function_CHANNEL