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