JSON API » conferences » conferences/notifications/reset

Removes all notifications for a conference.

Input parameters

Requires authentication and the user role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
conferenceIntegerID of conference.Yes, unless code is specified.0
codeStringCode of conference.Yes, unless conference is specified.Empty string.

Specify conference or code, but not both.

Responses

CodeDescription
204Success.
401The authentication details provided are invalid.
402Your role does not allow this.
404The 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/reset/?auth_username=user;auth_password=password;conference=123

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

Change history

VersionChanges
3.13Function added.