Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio Conferences API

10 actions 10 updates phrasing extends openapi/twilio-conferences-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Twilio's API. It is a proposal applied on top of the contract, not a document Twilio publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/v1/Conferences/{ConferenceSid}'].get
$.paths['/v1/Conferences'].get
$.paths['/v1/Conferences/{ConferenceSid}/Participants/{ParticipantSid}'].get
$.paths['/v1/Conferences/{ConferenceSid}/Participants'].get
$.paths['/Accounts/{AccountSid}/Conferences.json'].get
$.paths['/Accounts/{AccountSid}/Conferences/{ConferenceSid}.json'].get
$.paths['/Accounts/{AccountSid}/Conferences/{ConferenceSid}.json'].post
$.paths['/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json'].get
$.paths['/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twilio Conferences API
  version: 1.0.0
extends: openapi/twilio-conferences-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/v1/Conferences/{ConferenceSid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a conference's insights summary
      effect: read
      questions:
      - Why did a particular conference end, and were any quality issues detected?
      - Can I see the after-the-fact insights summary for one conference?
      instructions:
      - text: Get the insights summary for conference {conference_sid}.
        slots:
          conference_sid: path.ConferenceSid
      - text: Show detected issues and end reason for conference {conference_sid}.
        slots:
          conference_sid: path.ConferenceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Conferences'].get
  update:
    x-apievangelist-phrasing:
      intent: Search conference insights summaries
      effect: read
      questions:
      - Which of my conferences had quality or configuration issues detected last week?
      - Can I find conference summaries by mixer region or end reason?
      - What conferences ran in a subaccount between two dates?
      instructions:
      - text: List conference summaries created after {created_after} and before {created_before}.
        slots:
          created_after: query.CreatedAfter
          created_before: query.CreatedBefore
      - text: Find conference summaries with detected issue {detected_issues}.
        slots:
          detected_issues: query.DetectedIssues
      - text: Show insights summaries for conferences mixed in region {mixer_region}.
        slots:
          mixer_region: query.MixerRegion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Conferences/{ConferenceSid}/Participants/{ParticipantSid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one participant's call quality summary
      effect: read
      questions:
      - What call quality metrics did one participant have during a conference?
      - Did a specific participant get muted or put on hold during the conference?
      instructions:
      - text: Get the insights summary for participant {participant_sid} in conference {conference_sid}.
        slots:
          participant_sid: path.ParticipantSid
          conference_sid: path.ConferenceSid
      - text: Show quality metrics {metrics} for participant {participant_sid} of conference {conference_sid}.
        slots:
          metrics: query.Metrics
          participant_sid: path.ParticipantSid
          conference_sid: path.ConferenceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Conferences/{ConferenceSid}/Participants'].get
  update:
    x-apievangelist-phrasing:
      intent: List participant summaries for a conference
      effect: read
      questions:
      - How did each participant's experience look in a past conference?
      - Can I filter a conference's participant summaries by the label I gave them?
      instructions:
      - text: List participant insights summaries for conference {conference_sid}.
        slots:
          conference_sid: path.ConferenceSid
      - text: Show participant summaries labelled {label} in conference {conference_sid}.
        slots:
          label: query.Label
          conference_sid: path.ConferenceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Accounts/{AccountSid}/Conferences.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List conferences on an account
      effect: read
      questions:
      - Which conference calls are in progress on my account right now?
      - Can I look up conference rooms by their friendly name?
      instructions:
      - text: List conferences on account {account_sid} with status {status}.
        slots:
          account_sid: path.AccountSid
          status: query.Status
      - text: Find conference rooms named {friendly_name} on account {account_sid}.
        slots:
          friendly_name: query.FriendlyName
          account_sid: path.AccountSid
      - text: Show conferences created on {date_created} in account {account_sid}.
        slots:
          date_created: query.DateCreated
          account_sid: path.AccountSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Accounts/{AccountSid}/Conferences/{ConferenceSid}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a live conference resource
      effect: read
      questions:
      - Is a particular conference room still in progress?
      - Can I get the current state of a conference resource on my account?
      instructions:
      - text: Get conference {conference_sid} on account {account_sid}.
        slots:
          conference_sid: path.ConferenceSid
          account_sid: path.AccountSid
      - text: Check the current status of conference room {conference_sid} in account {account_sid}.
        slots:
          conference_sid: path.ConferenceSid
          account_sid: path.AccountSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Accounts/{AccountSid}/Conferences/{ConferenceSid}.json'].post
  update:
    x-apievangelist-phrasing:
      intent: End or announce to a live conference
      effect: write
      questions:
      - How do I end a conference call for everyone at once?
      - Can I play an announcement to all participants in an ongoing conference?
      instructions:
      - text: End conference {conference_sid} on account {account_sid} by setting status {status}.
        slots:
          conference_sid: path.ConferenceSid
          account_sid: path.AccountSid
          status: requestBody.Status
      - text: Play the TwiML at {announce_url} to everyone in conference {conference_sid} on account {account_sid}.
        slots:
          announce_url: requestBody.AnnounceUrl
          conference_sid: path.ConferenceSid
          account_sid: path.AccountSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List who is in a live conference
      effect: read
      questions:
      - Who is currently connected to my conference call?
      - Can I see the live participant list for an ongoing conference?
      instructions:
      - text: List the participants currently in conference {conference_sid} on account {account_sid}.
        slots:
          conference_sid: path.ConferenceSid
          account_sid: path.AccountSid
      - text: Show who has joined conference room {conference_sid} for account {account_sid}.
        slots:
          conference_sid: path.ConferenceSid
          account_sid: path.AccountSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Dial someone into a conference
      effect: write
      questions:
      - How do I dial a phone number into an existing conference call?
      - Can I add a participant who joins muted or on hold?
      - Is it possible to record a participant I add to a conference?
      instructions:
      - text: Call {to} from {from} and add them to conference {conference_sid} on account {account_sid}.
        slots:
          to: requestBody.To
          from: requestBody.From
          conference_sid: path.ConferenceSid
          account_sid: path.AccountSid
      - text: Dial {to} into conference {conference_sid} from {from}, joining muted {muted}, on account {account_sid}.
        slots:
          to: requestBody.To
          conference_sid: path.ConferenceSid
          from: requestBody.From
          muted: requestBody.Muted
          account_sid: path.AccountSid
      method: generated
      generated: '2026-09-26'