Dialplan API parameters

Document description

Updated:

Permalink:

#	Application Key	Application Name	Application parameter name	API parameter name
1	Answer	Answer the call	-	-
2	AuthenticateUser	Authenticate user	Set Number Set Options	number options
3	DialRemotePbx	Call through remote PBX	PBX Procedure Set Number Timeout Set Options	pbx dialplan number timeout DialTrunk
4	CorrectOutgoingNumber	Correct called number	Outgoing prefix Procedure	outPrefix dialplan
5	DialPhone	Dial the phone	Set number Timeout Set options Message for operator	number timeout options msgForOperator
6	DialTrunk	Dial the trunk	Select trunk Set Number Class Timeout Max calls Set Options	trunk number classOfCall timeout maxCalls options
7	Hangup	Hangup	Reason	causeCode
8	DialHuntGroup	Trunk group	Select trunk Set number Class Strategy	huntGroup number classOfCall hgStrategy uniqueval
9	Callback	Automatic Call Back	-	-
10	Queue	Call group	Select Call group Message for operator Timeout Music on hold class	queueId msgForOperator timeout mohClass
11	Conference	Conference	Room number	roomNumber
12	Directory	Dial by name / Directory	-	-
13	FaxToEmail	Fax to e-mail	Set email Format ID fax	destination format localstationId
14	VoiceMail	Go to voicemail	Set Number Set Options	destination options
15	FeatureIntercom	Intercom	Set Number Timeout Set options Message for operator	number timeout options msgForOperator
16	FeaturePaging	Paging group	Paging group	groupId
17	MuxMon	Record call	Set options Send to email-user	options destination
18	VoiceMailMain	Voicemail access	Access Voicemail Set Options	number options
19	GoToIfFaxDetected	Detect fax		detectTime number dialplan nowait
20	Goto	Jump to		number dialplan
21	GotoIf	Jump to if		condition number dialplan
22	GotoIf3SwitchIsOnOrBlinking	Jump to if 3 state switch is on		switchId numberOn dialplanOn numberBlinking dialplanBlinking
23	GotoIfCallType	Jump to if call type is		callType number dialplan
24	GotoIfBusyCongested	Jump to if congested / busy		dialStatus number dialplan
25	GotoIfSwitchIsOn	Jump to if switch is on		switchId number dialplan
26	GotoIfUserStatus	Jump to if user status is		user userStatus number dialplan
27	VerifyCaller	Verify caller		contains number dialplan
28	GotoIfGroupCount	Verify number of calls		callsCount number dialplan groupname
29	Timetable	Verify timetable		timetableId number dialplan
30	LookUpDestCidNameInPhonebook	Lookup called name in phonebook		number phonebookId options
31	LookUpCidNameInPhonebook	Lookup caller name in phonebook		number phonebookId options
32	MobilityExtensionLookUp	Mobility extension lookup		number options
33	IVR	IVR		ivrName
34	AsrIvr	IVR via ASR with Directory		-
35	Playback	Play sound		filename noAnswer
36	Background	Play sound and wait for digits		filename noAnswer
37	WaitExten	Wait for digits		seconds
38	Set	Set		key value
39	GenerateDtmf	Generate DTMF		digits
40	GenerateFlashHook	Generate Flash Hook		-
41	CustomApp	Custom application		cwApp
42	FastAGI	Remote script		scriptname