Inter-Asterisk eXchange (IAX) Parameters
Created
- 2008-12-03
Last Updated
- 2011-12-07
Available Formats
IAX Meta Commands
Registration Procedure(s)
- Expert Review
Expert(s)
- Cullen Jennings
Reference
- RFC 5457: IANA Considerations for IAX: Inter-Asterisk eXchange Version 2
Available Formats
| Value | Name | Description | Reference |
|---|---|---|---|
| 0x01 | Trunk Meta Frame | Indicates that frame is a trunk meta frame. | RFC 5457 |
| 0x02 | T.38 Primary IFP frame | Kevin P. Fleming | |
| 0x03-0x7F | Unassigned |
IAX Frame Types
Registration Procedure(s)
- Expert Review
Expert(s)
- Cullen Jennings
Reference
- RFC 5457: IANA Considerations for IAX: Inter-Asterisk eXchange Version 2
Available Formats
| Type | Description | Subclass Description | Data Description | Reference |
|---|---|---|---|---|
| 0x01 | DTMF | 0-9, A-D, *, # | Undefined | RFC 5457 |
| 0x02 | Voice | Audio Compression Format | Data | RFC 5457 |
| 0x03 | Video | Video Compression Format | Data | RFC 5457 |
| 0x04 | Control | See Control Frame Subclass | Varies with subclass | RFC 5457 |
| 0x05 | Null | Undefined | Undefined | RFC 5457 |
| 0x06 | IAX Control | See IAX Protocol Messages | Information Elements | RFC 5457 |
| 0x07 | Text | Always 0 | Raw Text | RFC 5457 |
| 0x08 | Image | Image Compression Format | Raw Image | RFC 5457 |
| 0x09 | HTML | See HTML Frame Types | Message Specific | RFC 5457 |
| 0x0A | Comfort Noise | Level in -dBov of comfort noise | None | RFC 5457 |
| 0x0B | T.38 Primary IFP frame | No subclasses necessary or allowed | Kevin P. Fleming | |
| 0x0C-0xFF | Unassigned |
IAX Control Frame Subclass
Registration Procedure(s)
- Expert Review
Expert(s)
- Cullen Jennings
Reference
- RFC 5457: IANA Considerations for IAX: Inter-Asterisk eXchange Version 2
Available Formats
| Value | Name | Description | Reference |
|---|---|---|---|
| 0x01 | Hangup | The call has been hungup at the remote end | RFC 5457 |
| 0x02 | Reserved | Reserved for future use | RFC 5457 |
| 0x03 | Ringing | Remote end is ringing (ring-back) | RFC 5457 |
| 0x04 | Answer | Remote end has answered | RFC 5457 |
| 0x05 | Busy | Remote end is busy | RFC 5457 |
| 0x06 | Reserved | Reserved for future use | RFC 5457 |
| 0x07 | Reserved | Reserved for future use | RFC 5457 |
| 0x08 | Congestion | The call is congested | RFC 5457 |
| 0x09 | Flash Hook | Flash hook | RFC 5457 |
| 0x0A | Reserved | Reserved for future use | RFC 5457 |
| 0x0B | Option | Device-specific options are being transmitted | RFC 5457 |
| 0x0C | Key Radio | Key Radio | RFC 5457 |
| 0x0D | Unkey Radio | Unkey Radio | RFC 5457 |
| 0x0E | Call Progress | Call is in progress | RFC 5457 |
| 0x0F | Call Proceeding | Call is proceeding | RFC 5457 |
| 0x10 | Hold | Call is placed on hold | RFC 5457 |
| 0x11 | Unhold | Call is taken off hold | RFC 5457 |
| 0x12-0x7F | Unassigned |
IAX Control Frames
Registration Procedure(s)
- Expert Review
Expert(s)
- Cullen Jennings
Reference
- RFC 5457: IANA Considerations for IAX: Inter-Asterisk eXchange Version 2
Available Formats
| Value | Name | Description | Reference |
|---|---|---|---|
| 0x01 | NEW | Initiate a new call | RFC 5457 |
| 0x02 | PING | Ping request | RFC 5457 |
| 0x03 | PONG | Ping or poke reply | RFC 5457 |
| 0x04 | ACK | Explicit acknowledgment | RFC 5457 |
| 0x05 | HANGUP | Initiate call tear-down | RFC 5457 |
| 0x06 | REJECT | Reject a call | RFC 5457 |
| 0x07 | ACCEPT | Accept a call | RFC 5457 |
| 0x08 | AUTHREQ | Authentication request | RFC 5457 |
| 0x09 | AUTHREP | Authentication reply | RFC 5457 |
| 0x0A | INVAL | Invalid message | RFC 5457 |
| 0x0B | LAGRQ | Lag request | RFC 5457 |
| 0x0C | LAGRP | Lag reply | RFC 5457 |
| 0x0D | REGREQ | Registration request | RFC 5457 |
| 0x0E | REGAUTH | Registration authentication | RFC 5457 |
| 0x0F | REGACK | Registration acknowledgement | RFC 5457 |
| 0x10 | REGREJ | Registration reject | RFC 5457 |
| 0x11 | REGREL | Registration release | RFC 5457 |
| 0x12 | VNAK | Video/Voice retransmit request | RFC 5457 |
| 0x13 | DPREQ | Dialplan request | RFC 5457 |
| 0x14 | DPREP | Dialplan reply | RFC 5457 |
| 0x15 | DIAL | Dial | RFC 5457 |
| 0x16 | TXREQ | Transfer request | RFC 5457 |
| 0x17 | TXCNT | Transfer connect | RFC 5457 |
| 0x18 | TXACC | Transfer accept | RFC 5457 |
| 0x19 | TXREADY | Transfer ready | RFC 5457 |
| 0x1A | TXREL | Transfer release | RFC 5457 |
| 0x1B | TXREJ | Transfer reject | RFC 5457 |
| 0x1C | QUELCH | Halt audio/video [media] transmission | RFC 5457 |
| 0x1D | UNQUELCH | Resume audio/video [media] transmission | RFC 5457 |
| 0x1E | POKE | Poke request | RFC 5457 |
| 0x1F | Reserved | Reserved for future use | RFC 5457 |
| 0x20 | MWI | Message waiting indication | RFC 5457 |
| 0x21 | UNSUPPORT | Unsupported message | RFC 5457 |
| 0x22 | TRANSFER | Remote transfer request | RFC 5457 |
| 0x23 | Reserved | Reserved for future use | RFC 5457 |
| 0x24 | Reserved | Reserved for future use | RFC 5457 |
| 0x25 | Reserved | Reserved for future use | RFC 5457 |
| 0x26 | TXMEDIA | request a media-only transfer | Kevin P. Fleming |
| 0x27 | RTKEY | initiate an encryption key rotation sequence | Kevin P. Fleming |
| 0x28 | CALLTOKEN | provide a call token used for 3-way handshake during call setup | Kevin P. Fleming |
| 0x29-0x2F | Unassigned | ||
| 0x30 | T38_REQUEST_NEGOTIATE | T38_REQUEST_NEGOTIATE | Kevin P. Fleming |
| 0x31 | T38_REQUEST_TERMINATE | T38_REQUEST_TERMINATE | Kevin P. Fleming |
| 0x32 | T38_NEGOTIATED | T38_NEGOTIATED | Kevin P. Fleming |
| 0x33 | T38_TERMINATED | T38_TERMINATED | Kevin P. Fleming |
| 0x34 | T38_REFUSED | T38_REFUSED | Kevin P. Fleming |
| 0x35-0x7F | Unassigned |
IAX HTML Command Subclasses
Registration Procedure(s)
- Expert Review
Expert(s)
- Cullen Jennings
Reference
- RFC 5457: IANA Considerations for IAX: Inter-Asterisk eXchange Version 2
Available Formats
| Value | Description | Reference |
|---|---|---|
| 0x01 | Sending a URL | RFC 5457 |
| 0x02 | Data frame | RFC 5457 |
| 0x03 | Unassigned | |
| 0x04 | Beginning frame | RFC 5457 |
| 0x05-0x07 | Unassigned | |
| 0x08 | End frame | RFC 5457 |
| 0x09-0x0F | Unassigned | |
| 0x10 | Load is complete | RFC 5457 |
| 0x11 | Peer does not support HTML | RFC 5457 |
| 0x12 | Link URL | RFC 5457 |
| 0x13 | Unlink URL | RFC 5457 |
| 0x14 | Reject Link URL | RFC 5457 |
| 0x15-0x7F | Unassigned |
IAX Information Elements
Registration Procedure(s)
- Expert Review
Expert(s)
- Cullen Jennings
Reference
- RFC 5457: IANA Considerations for IAX: Inter-Asterisk eXchange Version 2
Available Formats
| Value | Name | Description | Reference |
|---|---|---|---|
| 0x01 | CALLED NUMBER | Number/extension being called | RFC 5457 |
| 0x02 | CALLING NUMBER | Calling number | RFC 5457 |
| 0x03 | CALLING ANI | Calling number ANI for billing | RFC 5457 |
| 0x04 | CALLING NAME | Name of caller | RFC 5457 |
| 0x05 | CALLED CONTEXT | Context for number | RFC 5457 |
| 0x06 | USERNAME | Username (peer or user) for authentication | RFC 5457 |
| 0x07 | PASSWORD | Password for authentication | RFC 5457 |
| 0x08 | CAPABILITY | Actual CODEC capability | RFC 5457 |
| 0x09 | FORMAT | Desired CODEC format | RFC 5457 |
| 0x0A | LANGUAGE | Desired language | RFC 5457 |
| 0x0B | VERSION | Protocol version | RFC 5457 |
| 0x0C | ADSICPE | CPE ADSI capability | RFC 5457 |
| 0x0D | DNID | Originally dialed DNID | RFC 5457 |
| 0x0E | AUTHMETHODS | Authentication method(s) | RFC 5457 |
| 0x0F | CHALLENGE | Challenge data for MD5/RSA | RFC 5457 |
| 0x10 | MD5 RESULT | MD5 challenge result | RFC 5457 |
| 0x11 | RSA RESULT | RSA challenge result | RFC 5457 |
| 0x12 | APPARENT ADDR | Apparent address of peer | RFC 5457 |
| 0x13 | REFRESH | When to refresh registration | RFC 5457 |
| 0x14 | DPSTATUS | Dialplan status | RFC 5457 |
| 0x15 | CALLNO | Call number of peer | RFC 5457 |
| 0x16 | CAUSE | Cause | RFC 5457 |
| 0x17 | IAX UNKNOWN | Unknown IAX command | RFC 5457 |
| 0x18 | MSGCOUNT | How many messages waiting | RFC 5457 |
| 0x19 | AUTOANSWER | Request auto-answering | RFC 5457 |
| 0x1A | MUSICONHOLD | Request musiconhold with QUELCH | RFC 5457 |
| 0x1B | TRANSFERID | Transfer Request Identifier | RFC 5457 |
| 0x1C | RDNIS | Referring DNIS | RFC 5457 |
| 0x1D | Reserved | Reserved for future use | RFC 5457 |
| 0x1E | Reserved | Reserved for future use | RFC 5457 |
| 0x1F | DATETIME | Date/Time | RFC 5457 |
| 0x20 | Reserved | Reserved for future use | RFC 5457 |
| 0x21 | Reserved | Reserved for future use | RFC 5457 |
| 0x22 | Reserved | Reserved for future use | RFC 5457 |
| 0x23 | Reserved | Reserved for future use | RFC 5457 |
| 0x24 | Reserved | Reserved for future use | RFC 5457 |
| 0x25 | Reserved | Reserved for future use | RFC 5457 |
| 0x26 | CALLINGPRES | Calling presentation | RFC 5457 |
| 0x27 | CALLINGTON | Calling type of number | RFC 5457 |
| 0x28 | CALLINGTNS | Calling transit network select | RFC 5457 |
| 0x29 | SAMPLINGRATE | Supported sampling rates | RFC 5457 |
| 0x2A | CAUSECODE | Hangup cause | RFC 5457 |
| 0x2B | ENCRYPTION | Encryption format | RFC 5457 |
| 0x2C | ENCKEY | Reserved for future use | RFC 5457 |
| 0x2D | CODEC PREFS | CODEC Negotiation | RFC 5457 |
| 0x2E | RR JITTER | Received jitter, as in [RFC3550] | RFC 5457 |
| 0x2F | RR LOSS | Received loss, as in [RFC3550] | RFC 5457 |
| 0x30 | RR PKTS | Received frames | RFC 5457 |
| 0x31 | RR DELAY | Max playout delay for received frames in ms | RFC 5457 |
| 0x32 | RR DROPPED | Dropped frames (presumably by jitter buffer) | RFC 5457 |
| 0x33 | RR OOO | Frames received Out of Order | RFC 5457 |
| 0x34 | VARIABLE | used to transport variable names and values between endpoints | Kevin P. Fleming; RFC Errata 2871 |
| 0x35 | OSPTOKEN | OSP Token Block | RFC 5457; RFC Errata 2871 |
| 0x36 | CALLTOKEN | used with the CALLTOKEN IAX control frame | Kevin P. Fleming |
| 0x37 | CAPABILITY2 | used for expanded codec negotiation | Kevin P. Fleming |
| 0x38 | FORMAT2 | used for expanded codec negotiation | Kevin P. Fleming |
| 0x39-0x3F | Unassigned | ||
| 0x40 | T38_VERSION | T38_VERSION | Kevin P. Fleming |
| 0x41 | T38_MAX_IFP | T38_MAX_IFP | Kevin P. Fleming |
| 0x42 | T38_MAX_RATE | T38_MAX_RATE | Kevin P. Fleming |
| 0x43 | T38_RATE_MANAGEMENT | T38_RATE_MANAGEMENT | Kevin P. Fleming |
| 0x44 | T38_FILL_BIT_REMOVAL | T38_FILL_BIT_REMOVAL | Kevin P. Fleming |
| 0x45 | T38_MMR_TRANSCODING | T38_MMR_TRANSCODING | Kevin P. Fleming |
| 0x46 | T38_JBIG_TRANSCODING | T38_JBIG_TRANSCODING | Kevin P. Fleming |
| 0x47-0xFF | Unassigned |
IAX Authentication Methods
Registration Procedure(s)
- Expert Review
Expert(s)
- Cullen Jennings
Reference
- RFC 5457: IANA Considerations for IAX: Inter-Asterisk eXchange Version 2
Note
values must be power of two
Available Formats
IAX Dialplan Status Flags
Registration Procedure(s)
- Expert Review
Expert(s)
- Cullen Jennings
Reference
- RFC 5457: IANA Considerations for IAX: Inter-Asterisk eXchange Version 2
Note
values must be power of two
Available Formats
IAX Calling Presentation
Registration Procedure(s)
- Expert Review
Expert(s)
- Cullen Jennings
Reference
- RFC 5457: IANA Considerations for IAX: Inter-Asterisk eXchange Version 2
Available Formats
| Flag | Presentation | Reference |
|---|---|---|
| 0x00 | Allowed user/number not screened | RFC 5457 |
| 0x01 | Allowed user/number passed screen | RFC 5457 |
| 0x02 | Allowed user/number failed screen | RFC 5457 |
| 0x03 | Allowed network number | RFC 5457 |
| 0x04-0x1A | Unassigned | |
| 0x020 | Prohibited user/number not screened | RFC 5457 |
| 0x021 | Prohibited user/number passed screen | RFC 5457 |
| 0x022 | Prohibited user/number failed screen | RFC 5457 |
| 0x023 | Prohibited network number | RFC 5457 |
| 0x24-0x42 | Unassigned | |
| 0x043 | Number not available | RFC 5457 |
| 0x44-0xFF | Unassigned |
IAX Calling Type of Number
Registration Procedure(s)
- Expert Review
Expert(s)
- Cullen Jennings
Reference
- RFC 5457: IANA Considerations for IAX: Inter-Asterisk eXchange Version 2
Available Formats
| Value | Description | Reference |
|---|---|---|
| 0x00 | Unknown | RFC 5457 |
| 0x01-0x0F | Unassigned | |
| 0x10 | International Number | RFC 5457 |
| 0x11-0x1F | Unassigned | |
| 0x20 | National Number | RFC 5457 |
| 0x21-0x2F | Unassigned | |
| 0x30 | Network Specific Number | RFC 5457 |
| 0x31-0x3F | Unassigned | |
| 0x40 | Subscriber Number | RFC 5457 |
| 0x41-0x5F | Unassigned | |
| 0x60 | Abbreviated Number | RFC 5457 |
| 0x61-0x6F | Unassigned | |
| 0x70 | Reserved for extension | RFC 5457 |
| 0x71-0xFF | Unassigned |
IAX Transit Network Identification Plan
Registration Procedure(s)
- Expert Review
Reference
- RFC 5457: IANA Considerations for IAX: Inter-Asterisk eXchange Version 2
Available Formats
IAX Type of Network
Registration Procedure(s)
- Expert Review
Expert(s)
- Cullen Jennings
Reference
- RFC 5457: IANA Considerations for IAX: Inter-Asterisk eXchange Version 2
Available Formats
IAX Cause Codes
Registration Procedure(s)
- Expert Review
Expert(s)
- Cullen Jennings
Reference
- RFC 5457: IANA Considerations for IAX: Inter-Asterisk eXchange Version 2
Available Formats
| Number | Cause | Reference |
|---|---|---|
| 1 | Unassigned/unallocated number | RFC 5457 |
| 2 | No route to specified transit network | RFC 5457 |
| 3 | No route to specified transit network | RFC 5457 |
| 4-5 | Unassigned | |
| 6 | Channel unacceptable | RFC 5457 |
| 7 | Call awarded and delivered | RFC 5457 |
| 8-15 | Unassigned | |
| 16 | Normal call clearing | RFC 5457 |
| 17 | User busy | RFC 5457 |
| 18 | No user response | RFC 5457 |
| 19 | No answer | RFC 5457 |
| 20 | Unassigned | |
| 21 | Call rejected | RFC 5457 |
| 22 | Number changed | RFC 5457 |
| 23-26 | Unassigned | |
| 27 | Destination out of order | RFC 5457 |
| 28 | Invalid number format/incomplete number | RFC 5457 |
| 29 | Facility rejected | RFC 5457 |
| 30 | Response to status enquiry | RFC 5457 |
| 31 | Normal, unspecified | RFC 5457 |
| 32-33 | Unassigned | |
| 34 | No circuit/channel available | RFC 5457 |
| 35-37 | Unassigned | |
| 38 | Network out of order | RFC 5457 |
| 39-40 | Unassigned | |
| 41 | Temporary failure | RFC 5457 |
| 42 | Switch congestion | RFC 5457 |
| 43 | Access information discarded | RFC 5457 |
| 44 | Requested channel not available | RFC 5457 |
| 45 | Pre-empted (causes.h only) | RFC 5457 |
| 46 | Unassigned | |
| 47 | Resource unavailable, unspecified (Q.931 only) | RFC 5457 |
| 48-49 | Unassigned | |
| 50 | Facility not subscribed (causes.h only) | RFC 5457 |
| 51 | Unassigned | |
| 52 | Outgoing call barred (causes.h only) | RFC 5457 |
| 53 | Unassigned | |
| 54 | Incoming call barred (causes.h only) | RFC 5457 |
| 55-56 | Unassigned | |
| 57 | Bearer capability not authorized | RFC 5457 |
| 58 | Bearer capability not available | RFC 5457 |
| 59-62 | Unassigned | |
| 63 | Service or option not available (Q.931 only) | RFC 5457 |
| 64 | Unassigned | |
| 65 | Bearer capability not implemented | RFC 5457 |
| 66 | Channel type not implemented | RFC 5457 |
| 67-68 | Unassigned | |
| 69 | Facility not implemented | RFC 5457 |
| 70 | Only restricted digital information bearer capability is available (Q.931 only) | RFC 5457 |
| 71-78 | Unassigned | |
| 79 | Service or option not available (Q.931 only) | RFC 5457 |
| 80 | Unassigned | |
| 81 | Invalid call reference | RFC 5457 |
| 82 | Identified channel does not exist (Q.931 only) | RFC 5457 |
| 83 | A suspended call exists, but this call identity does not (Q.931 only) | RFC 5457 |
| 84 | Call identity in use (Q.931 only) | RFC 5457 |
| 85 | No call suspended (Q.931 only) | RFC 5457 |
| 86 | Call has been cleared (Q.931 only) | RFC 5457 |
| 87 | Unassigned | |
| 88 | Incompatible destination | RFC 5457 |
| 89-90 | Unassigned | |
| 91 | Invalid transit network selection (Q.931 only) | RFC 5457 |
| 92-94 | Unassigned | |
| 95 | Invalid message, unspecified | RFC 5457 |
| 96 | Mandatory information element missing (Q.931 only) | RFC 5457 |
| 97 | Message type nonexistent/not implemented | RFC 5457 |
| 98 | Message not compatible with call state | RFC 5457 |
| 99 | Information element nonexistent | RFC 5457 |
| 100 | Invalid information element contents | RFC 5457 |
| 101 | Message not compatible with call state | RFC 5457 |
| 102 | Recovery on timer expiration | RFC 5457 |
| 103 | Mandatory information element length error (causes.h only) | RFC 5457 |
| 104-110 | Unassigned | |
| 111 | Protocol error, unspecified | RFC 5457 |
| 112-126 | Unassigned | |
| 127 | Internetworking, unspecified | RFC 5457 |
| 128-255 | Unassigned |
IAX Encryption Methods
Registration Procedure(s)
- Expert Review
Expert(s)
- Cullen Jennings
Reference
- RFC 5457: IANA Considerations for IAX: Inter-Asterisk eXchange Version 2
Note
values must be power of two
Available Formats
| Method | Description | Reference |
|---|---|---|
| 0x0001 | AES-128 | RFC 5457 |
| 0x0002-0x7FFF | Unassigned | |
| 0x8000 | KEYROTATE - indicates that encryption key rotation is available/will be used | Kevin P. Fleming |
IAX Media Formats
Registration Procedure(s)
- Expert Review
Expert(s)
- Cullen Jennings
Reference
- RFC 5457: IANA Considerations for IAX: Inter-Asterisk eXchange Version 2
Note
values must be power of two
Available Formats
| Subclass | Description | Reference |
|---|---|---|
| 0x00000001 | G.723.1 | RFC 5457 |
| 0x00000002 | GSM Full Rate | RFC 5457 |
| 0x00000004 | G.711 mu-law | RFC 5457 |
| 0x00000008 | G.711 a-law | RFC 5457 |
| 0x00000010 | G.726 | RFC 5457 |
| 0x00000020 | IMA ADPCM | RFC 5457 |
| 0x00000040 | 16-bit linear little-endian | RFC 5457 |
| 0x00000080 | LPC10 | RFC 5457 |
| 0x00000100 | G.729 | RFC 5457 |
| 0x00000200 | Speex | RFC 5457 |
| 0x00000400 | ILBC | RFC 5457 |
| 0x00000800 | G.726 AAL2 | RFC 5457 |
| 0x00001000 | G.722 | RFC 5457 |
| 0x00002000 | AMR | RFC 5457 |
| 0x00010000 | JPEG | RFC 5457 |
| 0x00020000 | PNG | RFC 5457 |
| 0x00040000 | H.261 | RFC 5457 |
| 0x00080000 | H.263 | RFC 5457 |
| 0x00100000 | H.263p | RFC 5457 |
| 0x00200000 | H.264 | RFC 5457 |
Contact Information
| Name | Contact URI | Last Updated |
|---|---|---|
| Kevin P. Fleming | kpfleming&digium.com | 2009-07-12 |