/
appointment_videocall_join ()

appointment_videocall_join ()

Owned by Pedro Jose Sanchez Luling, created
Last updated: Feb 06, 2024
2 min read

Function prototype

appointment_videocall_join (session, ref)

API Version

2.7.32 and higher

Supported interfaces

SOAP, REST

Description

Request to join an appointment by video or audio call

A member of an appointment can use this function to obtain the connection parameters required to join a video or audio call.

Depending on the configuration of the appointment, the response may be:

  • Direct connection is allowed: this means that the member can bypass the lobby and can join directly the appointment

  • Stay in the lobby: The member can’t join directly the conference and needs to be accepted by the owner. Depending on the implementation of the client application requesting the access, the notification can be obtained in one of the following ways:

    • If the client has subscribed to receive notifications using the API function alert_subscribe () , then an alert will be sent to the callback configured.

    • Continue asking access using appointment_join() to check whether the access has already been granted

Required permissions: The active user must be a member invited to 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

Output parameters:

  • result: Information to access the appointment

    • status: Status of the request to join. Possible values:

      • “CONNECTED”: Access to the appointment has been granted

      • “LOBBY”: Access to the appointment has not been granted yet. Wait in the lobby until the authorization is received

      • “REJECTED”: The owner of the appointment has denied access to the member

      • “KICKED”: The owner of the appointment kicked off the member from the meeting

    • connection_info: Contains the information that the client application must use to join the appointment. This information is only provider when the access to the appointment has been granted

      • provider: Name of the provider of the Video/Audio call service

      • settings: Information specific of the provider containing the parameters required to establish a connection. This information is provided as a JSON formatted string. See VIDEO CALL Provider configuration for additional details depending on the supported providers.

  • 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_join ( “LCAAAAAAAAAAAA”, 8845)

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 request joining the appointment



Related content