                                                       Inter-Asterisk eXchange (IAX) Parameters

   Created
           2008-12-03

   Last Updated
           2009-02-24

   This registry is also available in XML and plain text formats.

   Registries included below

     * IAX Meta Commands
     * IAX Frame Types
     * IAX Control Frame Subclass
     * IAX Control Frames
     * IAX HTML Command Subclasses
     * IAX Information Elements
     * IAX Authentication Methods
     * IAX Dialplan Status Flags
     * IAX Calling Presentation
     * IAX Calling Type of Number
     * IAX Transit Network Identification Plan
     * IAX Type of Network
     * IAX Cause Codes
     * IAX Encryption Methods
     * IAX Media Formats

IAX Meta Commands

   Reference
           [RFC-guy-iaxiana-00]

   Registration Procedures
           Expert Review

     Value         Name                       Description                      Reference
     0x01    Trunk Meta Frame Indicates that frame is a trunk meta frame. [RFC-guy-iaxiana-00]
   0x02-0x7F Unassigned

IAX Frame Types

   Reference
           [RFC-guy-iaxiana-00]

   Registration Procedures
           Expert Review

     Type     Description       Subclass Description         Data Description        Reference
     0x01    DTMF          0-9, A-D, *, #                  Undefined            [RFC-guy-iaxiana-00]
     0x02    Voice         Audio Compression Format        Data                 [RFC-guy-iaxiana-00]
     0x03    Video         Video Compression Format        Data                 [RFC-guy-iaxiana-00]
     0x04    Control       See Control Frame Subclass      Varies with subclass [RFC-guy-iaxiana-00]
     0x05    Null          Undefined                       Undefined            [RFC-guy-iaxiana-00]
     0x06    IAX Control   See IAX Protocol Messages       Information Elements [RFC-guy-iaxiana-00]
     0x07    Text          Always 0                        Raw Text             [RFC-guy-iaxiana-00]
     0x08    Image         Image Compression Format        Raw Image            [RFC-guy-iaxiana-00]
     0x09    HTML          See HTML Frame Types            Message Specific     [RFC-guy-iaxiana-00]
     0x0A    Comfort Noise Level in -dBov of comfort noise None                 [RFC-guy-iaxiana-00]
   0x0B-0xFF Unassigned

IAX Control Frame Subclass

   Reference
           [RFC-guy-iaxiana-00]

   Registration Procedures
           Expert Review

     Value        Name                        Description                       Reference
     0x01    Hangup          The call has been hungup at the remote end    [RFC-guy-iaxiana-00]
     0x02    Reserved        Reserved for future use                       [RFC-guy-iaxiana-00]
     0x03    Ringing         Remote end is ringing (ringback)              [RFC-guy-iaxiana-00]
     0x04    Answer          Remote end has answered                       [RFC-guy-iaxiana-00]
     0x05    Busy            Remote end is busy                            [RFC-guy-iaxiana-00]
     0x06    Reserved        Reserved for future use                       [RFC-guy-iaxiana-00]
     0x07    Reserved        Reserved for future use                       [RFC-guy-iaxiana-00]
     0x08    Congestion      The call is congested                         [RFC-guy-iaxiana-00]
     0x09    Flash Hook      Flash hook                                    [RFC-guy-iaxiana-00]
     0x0A    Reserved        Reserved for future use                       [RFC-guy-iaxiana-00]
     0x0B    Option          Device-specific options are being transmitted [RFC-guy-iaxiana-00]
     0x0C    Key Radio       Key Radio                                     [RFC-guy-iaxiana-00]
     0x0D    Unkey Radio     Unkey Radio                                   [RFC-guy-iaxiana-00]
     0x0E    Call Progress   Call is in progress                           [RFC-guy-iaxiana-00]
     0x0F    Call Proceeding Call is proceeding                            [RFC-guy-iaxiana-00]
     0x10    Hold            Call is placed on hold                        [RFC-guy-iaxiana-00]
     0x11    Unhold          Call is taken off hold                        [RFC-guy-iaxiana-00]
   0x12-0x7F Unassigned

IAX Control Frames

   Reference
           [RFC-guy-iaxiana-00]

   Registration Procedures
           Expert Review

     Value      Name                  Description                    Reference
     0x01    NEW        Initiate a new call                     [RFC-guy-iaxiana-00]
     0x02    PING       Ping request                            [RFC-guy-iaxiana-00]
     0x03    PONG       Ping or poke reply                      [RFC-guy-iaxiana-00]
     0x04    ACK        Explicit acknowledgment                 [RFC-guy-iaxiana-00]
     0x05    HANGUP     Initiate call tear-down                 [RFC-guy-iaxiana-00]
     0x06    REJECT     Reject a call                           [RFC-guy-iaxiana-00]
     0x07    ACCEPT     Accept a call                           [RFC-guy-iaxiana-00]
     0x08    AUTHREQ    Authentication request                  [RFC-guy-iaxiana-00]
     0x09    AUTHREP    Authentication reply                    [RFC-guy-iaxiana-00]
     0x0A    INVAL      Invalid message                         [RFC-guy-iaxiana-00]
     0x0B    LAGRQ      Lag request                             [RFC-guy-iaxiana-00]
     0x0C    LAGRP      Lag reply                               [RFC-guy-iaxiana-00]
     0x0D    REGREQ     Registration request                    [RFC-guy-iaxiana-00]
     0x0E    REGAUTH    Registration authentication             [RFC-guy-iaxiana-00]
     0x0F    REGACK     Registration acknowledgement            [RFC-guy-iaxiana-00]
     0x10    REGREJ     Registration reject                     [RFC-guy-iaxiana-00]
     0x11    REGREL     Registration release                    [RFC-guy-iaxiana-00]
     0x12    VNAK       Video/Voice retransmit request          [RFC-guy-iaxiana-00]
     0x13    DPREQ      Dialplan request                        [RFC-guy-iaxiana-00]
     0x14    DPREP      Dialplan reply                          [RFC-guy-iaxiana-00]
     0x15    DIAL       Dial                                    [RFC-guy-iaxiana-00]
     0x16    TXREQ      Transfer request                        [RFC-guy-iaxiana-00]
     0x17    TXCNT      Transfer connect                        [RFC-guy-iaxiana-00]
     0x18    TXACC      Transfer accept                         [RFC-guy-iaxiana-00]
     0x19    TXREADY    Transfer ready                          [RFC-guy-iaxiana-00]
     0x1A    TXREL      Transfer release                        [RFC-guy-iaxiana-00]
     0x1B    TXREJ      Transfer reject                         [RFC-guy-iaxiana-00]
     0x1C    QUELCH     Halt audio/video [media] transmission   [RFC-guy-iaxiana-00]
     0x1D    UNQUELCH   Resume audio/video [media] transmission [RFC-guy-iaxiana-00]
     0x1E    POKE       Poke request                            [RFC-guy-iaxiana-00]
     0x1F    Reserved   Reserved for future use                 [RFC-guy-iaxiana-00]
     0x20    MWI        Message waiting indication              [RFC-guy-iaxiana-00]
     0x21    UNSUPPORT  Unsupported message                     [RFC-guy-iaxiana-00]
     0x22    TRANSFER   Remote transfer request                 [RFC-guy-iaxiana-00]
     0x23    Reserved   Reserved for future use                 [RFC-guy-iaxiana-00]
     0x24    Reserved   Reserved for future use                 [RFC-guy-iaxiana-00]
     0x25    Reserved   Reserved for future use                 [RFC-guy-iaxiana-00]
   0x26-0x7F Unassigned

IAX HTML Command Subclasses

   Reference
           [RFC-guy-iaxiana-00]

   Registration Procedures
           Expert Review

     Value          Description              Reference
     0x01    Sending a URL              [RFC-guy-iaxiana-00]
     0x02    Data frame                 [RFC-guy-iaxiana-00]
     0x03    Unassigned
     0x04    Beginning frame            [RFC-guy-iaxiana-00]
   0x05-0x07 Unassigned
     0x08    End frame                  [RFC-guy-iaxiana-00]
   0x09-0x0F Unassigned
     0x10    Load is complete           [RFC-guy-iaxiana-00]
     0x11    Peer does not support HTML [RFC-guy-iaxiana-00]
     0x12    Link URL                   [RFC-guy-iaxiana-00]
     0x13    Unlink URL                 [RFC-guy-iaxiana-00]
     0x14    Reject Link URL            [RFC-guy-iaxiana-00]
   0x15-0x7F Unassigned

IAX Information Elements

   Reference
           [RFC-guy-iaxiana-00]

   Registration Procedures
           Expert Review

     Value        Name                      Description                       Reference
     0x01    CALLED NUMBER  Number/extension being called                [RFC-guy-iaxiana-00]
     0x02    CALLING NUMBER Calling number                               [RFC-guy-iaxiana-00]
     0x03    CALLING ANI    Calling number ANI for billing               [RFC-guy-iaxiana-00]
     0x04    CALLING NAME   Name of caller                               [RFC-guy-iaxiana-00]
     0x05    CALLED CONTEXT Context for number                           [RFC-guy-iaxiana-00]
     0x06    USERNAME       Username (peer or user) for authentication   [RFC-guy-iaxiana-00]
     0x07    PASSWORD       Password for authentication                  [RFC-guy-iaxiana-00]
     0x08    CAPABILITY     Actual CODEC capability                      [RFC-guy-iaxiana-00]
     0x09    FORMAT         Desired CODEC format                         [RFC-guy-iaxiana-00]
     0x0A    LANGUAGE       Desired language                             [RFC-guy-iaxiana-00]
     0x0B    VERSION        Protocol version                             [RFC-guy-iaxiana-00]
     0x0C    ADSICPE        CPE ADSI capability                          [RFC-guy-iaxiana-00]
     0x0D    DNID           Originally dialed DNID                       [RFC-guy-iaxiana-00]
     0x0E    AUTHMETHODS    Authentication method(s)                     [RFC-guy-iaxiana-00]
     0x0F    CHALLENGE      Challenge data for MD5/RSA                   [RFC-guy-iaxiana-00]
     0x10    MD5 RESULT     MD5 challenge result                         [RFC-guy-iaxiana-00]
     0x11    RSA RESULT     RSA challenge result                         [RFC-guy-iaxiana-00]
     0x12    APPARENT ADDR  Apparent address of peer                     [RFC-guy-iaxiana-00]
     0x13    REFRESH        When to refresh registration                 [RFC-guy-iaxiana-00]
     0x14    DPSTATUS       Dialplan status                              [RFC-guy-iaxiana-00]
     0x15    CALLNO         Call number of peer                          [RFC-guy-iaxiana-00]
     0x16    CAUSE          Cause                                        [RFC-guy-iaxiana-00]
     0x17    IAX UNKNOWN    Unknown IAX command                          [RFC-guy-iaxiana-00]
     0x18    MSGCOUNT       How many messages waiting                    [RFC-guy-iaxiana-00]
     0x19    AUTOANSWER     Request auto-answering                       [RFC-guy-iaxiana-00]
     0x1A    MUSICONHOLD    Request musiconhold with QUELCH              [RFC-guy-iaxiana-00]
     0x1B    TRANSFERID     Transfer Request Identifier                  [RFC-guy-iaxiana-00]
     0x1C    RDNIS          Referring DNIS                               [RFC-guy-iaxiana-00]
     0x1D    Reserved       Reserved for future use                      [RFC-guy-iaxiana-00]
     0x1E    Reserved       Reserved for future use                      [RFC-guy-iaxiana-00]
     0x1F    DATETIME       Date/Time                                    [RFC-guy-iaxiana-00]
     0x20    Reserved       Reserved for future use                      [RFC-guy-iaxiana-00]
     0x21    Reserved       Reserved for future use                      [RFC-guy-iaxiana-00]
     0x22    Reserved       Reserved for future use                      [RFC-guy-iaxiana-00]
     0x23    Reserved       Reserved for future use                      [RFC-guy-iaxiana-00]
     0x24    Reserved       Reserved for future use                      [RFC-guy-iaxiana-00]
     0x25    Reserved       Reserved for future use                      [RFC-guy-iaxiana-00]
     0x26    CALLINGPRES    Calling presentation                         [RFC-guy-iaxiana-00]
     0x27    CALLINGTON     Calling type of number                       [RFC-guy-iaxiana-00]
     0x28    CALLINGTNS     Calling transit network select               [RFC-guy-iaxiana-00]
     0x29    SAMPLINGRATE   Supported sampling rates                     [RFC-guy-iaxiana-00]
     0x2A    CAUSECODE      Hangup cause                                 [RFC-guy-iaxiana-00]
     0x2B    ENCRYPTION     Encryption format                            [RFC-guy-iaxiana-00]
     0x2C    ENCKEY         Reserved for future use                      [RFC-guy-iaxiana-00]
     0x2D    CODEC PREFS    CODEC Negotiation                            [RFC-guy-iaxiana-00]
     0x2E    RR JITTER      Received jitter, as in [RFC3550]             [RFC-guy-iaxiana-00]
     0x2F    RR LOSS        Received loss, as in [RFC3550]               [RFC-guy-iaxiana-00]
     0x30    RR PKTS        Received frames                              [RFC-guy-iaxiana-00]
     0x31    RR DELAY       Max playout delay for received frames in ms  [RFC-guy-iaxiana-00]
     0x32    RR DROPPED     Dropped frames (presumably by jitter buffer) [RFC-guy-iaxiana-00]
     0x33    RR OOO         Frames received Out of Order                 [RFC-guy-iaxiana-00]
     0x34    OSPTOKEN       OSP Token Block                              [RFC-guy-iaxiana-00]
   0x35-0xFF Unassigned

IAX Authentication Methods

   Reference
           [RFC-guy-iaxiana-00]

   Note

 values must be power of two

   Registration Procedures
           Expert Review

      Method           Description             Reference
      0x0001     Reserved (was Plaintext) [RFC-guy-iaxiana-00]
      0x0002     MD5                      [RFC-guy-iaxiana-00]
      0x0003     Unassigned
      0x0004     RSA                      [RFC-guy-iaxiana-00]
   0x0004-0xFFFF Unassigned

IAX Dialplan Status Flags

   Reference
           [RFC-guy-iaxiana-00]

   Note

 values must be power of two

   Registration Procedures
           Expert Review

       Flag              Description               Reference
      0x0001     Exists                       [RFC-guy-iaxiana-00]
      0x0002     Can exist                    [RFC-guy-iaxiana-00]
      0x0003     Unassigned
      0x0004     Non-existent                 [RFC-guy-iaxiana-00]
   0x0005-0x3FFF Unassigned
      0x4000     Retain dialtone (ignorepat)  [RFC-guy-iaxiana-00]
   0x4001-0x7FFF Unassigned
      0x8000     More digits may match number [RFC-guy-iaxiana-00]
   0x8001-0xFFFF Unassigned

IAX Calling Presentation

   Reference
           [RFC-guy-iaxiana-00]

   Registration Procedures
           Expert Review

     Flag                Presentation                  Reference
     0x00    Allowed user/number not screened     [RFC-guy-iaxiana-00]
     0x01    Allowed user/number passed screen    [RFC-guy-iaxiana-00]
     0x02    Allowed user/number failed screen    [RFC-guy-iaxiana-00]
     0x03    Allowed network number               [RFC-guy-iaxiana-00]
   0x04-0x1A Unassigned
     0x020   Prohibited user/number not screened  [RFC-guy-iaxiana-00]
     0x021   Prohibited user/number passed screen [RFC-guy-iaxiana-00]
     0x022   Prohibited user/number failed screen [RFC-guy-iaxiana-00]
     0x023   Prohibited network number            [RFC-guy-iaxiana-00]
   0x24-0x42 Unassigned
     0x043   Number not available                 [RFC-guy-iaxiana-00]
   0x44-0xFF Unassigned

IAX Calling Type of Number

   Reference
           [RFC-guy-iaxiana-00]

   Registration Procedures
           Expert Review

     Value         Description            Reference
     0x00    Unknown                 [RFC-guy-iaxiana-00]
   0x01-0x0F Unassigned
     0x10    International Number    [RFC-guy-iaxiana-00]
   0x11-0x1F Unassigned
     0x20    National Number         [RFC-guy-iaxiana-00]
   0x21-0x2F Unassigned
     0x30    Network Specific Number [RFC-guy-iaxiana-00]
   0x31-0x3F Unassigned
     0x40    Subscriber Number       [RFC-guy-iaxiana-00]
   0x41-0x5F Unassigned
     0x60    Abbreviated Number      [RFC-guy-iaxiana-00]
   0x61-0x6F Unassigned
     0x70    Reserved for extension  [RFC-guy-iaxiana-00]
   0x71-0xFF Unassigned

IAX Transit Network Identification Plan

   Reference
           [RFC-guy-iaxiana-00]

   Registration Procedures
           Expert Review

     Bits              Description                 Reference
     0000    Unknown                          [RFC-guy-iaxiana-00]
     0001    Caller Identification Code       [RFC-guy-iaxiana-00]
     0010    Unassigned
     0011    Data Network Identification Code [RFC-guy-iaxiana-00]
   0100-1111 Unassigned

IAX Type of Network

   Reference
           [RFC-guy-iaxiana-00]

   Registration Procedures
           Expert Review

    Bits               Description                   Reference
     000   User Specified                       [RFC-guy-iaxiana-00]
     001   Unassigned
     010   National Network Identification      [RFC-guy-iaxiana-00]
     011   International Network Identification [RFC-guy-iaxiana-00]
   100-111 Unassigned

IAX Cause Codes

   Reference
           [RFC-guy-iaxiana-00]

   Registration Procedures
           Expert Review

   Number                                       Cause                                           Reference
      1    Unassigned/unallocated number                                                   [RFC-guy-iaxiana-00]
      2    No route to specified transit network                                           [RFC-guy-iaxiana-00]
      3    No route to specified transit network                                           [RFC-guy-iaxiana-00]
     4-5   Unassigned
      6    Channel unacceptable                                                            [RFC-guy-iaxiana-00]
      7    Call awarded and delivered                                                      [RFC-guy-iaxiana-00]
    8-15   Unassigned
     16    Normal call clearing                                                            [RFC-guy-iaxiana-00]
     17    User busy                                                                       [RFC-guy-iaxiana-00]
     18    No user response                                                                [RFC-guy-iaxiana-00]
     19    No answer                                                                       [RFC-guy-iaxiana-00]
     20    Unassigned
     21    Call rejected                                                                   [RFC-guy-iaxiana-00]
     22    Number changed                                                                  [RFC-guy-iaxiana-00]
    23-26  Unassigned
     27    Destination out of order                                                        [RFC-guy-iaxiana-00]
     28    Invalid number format/incomplete number                                         [RFC-guy-iaxiana-00]
     29    Facility rejected                                                               [RFC-guy-iaxiana-00]
     30    Response to status enquiry                                                      [RFC-guy-iaxiana-00]
     31    Normal, unspecified                                                             [RFC-guy-iaxiana-00]
    32-33  Unassigned
     34    No circuit/channel available                                                    [RFC-guy-iaxiana-00]
    35-37  Unassigned
     38    Network out of order                                                            [RFC-guy-iaxiana-00]
    39-40  Unassigned
     41    Temporary failure                                                               [RFC-guy-iaxiana-00]
     42    Switch congestion                                                               [RFC-guy-iaxiana-00]
     43    Access information discarded                                                    [RFC-guy-iaxiana-00]
     44    Requested channel not available                                                 [RFC-guy-iaxiana-00]
     45    Pre-empted (causes.h only)                                                      [RFC-guy-iaxiana-00]
     46    Unassigned
     47    Resource unavailable, unspecified (Q.931 only)                                  [RFC-guy-iaxiana-00]
    48-49  Unassigned
     50    Facility not subscribed (causes.h only)                                         [RFC-guy-iaxiana-00]
     51    Unassigned
     52    Outgoing call barred (causes.h only)                                            [RFC-guy-iaxiana-00]
     53    Unassigned
     54    Incoming call barred (causes.h only)                                            [RFC-guy-iaxiana-00]
    55-56  Unassigned
     57    Bearer capability not authorized                                                [RFC-guy-iaxiana-00]
     58    Bearer capability not available                                                 [RFC-guy-iaxiana-00]
    59-62  Unassigned
     63    Service or option not available (Q.931 only)                                    [RFC-guy-iaxiana-00]
     64    Unassigned
     65    Bearer capability not implemented                                               [RFC-guy-iaxiana-00]
     66    Channel type not implemented                                                    [RFC-guy-iaxiana-00]
    67-68  Unassigned
     69    Facility not implemented                                                        [RFC-guy-iaxiana-00]
     70    Only restricted digital information bearer capability is available (Q.931 only) [RFC-guy-iaxiana-00]
    71-78  Unassigned
     79    Service or option not available (Q.931 only)                                    [RFC-guy-iaxiana-00]
     80    Unassigned
     81    Invalid call reference                                                          [RFC-guy-iaxiana-00]
     82    Identified channel does not exist (Q.931 only)                                  [RFC-guy-iaxiana-00]
     83    A suspended call exists, but this call identity does not (Q.931 only)           [RFC-guy-iaxiana-00]
     84    Call identity in use (Q.931 only)                                               [RFC-guy-iaxiana-00]
     85    No call suspended (Q.931 only)                                                  [RFC-guy-iaxiana-00]
     86    Call has been cleared (Q.931 only)                                              [RFC-guy-iaxiana-00]
     87    Unassigned
     88    Incompatible destination                                                        [RFC-guy-iaxiana-00]
    89-90  Unassigned
     91    Invalid transit network selection (Q.931 only)                                  [RFC-guy-iaxiana-00]
    92-94  Unassigned
     95    Invalid message, unspecified                                                    [RFC-guy-iaxiana-00]
     96    Mandatory information element missing (Q.931 only)                              [RFC-guy-iaxiana-00]
     97    Message type nonexistent/not implemented                                        [RFC-guy-iaxiana-00]
     98    Message not compatible with call state                                          [RFC-guy-iaxiana-00]
     99    Information element nonexistent                                                 [RFC-guy-iaxiana-00]
     100   Invalid information element contents                                            [RFC-guy-iaxiana-00]
     101   Message not compatible with call state                                          [RFC-guy-iaxiana-00]
     102   Recovery on timer expiration                                                    [RFC-guy-iaxiana-00]
     103   Mandatory information element length error (causes.h only)                      [RFC-guy-iaxiana-00]
   104-110 Unassigned
     111   Protocol error, unspecified                                                     [RFC-guy-iaxiana-00]
   112-126 Unassigned
     127   Internetworking, unspecified                                                    [RFC-guy-iaxiana-00]
   128-255 Unassigned

IAX Encryption Methods

   Reference
           [RFC-guy-iaxiana-00]

   Note

 values must be power of two

   Registration Procedures
           Expert Review

      Method     Description      Reference
      0x0001     AES-128     [RFC-guy-iaxiana-00]
   0x0002-0x8000 Unassigned

IAX Media Formats

   Reference
           [RFC-guy-iaxiana-00]

   Note

 values must be power of two

   Registration Procedures
           Expert Review

    Subclass          Description              Reference
   0x00000001 G.723.1                     [RFC-guy-iaxiana-00]
   0x00000002 GSM Full Rate               [RFC-guy-iaxiana-00]
   0x00000004 G.711 mu-law                [RFC-guy-iaxiana-00]
   0x00000008 G.711 a-law                 [RFC-guy-iaxiana-00]
   0x00000010 G.726                       [RFC-guy-iaxiana-00]
   0x00000020 IMA ADPCM                   [RFC-guy-iaxiana-00]
   0x00000040 16-bit linear little-endian [RFC-guy-iaxiana-00]
   0x00000080 LPC10                       [RFC-guy-iaxiana-00]
   0x00000100 G.729                       [RFC-guy-iaxiana-00]
   0x00000200 Speex                       [RFC-guy-iaxiana-00]
   0x00000400 ILBC                        [RFC-guy-iaxiana-00]
   0x00000800 G.726 AAL2                  [RFC-guy-iaxiana-00]
   0x00001000 G.722                       [RFC-guy-iaxiana-00]
   0x00002000 AMR                         [RFC-guy-iaxiana-00]
   0x00010000 JPEG                        [RFC-guy-iaxiana-00]
   0x00020000 PNG                         [RFC-guy-iaxiana-00]
   0x00040000 H.261                       [RFC-guy-iaxiana-00]
   0x00080000 H.263                       [RFC-guy-iaxiana-00]
   0x00100000 H.263p                      [RFC-guy-iaxiana-00]
   0x00200000 H.264                       [RFC-guy-iaxiana-00]
