GET /api/v3/cameo_rooms
List Cameo Rooms

Also see v3#cameo_rooms#show.

Returns all Cameo Rooms associated with your company

Examples

[
  {
    "id": "integer"
    "pmi": "integer",
    "created_at": "datetime",
    "updated_at": "datetime",
    "name": "string",
    "enabled": "boolean",
    "access_code": "string",
    "description": "string",
    "publicly_accessible": "boolean",
  },
  ...
]

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String


GET /api/v3/cameo_rooms/:id
Find Cameo Room

Returns all of a Cameo Room attributes

Errors

Code Description
404 Cameo Room not found

Examples

201 Response
{
  "id": "integer"
  "pmi": "integer",
  "created_at": "datetime",
  "updated_at": "datetime",
  "name": "string",
  "enabled": "boolean",
  "access_code": "string",
  "description": "string",
  "publicly_accessible": "boolean",
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String

id
required

ID of the Cameo Room

Validations:

  • Must be a Integer


PATCH /api/v3/cameo_rooms/:id
Update Cameo Room

Returns all of a Cameo Room settings

Errors

Code Description
300 Error updating Cameo Room
404 Cameo Room not found
501 Not Implemented

Examples

201 Response
{
  TODO
}

300 Response
{
  TODO
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String

id
required

ID of the Cameo Room

Validations:

  • Must be a Integer


GET /api/v3/cameo_rooms/:id/recordings
Find Recordings for Cameo Room

Return Recordings for a Cameo Room

Errors

Code Description
404 Cameo Room not found
400 Bad request

Examples

{
  "recordings": [
    {
      "uuid": string,
      "id": integer,
      "account_id": string,
      "host_id": string,
      "topic": string,
      "type": integer,
      "start_time": string,
      "timezone": string,
      "duration": integer,
      "total_size": integer,
      "recording_count": integer,
      "share_url": string,
      "recording_files": [
        {
          "id": string,
          "meeting_id": string,
          "recording_start": string",
          "recording_end": string,
          "file_type": string,
          "file_extension": string,
          "file_size": integer,
          "play_url": string,
          "download_url": string,
          "status": string
          "recording_type": string,
        }
      ],
    },
    ...
  ],
  "total_count": integer
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String

id
required

ID of the Cameo Room

Validations:

  • Must be a Integer

from
required

Start Date. Format YYYY-MM-DD. Maximum range is 30 days

Validations:

  • Must be a String

to
required

End Date. Format YYYY-MM-DD. Maximum range is 30 days

Validations:

  • Must be a String