DIdialpad
meetings

Dialpad Meeting -- Create

Creates a Dialpad meeting.

Requires scope: conference:all

Rate limit: 1200 per minute.

post/api/v2/meetings

Request

  • Base URL
    https://dialpad.com
  • URL
    https://dialpad.com/api/v2/meetings
  • Auth
    HTTP bearer

Request body

call_outboolean nullable

Whether or not the meeting should call the participants.

contact_idsstring[] nullable

The IDs of contacts to invite.

Obtain these from the id field returned by the List contacts endpoint (GET /api/v2/contacts).

durationinteger nullable

Duration of each meeting occurrence in seconds. Defaults to 3600 when omitted.

end_datetimeinteger nullable

The recurrence series cutoff (UTC seconds-since-epoch timestamp).

Only applies to recurring meetings and does not determine the duration of an occurrence.

meeting_idstring nullable

Custom meeting URL slug. Required when meeting_type is CUSTOM_UNIQUE_MEETING.

meeting_type'CUSTOM_UNIQUE_MEETING' | 'LARGE_MEETING' | 'PERSONAL' | 'UNIQUE_MEETING' | 'null' nullable

The meeting's type.

If omitted or null, defaults to UNIQUE_MEETING when unique meetings are enabled and supported for the organizer; otherwise, defaults to PERSONAL.

recurrencestring nullable

How often the meeting should be repeated.

start_datetimeinteger required

The meeting's start time (UTC seconds-since-epoch timestamp).

titlestring required

The meeting's title.

user_idinteger required

The Dialpad user's id.

Response

A successful response

call_outboolean nullable

Whether or not the meeting should call the participants at the beginning of the conference.

dial_in_numberstring nullable

The phone number to dial to join the conference.

durationinteger nullable

The duration of each meeting occurrence in seconds.

end_datetimestring date-time nullable

The meeting's end time.

idstring nullable

The ID of the scheduled conference.

instance_idstring nullable

The ID of the scheduled conference instance.

is_moderatedboolean nullable

Whether or not the meeting is moderated.

meeting_type'CUSTOM_UNIQUE_MEETING' | 'LARGE_MEETING' | 'PERSONAL' | 'UNIQUE_MEETING' | 'null' nullable

The meeting's type.

meeting_urlstring nullable

The URL of the meeting.

organizer_pinstring nullable

The organizer's pin.

participant_pinstring nullable

The participant's pin.

recurrencestring nullable

The number of times the meeting is repeated.

recurrence_end_datestring date-time nullable

The recurrence series cutoff.

start_datetimestring date-time nullable

The meeting's start time.

timezonestring nullable

Timezone using a tz database name.

titlestring nullable

The meeting's title.

Changes

No recorded changes to this operation across all 1 revision of this API.