Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Telephony Provider Configuration API

6 actions 6 updates phrasing extends openapi/strivacity-telephony-provider-configuration-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Strivacity's API. It is a proposal applied on top of the contract, not a document Strivacity publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/admin/api/v1/instance/telephony/providers'].get

$.paths['/admin/api/v1/instance/telephony/providers'].post

$.paths['/admin/api/v1/instance/telephony/providers/{providerId}'].get

$.paths['/admin/api/v1/instance/telephony/providers/{providerId}'].put

$.paths['/admin/api/v1/instance/telephony/providers/{providerId}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin Portal Telephony Provider Configuration API
  version: 1.0.0
extends: openapi/strivacity-telephony-provider-configuration-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: 5
- target: $.paths['/admin/api/v1/instance/telephony/providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List telephony service providers
      effect: read
      questions:
      - Which SMS and voice telephony providers are configured on my instance?
      - Can I search telephony service providers by name?
      instructions:
      - text: List all configured telephony service providers.
      - text: Find the telephony provider named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/telephony/providers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a telephony service provider
      effect: write
      questions:
      - How do I connect a new SMS gateway for sending one-time passcodes?
      - Can I configure more than one telephony service provider?
      instructions:
      - text: Create a new telephony service provider configuration.
      - text: Add an SMS gateway for sending passcodes.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/telephony/providers/{providerId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a telephony service provider
      effect: read
      questions:
      - How do I view the settings of one telephony provider configuration?
      - What is configured on a specific SMS provider?
      instructions:
      - text: Show telephony service provider {providerId}.
        slots:
          providerId: path.providerId
      - text: Get the configuration of telephony provider {providerId}.
        slots:
          providerId: path.providerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/telephony/providers/{providerId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a telephony service provider
      effect: write
      questions:
      - How do I change the settings of a telephony provider that already exists?
      - Can I edit a telephony service provider configuration?
      instructions:
      - text: Update telephony service provider {providerId}.
        slots:
          providerId: path.providerId
      - text: Edit the existing configuration of telephony provider {providerId}.
        slots:
          providerId: path.providerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/telephony/providers/{providerId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a telephony service provider
      effect: destructive
      questions:
      - How do I remove a telephony provider configuration I no longer use?
      - Can I delete an old SMS gateway setup?
      instructions:
      - text: Delete telephony service provider {providerId}.
        slots:
          providerId: path.providerId
      - text: Remove the SMS gateway configuration {providerId}.
        slots:
          providerId: path.providerId
      method: generated
      generated: '2026-10-01'