Sample - Twilio API
POST/2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json

Update a conference

Updates a conference resource in the specified account. Supply only the conference properties you want to change, such as its completion status or announcement configuration. The Status field can only complete the conference.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters · 3 body fields
AccountSidstringrequired
The account SID that created the conference. Must be 34 characters and match the `AC` SID format.
Sidstringrequired
The unique identifier of the conference to update.

Optional conference update fields. Send the properties that you want to change.

Statusstringoptional
The conference status. The only accepted value is `completed`.
Allowed:completed
AnnounceUrlstringoptional
The URL we should call to announce something into the conference. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs.
AnnounceMethodstringoptional
The HTTP method used to call `announce_url`. Can be: `GET` or `POST` and the default is `POST`
Allowed:GETPOST

1 status code
200Returns the updated conference object, including its account and conference SIDs, status, region, timestamps, and related resource URIs.
account_sidstringoptional
The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this Conference resource.
date_createdstringoptional
The date and time in UTC that this resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updatedstringoptional
The date and time in UTC that this resource was last updated, specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
api_versionstringoptional
The API version used to create this conference.
friendly_namestringoptional
A string that you assigned to describe this conference room. Maximum length is 128 characters.
regionstringoptional
A string that represents the Twilio Region where the conference audio was mixed. May be `us1`, `us2`, `ie1`, `de1`, `sg1`, `br1`, `au1`, and `jp1`. Basic conference audio will always be mixed in `us1`. Global Conference audio will be mixed nearest to the majority of participants.
sidstringoptional
The unique, Twilio-provided string used to identify this Conference resource.
statusstringoptional
The status of this conference. Can be: `init`, `in-progress`, or `completed`.
Allowed:initin-progresscompleted
uristringoptional
The URI of this resource, relative to `https://api.twilio.com`.
subresource_urisobjectoptional
A list of related resources identified by their URIs relative to `https://api.twilio.com`.
reason_conference_endedstringoptional
The reason why a conference ended. When a conference is in progress, will be `null`. When conference is completed, can be: `conference-ended-via-api`, `participant-with-end-conference-on-exit-left`, `participant-with-end-conference-on-exit-kicked`, `last-participant-kicked`, or `last-participant-left`.
Allowed:conference-ended-via-apiparticipant-with-end-conference-on-exit-leftparticipant-with-end-conference-on-exit-kickedlast-participant-kickedlast-participant-left
call_sid_ending_conferencestringoptional
The call SID that caused the conference to end.

Error handling

AccountSid must be a 34-character account SID beginning with AC, and Status must be completed when provided. AnnounceUrl must be a valid URI, while AnnounceMethod must be either GET or POST.