TeXML REST Commands

Update a conference resource

Updates the specified conference resource, for example to modify its status, and returns the updated conference.

post/texml/Accounts/{account_sid}/Conferences/{conference_sid}

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/texml/Accounts/{account_sid}/Conferences/{conference_sid}
  • Auth: HTTP bearer

Path parameters

account_sidstring required
Example:f5586561-8ff0-4291-a51b-c7dfe4139ff9

The UUID of the Telnyx account that owns the resource, for example f5586561-8ff0-4291-a51b-c7dfe4139ff9. The account_sid path segment is kept for Twilio API compatibility, but the value is a Telnyx account UUID, not a Twilio AC... SID. It must match the account that owns the API key used to authenticate the request, otherwise the endpoint returns 404. The same value is sent as AccountSid in TeXML webhooks.

conference_sidstring required

The ConferenceSid that uniquely identifies a conference.

Request body application/x-www-form-urlencoded

Statusstring

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

AnnounceUrlstring

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'

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

Example request

{
  "Status": "completed"
}

Response

Conference resource.

account_sidstring

The id of the account the resource belongs to.

api_versionstring

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

call_sid_ending_conferencestring

Caller ID, if present.

date_createdstring

The timestamp of when the resource was created.

date_updatedstring

The timestamp of when the resource was last updated.

friendly_namestring

A string that you assigned to describe this conference room.

reason_conference_ended'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.

regionstring

A string representing the region where the conference is hosted.

sidstring

The unique identifier of the conference.

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

The status of this conference.

subresource_urisobject

A list of related resources identified by their relative URIs.

uristring

The relative URI for this conference.

Example response

{
  "account_sid": "4e71926f-8f13-450e-b91c-23c2ef786aa6",
  "api_version": "v2/texml",
  "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",
  "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"
}

Changes

No operation changes recorded.