JSON API » conferences » conferences/get

Gets the fields of a conference. The notifications are not returned; use conferences/notifications/list for that.

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 get.	Yes, unless code is specified.	0
code	String	Code of conference to get.	Yes, unless id is specified.	Empty string.

Specify id or code, but not both.

Responses

Code	Description
200	Success.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The conference does not exist, or you do not have permission to view it.

Data returned

Fields of conference.

Example: With required parameters

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

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

Change history

Version	Changes
3.13	Function added.