Page tree
Skip to end of metadata
Go to start of metadata

API : Meeting (Persistent Room) Resources

For meeting resources, you will require to set your API Key persistent mode to true.

DELETE /rest/meetings/:mid

Description

Deletes the scheduled meeting from a Persistent room from an Application key from the authenticated user.

URI Parameters
  • mid< string >: The scheduled meeting id.
Parameters

None

Return Format
  • status < integer >: The status that indicates success or failure
    • value = 0: Failure state. This displays message.
    • value = 1: Success state.

  • message < string >: Error message when status is unsuccessful.
Example DELETE Request Body

No example parameters to show.

GET /rest/meetings/:apiKey/:room

Description

Gets the list of meetings scheduled for the Persistent room from an Application Key from the authenticated user.

URI Parameters
  • apiKey < string >: The Application Key id.

  • room < string >: The room name.
Parameters

None

Return Format
  • status < integer >: The status that indicates success or failure
    • value = 0: Failure state. This displays message.
    • value = 1: Success state. This displays content.

  • message < string >: Error message when status is unsuccessful.

  • content < array >: The list of meetings scheduled for the Persistent Room for the Application Key.

    • (#index) < JSON >: The meeting information.

      • mid < string >: The scheduled meeting id.

      • created < integer >: The created datetime in seconds.

      • api < string >: The Application Key tied to the meeting.

      • rid < string >: The room name tied to the meeting.

      • start < integer >: The start datetime of the meeting in seconds.

      • end < integer >: The end datetime of the meeting in seconds.
Example GET Request Body

No example parameters to show.

GET /rest/meetings/:apiKey

Description

Retrieve a list of meetings scheduled for all Persistent rooms from an Application Key.

URI Parameters
  • apiKey _< string >: The Application Key id.
Parameters

None

Return Format
  • status < integer >: The status that indicates success or failure
    • value = 0: Failure state. This displays message.
    • value = 1: Success state. This displays content.

  • message < string >: Error message when status is unsuccessful.

  • content < array >: The list of meetings scheduled from all Persistent Rooms for the Application Key.

    • (#index) < JSON >: The meeting information.

      • mid < string >: The scheduled meeting id.

      • created < integer >: The created datetime in seconds.

      • api < string >: The Application Key tied to the meeting.

      • rid < string >: The room name tied to the meeting.

      • start < integer >: The start datetime of the meeting in seconds.

      • end < integer >: The end datetime of the meeting in seconds.
Example GET Request Body

No example to show.

POST /rest/meetings/

Description

Schedules a new meeting for a Persistent room from an Application Key from the authenticated user.

Parameters
  • api < string >: The Application Key.

  • rid < string >: The room name.

  • start < string >: The scheduled datetime in (ISO format).

  • len < integer >: The duration of the meeting (in hours).
Return Format
  • status < integer >: The status that indicates success or failure
    • value = 0: Failure state. This displays message.
    • value = 1: Success state. This displays content.

  • message < string >: Error message when status is unsuccessful.

  • content < array >: The scheduled meeting created.

    • mid < string >: The scheduled meeting id.

    • created < integer >: The created datetime in seconds.

    • api < string >: The Application Key tied to the meeting.

    • rid < string >: The room name tied to the meeting.

    • start < integer >: The start datetime of the meeting in seconds.

    • end < integer >: The end datetime of the meeting in seconds.
Example POST Request Body

For Content-Type: application/json example, here's the values passed:

{
  "api": "api_key",
  "rid": "myRoomName",
  "start": "2014-08-10",
  "len": 2,
}

For Content-Type: application/x-www-form-urlencoded; charset=UTF-8 example, here's the values passed:

?&api=api_key&rid=myRoomName&start=2014-08-10&len=2
  • No labels