Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Domain Types

Typed enums for Asterisk domain constants, available in asterisk_rs_core::types.

HangupCause

Q.931/Q.850 hangup cause codes used across AMI and ARI

VariantDescription
NotDefined = 0not defined (code 0)
Unallocated = 1unallocated number (code 1)
NoRouteTransitNet = 2no route to transit network (code 2)
NoRouteDestination = 3no route to destination (code 3)
MisdialledTrunkPrefix = 5misdialled trunk prefix (code 5)
ChannelUnacceptable = 6channel unacceptable (code 6)
CallAwardedDelivered = 7call awarded and being delivered (code 7)
PreEmpted = 8pre-empted (code 8)
NumberPortedNotHere = 14number ported but not found here (code 14)
NormalClearing = 16normal call clearing (code 16)
UserBusy = 17user busy (code 17)
NoUserResponse = 18no user response (code 18)
NoAnswer = 19no answer from user (code 19)
SubscriberAbsent = 20subscriber absent (code 20)
CallRejected = 21call rejected (code 21)
NumberChanged = 22number changed (code 22)
RedirectedToNewDestination = 23redirected to new destination (code 23)
AnsweredElsewhere = 26answered elsewhere (code 26)
DestinationOutOfOrder = 27destination out of order (code 27)
InvalidNumberFormat = 28invalid number format (code 28)
FacilityRejected = 29facility rejected (code 29)
ResponseToStatusEnquiry = 30response to status enquiry (code 30)
NormalUnspecified = 31normal unspecified (code 31)
NormalCircuitCongestion = 34normal circuit congestion (code 34)
NetworkOutOfOrder = 38network out of order (code 38)
NormalTemporaryFailure = 41normal temporary failure (code 41)
SwitchCongestion = 42switch congestion (code 42)
AccessInfoDiscarded = 43access information discarded (code 43)
RequestedChanUnavail = 44requested channel unavailable (code 44)
FacilityNotSubscribed = 50facility not subscribed (code 50)
OutgoingCallBarred = 52outgoing call barred (code 52)
IncomingCallBarred = 54incoming call barred (code 54)
BearerCapabilityNotAuth = 57bearer capability not authorized (code 57)
BearerCapabilityNotAvail = 58bearer capability not available (code 58)
BearerCapabilityNotImpl = 65bearer capability not implemented (code 65)
ChanNotImplemented = 66channel type not implemented (code 66)
FacilityNotImplemented = 69facility not implemented (code 69)
InvalidCallReference = 81invalid call reference (code 81)
IncompatibleDestination = 88incompatible destination (code 88)
InvalidMsgUnspecified = 95invalid message unspecified (code 95)
MandatoryIeMissing = 96mandatory information element missing (code 96)
MessageTypeNonexist = 97message type nonexistent (code 97)
WrongMessage = 98wrong message (code 98)
IeNonexist = 99information element nonexistent (code 99)
InvalidIeContents = 100invalid information element contents (code 100)
WrongCallState = 101wrong call state (code 101)
RecoveryOnTimerExpire = 102recovery on timer expiry (code 102)
MandatoryIeLengthError = 103mandatory information element length error (code 103)
ProtocolError = 111protocol error (code 111)
Interworking = 127interworking unspecified (code 127)

ChannelState

channel state as reported by Asterisk

VariantDescription
Down = 0channel is down and available
Reserved = 1channel is down, but reserved
OffHook = 2channel is off hook
Dialing = 3digits have been dialed
Ring = 4remote end is ringing
Ringing = 5local end is ringing
Up = 6channel is up (answered)
Busy = 7line is busy
DialingOffhook = 8dialing while offhook
PreRing = 9channel detected incoming call before ring

DeviceState

device state values used in device state events and queries

VariantDescription
Unknownstate is unknown
NotInUsedevice is not in use
InUsedevice is in use
Busydevice is busy
Invaliddevice is invalid
Unavailabledevice is unavailable
Ringingdevice is ringing
RingInUsedevice is ringing and in use
OnHolddevice is on hold

DialStatus

result of a dial attempt, set in the DIALSTATUS channel variable

VariantDescription
Answercall was answered
Busyremote end was busy
NoAnswerremote end did not answer
Cancelcall was cancelled
Congestioncongestion encountered
ChanUnavailchannel was unavailable
DontCallnumber on do-not-call list
Torturenumber routed to torture IVR
InvalidArgsinvalid arguments to Dial()
Unavailabletarget was unavailable

CdrDisposition

CDR disposition values

VariantDescription
NoAnswercall was not answered
Answeredcall was answered
Busyremote end was busy
Failedcall attempt failed
Congestioncongestion encountered

PeerStatus

SIP/PJSIP peer registration status

VariantDescription
Registeredpeer is registered
Unregisteredpeer is unregistered
Reachablepeer is reachable
Unreachablepeer is unreachable
Laggedpeer response is lagged
Rejectedpeer registration was rejected
Unknownpeer status is unknown

QueueStrategy

queue member selection strategy

VariantDescription
RingAllring all available members simultaneously
LeastRecentring the member least recently called
FewestCallsring the member with the fewest completed calls
Randomring a random member
RoundRobinround-robin with memory
Linearring members in the order listed
WeightedRandomring a random member, weighted by penalty

ExtensionState

extension hint state values

VariantDescription
Removed = -2not found or removed
Idle = -1idle, no active calls
InUse = 1in use
Busy = 2busy
Unavailable = 4unavailable
Ringing = 8ringing
OnHold = 16on hold

AgiStatus

AGI response status codes

VariantDescription
Success = 200success
InvalidCommand = 510invalid or unknown command
DeadChannel = 511channel is dead
EndUsage = 520end of proper usage for command