Skip to end of metadata
Go to start of metadata


Aug 21, 2019 13:29

#

The Document explains each API Dialplan application Key and name.

Useful links:

Created: August 2019

Permalink: https://confluence.wildix.com/x/CQA8Aw

# API Application KeyApplication NameAPI parameter NameApplication parameter Name
1
Answer
Answer the call--
2
AuthenticateUser
Authenticate user
  • number
  • options
  • Set Number
  • Set Options
3



DialRemotePbx
Call through remote PBX

  • pbx
  • dialplan
  • number
  • timeout
  • DialTrunk
  • PBX
  • Procedure
  • Set Number
  • Timeout
  • Set Options
4
CorrectOutgoingNumber

Correct called number

  • outPrefix
  • dialplan
  • Outgoing prefix
  • Procedure
5
DialPhone
Dial the phone
  • number
  • timeout
  • options
  • msgForOperator
  • Set number
  • Timeout
  • Set options
  • Message for operator
6
DialTrunk
Dial the trunk
  • trunk
  • number
  • classOfCall
  • timeout
  • maxCalls
  • options
  • Select trunk
  • Set Number
  • Class
  • Timeout
  • Max calls
  • Set Options
7
Hangup
Hangup
  • causeCode
  • Reason
8
DialHuntGroup
Trunk group
  • huntGroup
  • number
  • classOfCall
  • hgStrategy
  • uniqueval
  • Select trunk
  • Set number
  • Class
  • Strategy
9
Callback
Automatic Call Back--
10
Queue
Call group
  • queueId
  • msgForOperator
  • timeout
  • mohClass
  • Select Call group
  • Message for operator
  • Timeout
  • Music on hold class
11
Conference
Conference
  • roomNumber
  • Room number
12
Directory
Dial by name / Directory--
13
FaxToEmail
Fax to e-mail
  • destination
  • format
  • localstationId
  • Set email
  • Format
  • ID fax
14
VoiceMail
Go to voicemail
  • destination
  • options
  • Set Number
  • Set Options
15
FeatureIntercom
Intercom
  • number
  • timeout
  • options
  • msgForOperator
  • Set Number
  • Timeout
  • Set options
  • Message for operator
16
FeaturePaging
Paging group
  • groupId
  • Paging group
17
MuxMon
Record call
  • options
  • destination
  • Set options
  • Send to email-user
18
VoiceMailMain
Voicemail access
  • number
  • options
  • Access Voicemail
  • Set Options
19
GoToIfFaxDetected
Detect fax
  • detectTime
  • nowait
  • dialplan
  • number
  • Fax detect time
  • Continue the execution
  • Procedure
  • Set Number
20
Goto
Jump to
  • dialplan
  • number
  • Procedure
  • Set Number
21
GotoIf
Jump to if
  • condition
  • dialplan
  • number
  • Condition
  • Procedure
  • Set Number
22
GotoIf3SwitchIsOnOrBlinking

Jump to if 3 state switch is on


  • switchId
  • dialplanOn
  • numberOn
  • dialplanBlinking
  • numberBlinking
  • Select switch
  • (is On) Procedure
  • Set number
  • (or Blinking) Procedure
  • Set Number
23
GotoIfCallType
Jump to if call type is
  • callType
  • dialplan
  • number
  • Select call type
  • Procedure
  • Set Number
24
GotoIfBusyCongested
Jump to if congested / busy
  • dialStatus
  • dialplan
  • number
  • Select Dial status
  • Procedure
  • Set Number
25
GotoIfSwitchIsOn
Jump to if switch is on
  • switchId
  • dialplan
  • number
  • Select switch
  • Procedure
  • Set Number
26
GotoIfUserStatus

Jump to if user status is


  • userStatus
  • user
  • dialplan
  • number
  • DND / away
  • User (called number)
  • Procedure
  • Set Number
27
VerifyCaller
Verify caller
  • contains
  • dialplan
  • number
  • If [caller name | caller number] contains
  • Procedure
  • Set Number
28
GotoIfGroupCount
Verify number of calls
  • callsCount
  • dialplan
  • number
  • groupname
  • If more than (active calls)
  • Procedure
  • Set Number
29
Timetable

Verify timetable


  • timetableId
  • dialplan
  • number
  • If matched 
  • Procedure
  • Set Number
30
LookUpDestCidNameInPhonebook
Lookup called name in phonebook
  • phonebookId
  • number
  • options
  • Select phonebook
  • Set Number
  • Set Options
31
LookUpCidNameInPhonebook
Lookup caller name in phonebook
  • phonebookId
  • number
  • options
  • Select phonebook
  • Set Number
  • Set Options
32
MobilityExtensionLookUp

Mobility extension lookup

  • number
  • options
  • Set Number
  • Set Options
33
IVR
IVR
  • ivrName
  • Select IVR
34
AsrIvr
IVR via ASR with Directory-
35
Playback
Play sound
  • filename
  • noAnswer
  • Audio file
  • Do not answer the call
36
Background
Play sound and wait for digits
  • filename
  • noAnswer
  • Audio file
  • Do not answer the call
37
WaitExten
Wait for digits
  • seconds
  • For (seconds)
38
Set
Set
  • key
  • value
  • Parameter
  • Options
39
GenerateDtmf
Generate DTMF
  • digits
  • DTMF tone
40
GenerateFlashHook
Generate Flash Hook--
41
CustomApp
Custom application
  • cwApp
  • Custom application
42
FastAGI
Remote script
  • scriptname
  • Path to the remote scripgt

Not finding the help you need?
Join the Facebook group to ask a question!
facebook_tech-wizards

  • No labels