# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Phone SMS API
  version: 1.0.0
extends: openapi/zoom-phone-sms-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/phone/sms/messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an SMS or MMS message
      effect: write
      questions:
      - Can I send a text message from a Zoom Phone number to a customer?
      - Is it possible to attach an image and continue an existing SMS conversation?
      instructions:
      - text: Text {to_members} from {sender} saying {message}.
        slots:
          to_members: requestBody.to_members
          sender: requestBody.sender
          message: requestBody.message
      - text: Reply in SMS session {session_id} from {sender} to {to_members} with attachments {attachments}.
        slots:
          session_id: requestBody.session_id
          sender: requestBody.sender
          to_members: requestBody.to_members
          attachments: requestBody.attachments
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sms/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List SMS conversations across the account
      effect: read
      questions:
      - Which text conversations happened across the whole company this month?
      - Can I filter account SMS sessions by phone number or session type?
      instructions:
      - text: List the account's SMS sessions from {from} to {to}.
        slots:
          from: query.from
          to: query.to
      - text: Show account SMS sessions involving {phone_number}.
        slots:
          phone_number: query.phone_number
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sms/sessions/{sessionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the messages in an SMS session
      effect: read
      questions:
      - Can I read the full message thread of one SMS conversation?
      - Is there a way to see only failed or delivered messages in a session?
      instructions:
      - text: Show the messages in SMS session {sessionId}.
        slots:
          sessionId: path.sessionId
      - text: List messages in session {sessionId} with delivery status {delivery_status}.
        slots:
          sessionId: path.sessionId
          delivery_status: query.delivery_status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sms/sessions/{sessionId}/messages/{messageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one SMS message by ID
      effect: read
      questions:
      - Can I look up a single text message inside a conversation?
      - What details are returned for one specific SMS message?
      instructions:
      - text: Get message {messageId} from SMS session {sessionId}.
        slots:
          messageId: path.messageId
          sessionId: path.sessionId
      - text: Show the single text {messageId} in conversation {sessionId}.
        slots:
          messageId: path.messageId
          sessionId: path.sessionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/sms/sessions/{sessionId}/sync'].get
  update:
    x-apievangelist-phrasing:
      intent: Sync the messages in an SMS session
      effect: read
      questions:
      - Can I fetch only new messages in a conversation since my last sync?
      - How many messages does each SMS session sync call return?
      instructions:
      - text: Sync {count} messages from SMS session {sessionId}.
        slots:
          count: query.count
          sessionId: path.sessionId
      - text: Continue syncing session {sessionId} from token {sync_token}, {count} at a time.
        slots:
          sessionId: path.sessionId
          sync_token: query.sync_token
          count: query.count
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/sms/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's SMS conversations
      effect: read
      questions:
      - Which text conversations does a specific user have?
      - Can I filter a user's SMS sessions by date range or the other party's number?
      instructions:
      - text: List SMS sessions for user {userId}.
        slots:
          userId: path.userId
      - text: Show user {userId}'s SMS sessions with {phone_number} from {from} to {to}.
        slots:
          userId: path.userId
          phone_number: query.phone_number
          from: query.from
          to: query.to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/users/{userId}/sms/sessions/sync'].get
  update:
    x-apievangelist-phrasing:
      intent: Sync a user's SMS sessions newest first
      effect: read
      questions:
      - Can I get a user's conversations ordered most recent first, like the phone app shows?
      - Which sync modes are available for keeping a user's SMS session list current?
      instructions:
      - text: Do a {sync_type} sync of user {userId}'s SMS sessions, newest first.
        slots:
          sync_type: query.sync_type
          userId: path.userId
      - text: Continue the {sync_type} session sync for {userId} from token {sync_token}.
        slots:
          sync_type: query.sync_type
          userId: path.userId
          sync_token: query.sync_token
      method: generated
      generated: '2026-10-01'