/
appointment_videocall_control ()

appointment_videocall_control ()

Owned by Pedro Jose Sanchez Luling, created
Feb 01, 2024
2 min read

Function prototype

appointment_videocall_control (session, ref , action, member_ref, parameters)

API Version

2.7.32 and higher

Supported interfaces

SOAP, REST

Description

Executes an action in an appointment (e.g. grant access to a member)

This function can be use to control several aspects of an appointment. For example:

  • Grant/Deny access to a member that is waiting in the lobby

  • Kick off a member

  • Terminate the appointment

Required permissions: The active user must have role XXXX. 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

  • action: action requested. See the available actions in Action types.

  • member_ref: reference to a member affected by the action (depends on the type of action). See how this parameter is used depending on the Action types.

  • parameters: additional parameters that depend on the Action types.

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_control ( “LCAAAAAAAAAAAA”, "GRANT_ACCESS", null)

Response

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

Return Error codes

ERROR CODE

 

ERROR CODE

 

INVALID_TOKEN

The session token provided is not valid

INSUFFICIENT_PRIVILEGES

The session user does not have the necessary privileges to …

Appointment action types

Action

 

member_ref

parameters

Action

 

member_ref

parameters

GRANT_ACCESS

Grants access to a member (or all) that is waiting in the lobby

Specify the reference of the member that is accepted, or null to accept all members waiting in the lobby

none

DENY_ACCESS

Denies access to a member (or all) that is waiting in the lobby

Specify the reference of the member that is rejected, or null to reject all members waiting in the lobby

none

KICK_OFF

Kick off a member of the appointment

Specify the reference of the member that is kicked off, or null to kick iff all members

none

TERMINATE

Terminate a video call

ignored

none

Related content