Update Conference

Update a conference.

put/conferences/{id}

Request

Base URL: https://api.fonestorm.com/v2
URL: https://api.fonestorm.com/v2/conferences/{id}
Auth: API key in header token

Path parameters

idstring required

Conference id

Request body

labelstring

Label of conference

start_timestring date-time

Start time and date of conference

end_timestring date-time

End time and date of conference

fonenumberstring

FoneNumber to use for conference

before_messagestring

Message to play before conference start time

after_messagestring

Message to play after conference end time

max_membersnumber

Maximum number of allowed conference attendees

conference_pinnumber

Conference PIN for attendees

play_soundsboolean

Play member entry and exit sound

record_conferenceboolean

Record conference or not

hold_musicstring

Hold music to play. SoundFile ID or Text to Speech

Response

Success

Example response

{
  "conference": {
    "id": "CON12341234",
    "label": "My Conference",
    "start_time": "2022-03-01 12:00:00",
    "end_time": "2022-03-01 14:00:00",
    "before_message": "Welcome to my conference",
    "after_message": "Thank you for attending",
    "max_members": 10,
    "conference_pin": 1111,
    "play_sounds": true,
    "record_conference": true,
    "hold_music": "SF12341234",
    "moderator_options": {
      "moderator_pin": 1111,
      "terminate_on_exit": true,
      "music_on_hold": true,
      "mute_members": true,
      "wait_for_moderator": true
    }
  }
}

Changes

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