undefined

Meetings API

Meetings API allows to schedule conference call with attendees.

A meeting can have a chat dialog associated with it.

A meeting call can be recorded on server and then a file can be downloaded via Web Admin panel.

Meeting model

Parameter Description
_id Meeting identifier
name Meeting name
start_date Date and time when meeting starts
end_date Date and time when meeting ends
attendees Users who will be in meeting
record Whether a meeting should be recorded
chat_dialog_id Meeting chat identifier
host_id Meeting creator user id
created_at Meeting created date.
updated_at Meeting updated date.

Create meeting

Endpoint
POST https://api.connectycube.com/meetings
Parameters
Parameter Required Description Data type Value example
name Yes Meeting name String "Friday weekly sync"
start_date Yes Date when meeting starts Timestamp 1613729948
end_date Yes Date when meeting ends Timestamp 1613829948
attendees Yes Array of meeting participants. id is a ConnectyCube user id. email can be anything. id or email is required Array of objects '{"id": 5243, "email": "example@mail.com"}'
chat No Whether a chat dialog should be created along with a meeting Boolean true
record No Whether a meeting should be recorded Boolean false
Request example
curl -X POST \
-H "Content-Type: application/json" \
-H "CB-Token: <TOKEN>" \
-d '{"name": "Friday weekly sync", "start_date": 1613729948, "end_date": 1613731012, "attendees": [{"id": 245,"email": "email1@domen.com"}, {"id": 343}, {"email": "email2@domen.com"}], "record": false, "chat": true}' \
https://api.connectycube.com/meetings
Response
{
  "_id": "602f926aaa81493ce4c5788e",
  "name": "Friday weekly sync",
  "start_date": 1613729948,
  "end_date": 1613731012,
  "attendees": [
    {
      "id": 245,
      "email": "email1@domen.com"
    },
    {
      "id": 343
    },
    {
      "email": "email2@domen.com"
    }
  ],
  "record": false,
  "chat_dialog_id": "602f9ea20740a24ec238d9da",
  "created_at": "2021-02-19T10:26:50.013Z",
  "updated_at": "2021-02-19T10:26:50.013Z",
  "host_id": 811
}

Retrieve meetings

Endpoint
GET https://api.connectycube.com/meetings
Parameters
Parameter Required Description
_id No Specify to retrieve a specific meeting by id
limit No Setting of limit for a number of results to display. Default - 100
offset No Skip the defined number of records in the results

Without _id parameter specified, a user will retrieve meetings in which a current user is host or attendee.

Request example
curl -X GET \
-H "CB-Token: <TOKEN>" \
https://api.connectycube.com/meetings
Response
[
    {
        "_id": "602f926aaa81493ce4c5788e",
        "name": "Friday weekly sync",
        "start_date": 1613729948,
        "end_date": 1613731012,
        "attendees": [
            {
            "id": 245,
            "email": "email1@domen.com"
            },
            {
            "id": 343
            },
            {
            "email": "email2@domen.com"
            }
        ],
        "record": null,
        "chat_dialog_id": null,
        "created_at": "2021-02-19T10:26:50.013Z",
        "updated_at": "2021-02-19T10:26:50.013Z",
        "host_id": 811
    }
]

Update meeting

A request to update meeting's parameters. Only meeting creator (host) can update a meeting.

Endpoint
PUT https://api.connectycube.com/meetings/{meeting_id}
Parameters
Parameter Required Description Data type Value example
name Yes Meeting name String "New meeting name"
start_date Yes Date when meeting starts Timestamp 1613429948
end_date Yes Date when meeting ends Timestamp 1613329948
attendees Yes Array of meeting participants. id is a ConnectyCube user id. email can be anything. id or email is required Array of objects '{"id": 4123, "email": "example@mail.com"}'
Request example
curl -X PUT \
-H "Content-Type: application/json" \
-H "CB-Token: <TOKEN>" \
-d '{"name": "Another meeting name", "start_date": 1613959948, "end_date": 1613956048, "attendees": [{"id": 1445,"email": "email3@domen.com"}, {"id": 3456 "email": "email4@domen.com"}], "record":true, "chat":true}' \
https://api.connectycube.com/meetings/602f926aaa81493ce4c5788e
Response
{
  "_id": "602f926aaa81493ce4c5788e",
  "name": "Another meeting name",
  "start_date": 1613959948,
  "end_date": 1613956048,
  "attendees": [
    {
      "id": 1445,
      "email": "email3@domen.com"
    },
    {
      "id": 3456
    },
    {
      "email": "email4@domen.com"
    }
  ],
  "record": null,
  "chat_dialog_id": null,
  "created_at": "2021-02-19T10:26:50.013Z",
  "updated_at": "2021-02-19T10:28:50.142Z",
  "host_id": 811
}

Delete meeting

Delete a meeting by ID. Only meeting creator (host) can delete a meeting.

Endpoint
DELETE https://api.connectycube.com/meetings/{meeting_id}
Request example
curl -X DELETE \
-H "CB-Token:  <TOKEN>" \
https://api.connectycube.com/meetings/602f926aaa81493ce4c5788e
Response
200 OK