Skip to main content

Update a conference resource

POST 
/texml/Accounts/:account_sid/Conferences/:conference_sid

Updates a conference resource.

Request ​

Path Parameters

    account_sid stringrequired

    The id of the account the resource belongs to.

    conference_sid stringrequired

    The ConferenceSid that uniquely identifies a conference.

Body

required

Update Conference request object

    Status string

    The new status of the resource. Specifying completed will end the conference and hang up all participants.

    AnnounceUrl string

    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 string

    Possible values: [GET, POST]

    The HTTP method used to call the AnnounceUrl. Defaults to POST.

Responses ​

200: Conference resource.

Schema

    account_sid string

    The id of the account the resource belongs to.

    api_version string

    The version of the API that was used to make the request.

    call_sid_ending_conference string

    Caller ID, if present.

    date_created string

    The timestamp of when the resource was created.

    date_updated string

    The timestamp of when the resource was last updated.

    friendly_name string

    A string that you assigned to describe this conference room.

    reason_conference_ended string

    Possible values: [participant-with-end-conference-on-exit-left, last-participant-left, conference-ended-via-api, time-exceeded]

    The reason why a conference ended. When a conference is in progress, will be null.

    region string

    A string representing the region where the conference is hosted.

    sid string

    The unique identifier of the conference.

    status string

    Possible values: [init, in-progress, completed]

    The status of this conference.

    subresource_uris object

    A list of related resources identified by their relative URIs.

    uri string

    The relative URI for this conference.

404: Resource not found

Schema

    errors

    object[]

  • Array [

    • detail string

  • ]

Request samples

curl -L -X POST 'https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "account_sid": "4e71926f-8f13-450e-b91c-23c2ef786aa6",
  "api_version": "v2/texml",
  "call_sid_ending_conference": null,
  "date_created": "Fri, 27 Oct 2023 07:41:58 +0000",
  "date_updated": "Fri, 27 Oct 2023 07:41:58 +0000",
  "friendly_name": "weekly_review_call",
  "reason_conference_ended": null,
  "region": "dc2",
  "sid": "cd5a70f4-759b-4d5e-9c06-88c00f16f3c1",
  "status": "in-progress",
  "subresource_uris": {
    "participants": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants.json",
    "recordings": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Recordings.json"
  },
  "uri": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1.json"
}