Function prototype	appointment_videocall_leave (session, ref, [reason = “ENDED”])
API Version	2.7.32 and higher
Supported interfaces	SOAP, REST

Description

Leave an appointment

Use this function to leave an appointment after having requested access by means of the appointment_videocall_join () function.

If the function is called without having joined previously, the function will ignore the request and will not generate any error.

Required permissions: The active user must be a member of the appointment. Otherwise an INSUFFICIENT_PRIVILEGES error will be returned.

Input parameters:

session: is the session token obtained in the session_init() call
ref: Reference of the appointment
reason: Reason why the member is leaving the video call. Possible values:
- “LEFT”: The participant left the meeting voluntarily
- “KICKED”: The participant was kicked off the video call by the owner
- “ENDED”: The owner terminated the video call so all participants are obliged to leave
- “REJECTED”: The request to join from the lobby was rejected by the owner

Output parameters:

result: empty
ErrorMsg: If any error occurs, then this value contains a description of the error translated to the current language
ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

Request example

appointment_videocall_leave ( “LCAAAAAAAAAAAA”, 73823)

The response format is XML when the function has been invoked via the SOAP API, and JSON when it has been invoked via the REST API

ERROR CODE

ERROR CODE
INVALID_TOKEN	The session token provided is not valid
INSUFFICIENT_PRIVILEGES	The session user is not member of the appointment