Meetings

List user meetings

Retrieve a collection of meetings.

GEThttp://127.0.0.1:8888/api/user/meetings

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/user/meetings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 100,
  "items": [
    {
      "id": {},
      "extension_number": "text",
      "mode": "AUDIO",
      "control": "FREE",
      "height": 720,
      "width": 1280,
      "bitrate": 1024,
      "framerate": 15,
      "layout": "LAYOUT0",
      "subject": "text",
      "language": "en-US",
      "capacity": 9,
      "admin_pin": "text",
      "room_pin": "text",
      "enable_recording": false,
      "enable_prompt": true,
      "timezone": "text",
      "created_at": {},
      "scheduled_start_at": {},
      "scheduled_end_at": {},
      "internal_invitees": [
        {}
      ],
      "external_invitees": "text",
      "close_on_nobody": false,
      "outbound_caller_ids": [
        {
          "provider_id": {},
          "caller_id": {},
          "description": "text"
        }
      ],
      "custom_options": "text"
    }
  ]
}

Create a Meeting

Create a meeting.

POSThttp://127.0.0.1:8888/api/user/meetings

Body

application/json

mode*enum

The conference room mode.
Can be either:

• AUDIO: audio conference room.
• VIDEO: video conference room.

AUDIOVIDEO

controlenum

The conference control type.
Can be either:

• FREE: the free mode.
• MASTER: the master mode.

FREEMASTER

heightinteger (int32)

The height for video conference room.
Only valid in VIDEO mode.

widthinteger (int32)

The width for video conference room.
Only valid in VIDEO mode.

bitrateinteger (int32)

The transmission rate for video conference room.
Only valid in VIDEO mode.

framerateinteger

The framerate for video conference room.
Only valid in VIDEO mode.

layoutenum

The number of grids allowed for video conference room.
Only valid in VIDEO mode.
Can be either:

• LAYOUT0:
• LAYOUT1:
• LAYOUT2:
• LAYOUT3:
• LAYOUT4:
• LAYOUT6:
• LAYOUT9:

LAYOUT0LAYOUT1LAYOUT2LAYOUT3LAYOUT4LAYOUT6LAYOUT9

subject*string

The subject of conference room.

languagestring

BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US.

Example: "en-US"

admin_pinstring

The PIN for admin of the conference room. Only numeric sequences are allowed.

room_pinstring

The PIN for the conference room. Only numeric sequences are allowed.

enable_recordingboolean

Whether to enable recording when created.

enable_promptboolean

Whether to enable voice menu.

timezone*string

The IANA Time Zone names, such as "Asia/Shanghai".

scheduled_start_atall of

The scheduled start time of meeting.

scheduled_end_atall of

The scheduled end time of meeting.

internal_inviteesarray of all of

external_inviteesstring

The invitees to send invitation emails to.

close_on_nobodyboolean

Whether to close the meeting if the nobody in.

outbound_caller_idsarray of object

A collection of outbound caller IDs.

custom_optionsstring

Some custom configuration options serialized as json string

Response

2014XX

Created

Body

application/json

idall of

The unique ID of conference room.

extension_numberstring

The extension number.

Pattern: [0-9]{3,64}

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/user/meetings', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "mode": "AUDIO",
      "subject": "text",
      "timezone": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": {},
  "extension_number": "text"
}

Retrieve a meeting

Retrieve a meeting.

GEThttp://127.0.0.1:8888/api/user/meetings/{id}

Path parameters

id*all of

The unique ID of conference room.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of conference room.

extension_numberstring

The extension number.

Pattern: [0-9]{3,64}

modeenum

The conference room mode.
Can be either:

• AUDIO: audio conference room.
• VIDEO: video conference room.

AUDIOVIDEO

controlenum

The conference control type.
Can be either:

• FREE: the free mode.
• MASTER: the master mode.

FREEMASTER

heightinteger (int32)

The height for video conference room.
Only valid in VIDEO mode.

widthinteger (int32)

The width for video conference room.
Only valid in VIDEO mode.

bitrateinteger (int32)

The transmission rate for video conference room.
Only valid in VIDEO mode.

framerateinteger

The framerate for video conference room.
Only valid in VIDEO mode.

layoutenum

The number of grids allowed for video conference room.
Only valid in VIDEO mode.
Can be either:

• LAYOUT0:
• LAYOUT1:
• LAYOUT2:
• LAYOUT3:
• LAYOUT4:
• LAYOUT6:
• LAYOUT9:

LAYOUT0LAYOUT1LAYOUT2LAYOUT3LAYOUT4LAYOUT6LAYOUT9

subjectstring

The subject of conference room.

languagestring

BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US.

Example: "en-US"

capacityinteger (int32)

The maximum number of participants allowed in the room.

admin_pinstring

The PIN for admin of the conference room. Only numeric sequences are allowed.

room_pinstring

The PIN for the conference room. Only numeric sequences are allowed.

enable_recordingboolean

Whether to enable recording when created.

enable_promptboolean

Whether to enable voice menu.

timezonestring

The IANA Time Zone names, such as "Asia/Shanghai".

created_atall of

The creation time of conference room.

scheduled_start_atall of

The scheduled start time of meeting.

scheduled_end_atall of

The scheduled end time of meeting.

internal_inviteesarray of all of

external_inviteesstring

The invitees to send invitation emails to.

close_on_nobodyboolean

Whether to close the meeting if the nobody in.

outbound_caller_idsarray of object

A collection of outbound caller IDs.

custom_optionsstring

Some custom configuration options serialized as json string

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/user/meetings/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": {},
  "extension_number": "text",
  "mode": "AUDIO",
  "control": "FREE",
  "height": 720,
  "width": 1280,
  "bitrate": 1024,
  "framerate": 15,
  "layout": "LAYOUT0",
  "subject": "text",
  "language": "en-US",
  "capacity": 9,
  "admin_pin": "text",
  "room_pin": "text",
  "enable_recording": false,
  "enable_prompt": true,
  "timezone": "text",
  "created_at": {},
  "scheduled_start_at": {},
  "scheduled_end_at": {},
  "internal_invitees": [
    {}
  ],
  "external_invitees": "text",
  "close_on_nobody": false,
  "outbound_caller_ids": [
    {
      "provider_id": {},
      "caller_id": {},
      "description": "text"
    }
  ],
  "custom_options": "text"
}

Update a meeting

Update a meeting

POSThttp://127.0.0.1:8888/api/user/meetings/{id}

Path parameters

id*all of

The unique ID of conference room.

Body

application/json

controlenum

The conference control type.
Can be either:

• FREE: the free mode.
• MASTER: the master mode.

FREEMASTER

heightinteger (int32)

The height for video conference room.
Only valid in VIDEO mode.

widthinteger (int32)

The width for video conference room.
Only valid in VIDEO mode.

bitrateinteger (int32)

The transmission rate for video conference room.
Only valid in VIDEO mode.

framerateinteger

The framerate for video conference room.
Only valid in VIDEO mode.

layoutenum

The number of grids allowed for video conference room.
Only valid in VIDEO mode.
Can be either:

• LAYOUT0:
• LAYOUT1:
• LAYOUT2:
• LAYOUT3:
• LAYOUT4:
• LAYOUT6:
• LAYOUT9:

LAYOUT0LAYOUT1LAYOUT2LAYOUT3LAYOUT4LAYOUT6LAYOUT9

subjectstring

The subject of conference room.

languagestring

BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US.

Example: "en-US"

capacityinteger (int32)

The maximum number of participants allowed in the room.

admin_pinstring

The PIN for admin of the conference room. Only numeric sequences are allowed.

room_pinstring

The PIN for the conference room. Only numeric sequences are allowed.

enable_recordingboolean

Whether to enable recording when created.

enable_promptboolean

Whether to enable voice menu.

timezonestring

The IANA Time Zone names, such as "Asia/Shanghai".

scheduled_start_atall of

The scheduled start time of meeting.

scheduled_end_atall of

The scheduled end time of meeting.

internal_inviteesarray of all of

external_inviteesstring

The invitees to send invitation emails to.

close_on_nobodyboolean

Whether to close the meeting if the nobody in.

outbound_caller_idsarray of object

A collection of outbound caller IDs.

custom_optionsstring

Some custom configuration options serialized as json string

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/user/meetings/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();