Cameo meetings

>>>

GET /api/v3/cameo_meetings
List Cameo Meetings

Returns all cameo meetings associated with your company

Examples

{
  "total_records": integer,
  "page_number": integer,
  "page_size": integer,
  "data": [
    {
      "id": integer,
      "name": string,
      "description": text,
      "internal_ref_num": string,
      "timezone": string,
      "starts_at": datetime,
      "ends_at": datetime,
      "zoom_meeting_id": string,
      "created_by_id": integer,
      "created_at": datetime,
      "updated_at": datetime,
      "uuid": string,
      "canceled_at": datetime,
      "status": string,
      "confirmed_at": datetime,
      "reactivated_at": datetime,
      "is_unlicensed_notified": boolean,
      "unlicensed_notified_at": datetime,
      "is_licensed": boolean,
      "is_licensed_at": datetime,
      "zoom_log_starts_at": datetime,
      "zoom_log_ends_at": datetime,
      "witness_name": string,
      "zoom_meeting_uuid": string,
      "white_glove": boolean,
      "creator": {
        "email": string,
        "first_name": string,
        "last_name": string,
      },
      "users": [
        {
          "id": integer,
          "email": string,
          "invitation_sent_at": datetime,
        },
      ]
      "zoom_room": {
        "id": integer,
        "name": string,
      }
    },
    ...
  ]
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
after_date
optional

Meetings starting after. Format YYYY-MM-DD

Validations:

  • Must be a String
before_date
optional

Meetings starting before. Format YYYY-MM-DD

Validations:

  • Must be a String
page_number
optional

Page Number

Validations:

  • Must be a Integer
page_size
optional

Page Size (default 30)

Validations:

  • Must be a Integer
internal_ref_num
optional

Internal Ref Num

Validations:

  • Must be a String
>>>

GET /api/v3/cameo_meetings/:id
Find Cameo Meeting

Returns all of a Cameo Meetings attributes

Errors

Code Description
404 Cameo Meeting not found

Examples

200 Response
{
  "id": integer,
  "name": string,
  "description": text,
  "internal_ref_num": string,
  "timezone": string,
  "starts_at": datetime,
  "ends_at": datetime,
  "zoom_meeting_id": string,
  "created_by_id": integer,
  "created_at": datetime,
  "updated_at": datetime,
  "uuid": string,
  "canceled_at": datetime,
  "status": string,
  "confirmed_at": datetime,
  "reactivated_at": datetime,
  "is_unlicensed_notified": boolean,
  "unlicensed_notified_at": datetime,
  "is_licensed": boolean,
  "is_licensed_at": datetime,
  "zoom_log_starts_at": datetime,
  "zoom_log_ends_at": datetime,
  "witness_name": string,
  "zoom_meeting_uuid": string,
  "white_glove": boolean,
  "creator": {
    "email": string,
    "first_name": string,
    "last_name": string,
  },
  "users": [
    {
      "id": integer,
      "email": string,
      "invitation_sent_at": datetime,
    },
  ]
  "zoom_room": {
    "id": integer,
    "name": string,
  }
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

ID of the cameo meeting

Validations:

  • Must be a Integer
>>>

POST /api/v3/cameo_meetings
Create Cameo Meeting

Creates a Cameo Meeting

Errors

Code Description
300 Error creating Cameo Meeting
422 Unable to process request, see errors in response

Metadata

Example Request Params Format:
  name: Name for Cameo Meeting
  description: Description for Cameo Meeting
  internal_ref_num: 'job #1527483'
  witness_name: Some Person
  timezone: Eastern Time (US & Canada)
  starts_at_date: 05/04/2022
  starts_at_time: 01:15 PM
  ends_at_date: 05/04/2022
  ends_at_time: 02:15 PM
  users_attributes:
    '0':
      email: test_user@company.com
    '1':
      email: test_user@company.com

Examples

{
  "id": integer,
  "name": string,
  "description": text,
  "internal_ref_num": string,
  "timezone": string,
  "starts_at": datetime,
  "ends_at": datetime,
  "zoom_meeting_id": string,
  "created_by_id": integer,
  "created_at": datetime,
  "updated_at": datetime,
  "uuid": string,
  "canceled_at": datetime,
  "status": string,
  "confirmed_at": datetime,
  "reactivated_at": datetime,
  "is_unlicensed_notified": boolean,
  "unlicensed_notified_at": datetime,
  "is_licensed": boolean,
  "is_licensed_at": datetime,
  "zoom_log_starts_at": datetime,
  "zoom_log_ends_at": datetime,
  "witness_name": string,
  "zoom_meeting_uuid": string,
  "white_glove": boolean,
  "creator": {
    "email": string,
    "first_name": string,
    "last_name": string,
  },
  "users": [
    {
      "id": integer,
      "email": string,
      "invitation_sent_at": datetime,
    },
  ]
  "zoom_room": {
    "id": integer,
    "name": string,
  }
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
status
optional

Meeting Status. Default status is pending

Validations:

  • Must be one of: pending, confirmed.
zoom_room_id
optional

Zoom Room ID

Validations:

  • Must be a Integer
name
required

Case Name

Validations:

  • Must be a String
description
optional

Validations:

  • Must be a String
internal_ref_num
optional

Job Number

Validations:

  • Must be a String
witness_name
optional

Validations:

  • Must be a String
password
optional

Password for Cameo Meeting. Minimum 4 characters.

Validations:

  • Must be a Integer
starts_at_date
required

Starting Date of first CameoMeeting

Validations:

  • Must be a String


Metadata: 
- Example formatting
- 05/04/2022
starts_at_time
required

Starting Time of first CameoMeeting

Validations:

  • Must be a String


Metadata: 
- Example formatting
- 1:00 PM
ends_at_date
required

Starting Date of first CameoMeeting

Validations:

  • Must be a String


Metadata: 
- Example formatting
- 05/04/2022
ends_at_time
required

Starting Time of first CameoMeeting

Validations:

  • Must be a String


Metadata: 
- Example formatting
- 05/04/2022
time_zone
required

Validations:

  • Must be a String


Metadata: 
- Alaska
- Arizona
- Central Time (US & Canada)
- Eastern Time (US & Canada)
- Hawaii
- Mountain Time (US & Canada)
- Pacific Time (US & Canada)
white_glove
optional

White Glove Service

Validations:

  • Must be a String
users_attributes
required

CameoMeeting users

Validations:

  • Must be a Hash


Metadata: 
users_attributes:
  '0':
    email: test_user@company.com
  '1':
    email: test_user@company.com
users_attributes[index]
required

Index for user

Validations:

  • Must be a Hash
users_attributes[index][email]
required

Email for the user

Validations:

  • Must be a String
>>>

PATCH /api/v3/cameo_meetings/:id
Update Cameo Meeting

Updates a Cameo Meeting

Errors

Code Description
300 Error updating Cameo Meeting
404 Cameo Meeting not found
422 Unable to process request, see errors in response

Metadata

Example Request Params Format:
  name: Name for Cameo Meeting
  description: Description for Cameo Meeting
  internal_ref_num: 'job #1527483'
  witness_name: Some Person
  timezone: Eastern Time (US & Canada)
  starts_at_date: 05/04/2022
  starts_at_time: 01:15 PM
  ends_at_date: 05/04/2022
  ends_at_time: 02:15 PM
  users_attributes:
    '0':
      email: test_user@company.com
    '1':
      email: test_user@company.com

Examples

{
  "id": integer,
  "name": string,
  "description": text,
  "internal_ref_num": string,
  "timezone": string,
  "starts_at": datetime,
  "ends_at": datetime,
  "zoom_meeting_id": string,
  "created_by_id": integer,
  "created_at": datetime,
  "updated_at": datetime,
  "uuid": string,
  "canceled_at": datetime,
  "status": string,
  "confirmed_at": datetime,
  "reactivated_at": datetime,
  "is_unlicensed_notified": boolean,
  "unlicensed_notified_at": datetime,
  "is_licensed": boolean,
  "is_licensed_at": datetime,
  "zoom_log_starts_at": datetime,
  "zoom_log_ends_at": datetime,
  "witness_name": string,
  "zoom_meeting_uuid": string,
  "white_glove": boolean,
  "creator": {
    "email": string,
    "first_name": string,
    "last_name": string,
  },
  "users": [
    {
      "id": integer,
      "email": string,
      "invitation_sent_at": datetime,
    },
  ]
  "zoom_room": {
    "id": integer,
    "name": string,
  }
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

ID of the Cameo Meeting

Validations:

  • Must be a Integer
status
optional

Meeting Status. Default status is pending

Validations:

  • Must be one of: confirmed, canceled.
name
required

Case Name

Validations:

  • Must be a String
description
optional

Validations:

  • Must be a String
internal_ref_num
optional

Job Number

Validations:

  • Must be a String
witness_name
optional

Validations:

  • Must be a String
password
optional

Password for Cameo Meeting. Minimum 4 characters.

Validations:

  • Must be a Integer
starts_at_date
required

Starting Date of first CameoMeeting

Validations:

  • Must be a String


Metadata: 
- Example formatting
- 05/04/2022
starts_at_time
required

Starting Time of first CameoMeeting

Validations:

  • Must be a String


Metadata: 
- Example formatting
- 1:00 PM
ends_at_date
required

Starting Date of first CameoMeeting

Validations:

  • Must be a String


Metadata: 
- Example formatting
- 05/04/2022
ends_at_time
required

Starting Time of first CameoMeeting

Validations:

  • Must be a String


Metadata: 
- Example formatting
- 05/04/2022
time_zone
required

Validations:

  • Must be a String


Metadata: 
- Alaska
- Arizona
- Central Time (US & Canada)
- Eastern Time (US & Canada)
- Hawaii
- Mountain Time (US & Canada)
- Pacific Time (US & Canada)
white_glove
optional

White Glove Service

Validations:

  • Must be a String
users_attributes
required

CameoMeeting users

Validations:

  • Must be a Hash


Metadata: 
users_attributes:
  '0':
    email: test_user@company.com
  '1':
    email: test_user@company.com
users_attributes[index]
required

Index for user

Validations:

  • Must be a Hash
users_attributes[index][email]
required

Email for the user

Validations:

  • Must be a String
>>>

GET /api/v3/cameo_meetings/:id/send_email
Send Email Cameo Meeting Recipients

Sends Email to Cameo Meeting Recipient(s)

Errors

Code Description
300 Error sending email to Cameo Meeting Recipients
404 Cameo Meeting not found
422 Unable to process request, see errors in response

Examples

{
  "message": "Email sent successfully to Cameo Meeting Recipient(s)"
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
>>>

GET /api/v3/cameo_meetings/:id/license
Add license to a Cameo Meeting

Add license to Cameo Meeting

Errors

Code Description
300 Error adding license to a Cameo Meetind
404 Cameo Meeting not found
422 Unable to process request, see errors in response

Examples

{
  "message": "License added to Cameo Meeting successfully"
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

ID of the cameo meeting

Validations:

  • Must be a Integer
>>>

GET /api/v3/cameo_meetings/:id/password
Get Password of a Cameo Meeting

Get Password of a Cameo Meeting

Errors

Code Description
404 Cameo Meeting not found
422 Unable to process request, see errors in response

Examples

{
  "id": integer,
  "password": string,
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

ID of the cameo meeting

Validations:

  • Must be a Integer
>>>

GET /api/v3/cameo_meetings/:id/host_key
Get Host Key of a Cameo Meeting

Get Host Key of a Cameo Meeting

Errors

Code Description
404 Cameo Meeting not found
422 Unable to process request, see errors in response

Examples

{
  "id": integer,
  "host_key": string,
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

ID of the cameo meeting

Validations:

  • Must be a Integer
>>>

GET /api/v3/cameo_meetings/:id/confirm
Confirm Cameo Meeting

Confirm Cameo Meeting

Errors

Code Description
404 Cameo Meeting not found
422 Unable to process request, see errors in response

Examples

{
  "message": "Cameo Meeting confirmed successfully"
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

ID of the cameo meeting

Validations:

  • Must be a Integer
>>>

GET /api/v3/cameo_meetings/:id/cancel
Cancel Cameo Meeting

Cancel Cameo Meeting

Errors

Code Description
404 Cameo Meeting not found
422 Unable to process request, see errors in response

Examples

{
  "message": "Cameo Meeting canceled successfully"
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

ID of the cameo meeting

Validations:

  • Must be a Integer
>>>

GET /api/v3/cameo_meetings/:id/join_info
All links & information to join a meeting

All links & information to join a meeting

Errors

Code Description
404 Cameo Meeting not found
422 Unable to process request, see errors in response

Examples

{
  "host_url": string,
  "participant_url": string,
  "host_key": string,
  "password": string,
  "meeting_id": string,
  "phone_number": string,
  "ip_url": string,
  "sip_url": string
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

ID of the cameo meeting

Validations:

  • Must be a Integer
>>>

GET /api/v3/cameo_meetings/:id/summary
Summary of meeting information once it has ended

Summary of meeting information once it has ended

Errors

Code Description
404 Cameo Meeting not found
422 Unable to process request, see errors in response

Examples

{
  "id": integer,
  "topic": string,
  "host": string,
  "start_time": string,
  "end_time": string,
  "duration": string,
  "participants": string,
  "has_pstn": string,
  "has_archiving": string,
  "has_voip": string,
  "has_3rd_party_audio": string,
  "has_video": string,
  "has_screen_share": string,
  "has_recording": string,
  "has_sip": string,
  "dept": string,
  "has_manual_captions": string,
  "has_automated_captions": string,
  "has_meeting_summary": string
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

ID of the cameo meeting

Validations:

  • Must be a Integer
>>>

GET /api/v3/cameo_meetings/:id/zoom_join_link
Get Zoom Join Link of a Cameo Meeting with Encrypted Password

Get Zoom Join Link of a Cameo Meeting

Errors

Code Description
404 Cameo Meeting not found
422 Unable to process request, see errors in response

Examples

{
  "id": integer,
  "zoom_join_link": string,
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

ID of the cameo meeting

Validations:

  • Must be a Integer