JSON API » conferences » conferences/update

Updates an existing conference.

Input parameters

Requires authentication and the user role privilege, or administrator if the conference is not owned by the user.

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

No two PINs may be identical.

Responses

Code	Description
201	Input passed validation. Only returned if validation=1.
204	Success.
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.
404	The conference does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: Changing the code

http://enswitch.example.com/api/json/conferences/update/?auth_username=user;auth_password=password;id=123;code=123456

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
3.13	Function added.