Slack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Slack Calls API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/calls.end'].post
$.paths['/calls.info'].get
$.paths['/calls.participants.remove'].post
$.paths['/calls.update'].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 Slack Calls API
  version: 1.0.0
extends: openapi/slack-calls-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: 4
- target: $.paths['/calls.end'].post
  update:
    x-apievangelist-phrasing:
      intent: End a call
      effect: write
      questions:
      - How does my app mark a Slack call as ended?
      - Can I record how long a call lasted when ending it?
      instructions:
      - text: End call {id}.
        slots:
          id: requestBody.id
      - text: End call {id} with a duration of {duration} seconds.
        slots:
          id: requestBody.id
          duration: requestBody.duration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/calls.info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details about a call
      effect: read
      questions:
      - What information is available about a registered call?
      - Can I look up a call's participants and join URL?
      instructions:
      - text: Get the details of call {id}.
        slots:
          id: query.id
      - text: Show information about call {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/calls.participants.remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Register participants who left a call
      effect: write
      questions:
      - How do I tell Slack that someone left a call?
      - Can several participants be removed from a call at once?
      instructions:
      - text: Remove users {users} from call {id}.
        slots:
          users: requestBody.users
          id: requestBody.id
      - text: Register that {users} left call {id}.
        slots:
          users: requestBody.users
          id: requestBody.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/calls.update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a call's title or join links
      effect: write
      questions:
      - Can I change a call's title after it started?
      - Is it possible to update the desktop join link for a call?
      instructions:
      - text: Rename call {id} to {title}.
        slots:
          id: requestBody.id
          title: requestBody.title
      - text: Set the join URL of call {id} to {join_url}.
        slots:
          id: requestBody.id
          join_url: requestBody.join_url
      - text: Update call {id}'s desktop app join link to {desktop_app_join_url}.
        slots:
          id: requestBody.id
          desktop_app_join_url: requestBody.desktop_app_join_url
      method: generated
      generated: '2026-09-26'