TWtwilio
Api20100401Conference

Changed on
post/2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json

Request

  • Base URL
    https://api.twilio.com
  • URL
    https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json
  • Auth
    HTTP basic

Path parameters

AccountSidstring required

The SID of the Account that created the Conference resource(s) to update.

Sidstring required

The Twilio-provided string that uniquely identifies the Conference resource to update

Request body application/x-www-form-urlencoded

Status'completed'
AnnounceUrlstring uri

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.

AnnounceMethod'GET' | 'POST' http-method

The HTTP method used to call announce_url. Can be: GET or POST and the default is POST

Response

OK

account_sidstring nullable

The SID of the Account that created this Conference resource.

date_createdstring date-time-rfc-2822 nullable

The date and time in UTC that this resource was created specified in RFC 2822 format.

date_updatedstring date-time-rfc-2822 nullable

The date and time in UTC that this resource was last updated, specified in RFC 2822 format.

api_versionstring nullable

The API version used to create this conference.

friendly_namestring nullable

A string that you assigned to describe this conference room. Maximum length is 128 characters.

regionstring nullable

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.

sidstring nullable

The unique, Twilio-provided string used to identify this Conference resource.

status'init' | 'in-progress' | 'completed'

The status of this conference. Can be: init, in-progress, or completed.

uristring nullable

The URI of this resource, relative to https://api.twilio.com.

subresource_urisobject nullable

A list of related resources identified by their URIs relative to https://api.twilio.com.

reason_conference_ended'conference-ended-via-api' | 'participant-with-end-conference-on-exit-left' | 'participant-with-end-conference-on-exit-kicked' | 'last-participant-kicked' | 'last-participant-left'

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.

call_sid_ending_conferencestring nullable

The call SID that caused the conference to end.

Changes

  • v2010cf63f47f41aaRevision changes
    • breaking

      removed the enum value DELETE of the request property

    • breaking

      removed the enum value HEAD of the request property

    • breaking

      removed the enum value PATCH of the request property

    • breaking

      removed the enum value PUT of the request property