Video Conferences

Schedule Conference

Creates a new extension conference and sends email invitations to the conference participants.

post/v4/accounts/{voip_id}/extensions/{extension_id}/video-conferences

Request

  • Base URL: https://api.phone.com
  • URL: https://api.phone.com/v4/accounts/{voip_id}/extensions/{extension_id}/video-conferences
  • Auth: HTTP bearer

Path parameters

voip_idinteger required
extension_idinteger required

Request body

subjectstring required

Subject / title of the conference

agendastring

Agenda / description of the conference

startstring required

Start date and time in ISO format: YYYY-MM-DDTHH:mm:ss

time_zonestring required

Start date time zone in IANA time zone database format (like 'America/Los_Angeles')

durationinteger

Duration in minutes

auto_record'none' | 'audio' | 'video'

Recording mode: 'none', 'audio', or 'video'.

one_time_access_codeboolean

When set to true, an access code will be returned in the response

auto_transcribeboolean

Whether the recording should automatically be transcribed

mute_mode'conversation' | 'q&a' | 'presentation'

Sets the initial participant mute settings: 'conversation': all muted, 'q&a': all muted, but can unmute, 'presentation': all muted and can't unmute.

Response

Created

object required

Changes

No operation changes recorded.