JSON API » conferences » conferences/create

Creates a new conference.

Input parameters

Requires authentication and the user role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
code	String	Conference code. Must be unique.	Yes
adminpin	String	PIN to enter as administrator.	See below.	Empty string.
callerid	String	Callerid to send on notification calls.	No	Empty string.
count	Integer	Number of recurring conferences.	No	1
customer	Integer	ID of customer to create in.	No	Customer of authentication user.
description	String	Description.	No	Empty string.
duration	Integer	Duration of conference in minutes. 0 for no limit.	No	0
listenpin	String	PIN to enter as listener.	See below.	Empty string.
maximum	Integer	Maximum number of people in conference. 0 for no limit.	No	0
owner	Integer	ID of owner. 0 for none.	No	0
panel	Integer	1 to show in control panel, 0 not to.	No	0
play_join	Integer	1 to play tone when new person joins, 0 not to.	No	0
play_music	Integer	1 to play music to first caller, 0 not to.	No	0
record_name	Integer	1 to ask callers to record their names, 0 not to.	No	0
repeats	Integer	How often recurring conferences repeat. "daily", "weekly", "2_weekly", "monthly", "2_monthly", or empty string for does not repeat.	No	Empty string.
talkpin	Integer	PIN to enter as talker.	See below.	Empty string.
wait_music	Integer	1 to play music to all callers until an administrator joins, 0 not to.	No	0
year	Integer	Year of first conference.	No	0
month	Integer	Month of first conference, 1 to 12.	No	1
day	Integer	Day of first conference, 1 to 31.	No	1
hour	Integer	Hour of first conference, 0 to 23.	No	0
minute	Integer	Minute of first conference, 0 to 59.	No	0
validation	Integer	1 to validate input then return, 0 for full action.	No	0

At least one PIN must be set. No two PINs may be identical.

Responses

Code	Description
200	Success.
201	Input passed validation. Only returned if validation=1.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
403	Your rate plan does not allow this.

Data returned

The ID of the created conference.

Example: With required parameters

http://enswitch.example.com/api/json/conferences/create/?auth_username=user;auth_password=password;code=123456;talkpin=234567

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123 } }

Change history

Version	Changes
3.13	Function added.