JSON API » conferences » conferences/notifications/create

Adds a notification to a 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
conference	Integer	ID of conference.	Yes, unless code is specified.	0
code	String	Code of conference.	Yes, unless conference is specified.	Empty string.
destination	String	The number or email address to notify.	Yes
level	String	The conference access for numbers. "admin", "talk", or "listen".	Yes
type	String	"email" or "number".	Yes
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Specify conference or code, but not both.

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.
404	The conference does not exist, or you do not have permission to view it.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/conferences/notifications/create/?auth_username=user;auth_password=password;conference=123;type=number;destination=2125551234;level=talk

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

Change history

Version	Changes
3.13	Function added.