Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Active Telephony Provider Configuration API

5 actions 5 updates phrasing extends openapi/strivacity-active-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 5

$.info
$.paths['/admin/api/v1/instance/telephony/activeProviders'].get
$.paths['/admin/api/v1/instance/telephony/activeProviders/{activeProviderChannel}'].get
$.paths['/admin/api/v1/instance/telephony/activeProviders/{activeProviderChannel}'].post
$.paths['/admin/api/v1/instance/telephony/activeProviders/{activeProviderChannel}'].delete

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 Admin Portal Active Telephony Provider Configuration API
  version: 1.0.0
extends: openapi/strivacity-active-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: 4
- target: $.paths['/admin/api/v1/instance/telephony/activeProviders'].get
  update:
    x-apievangelist-phrasing:
      intent: List the active telephony providers per channel
      effect: read
      questions:
      - Which telephony provider is currently active for SMS and voice?
      - How can I see which providers are actually in use right now?
      instructions:
      - text: List the active telephony service providers.
      - text: Show which telephony provider is live on each channel.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/telephony/activeProviders/{activeProviderChannel}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the active telephony provider for a channel
      effect: read
      questions:
      - Which provider is sending messages on a particular channel?
      - How do I check the active telephony provider for SMS?
      instructions:
      - text: Show the active telephony provider for channel {activeProviderChannel}.
        slots:
          activeProviderChannel: path.activeProviderChannel
      - text: Get which provider is active on the {activeProviderChannel} channel.
        slots:
          activeProviderChannel: path.activeProviderChannel
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/telephony/activeProviders/{activeProviderChannel}'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a telephony provider for a channel
      effect: write
      questions:
      - How do I switch which telephony provider sends my SMS passcodes?
      - Does activating a new telephony provider deactivate the previous one?
      instructions:
      - text: Activate a telephony provider on channel {activeProviderChannel}.
        slots:
          activeProviderChannel: path.activeProviderChannel
      - text: Make a configured provider the active one for {activeProviderChannel}.
        slots:
          activeProviderChannel: path.activeProviderChannel
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/instance/telephony/activeProviders/{activeProviderChannel}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Deactivate the telephony provider for a channel
      effect: destructive
      questions:
      - How do I turn off the active telephony provider for a channel?
      - Can I stop sending through any provider on a channel?
      instructions:
      - text: Deactivate the telephony provider on channel {activeProviderChannel}.
        slots:
          activeProviderChannel: path.activeProviderChannel
      - text: Turn off the active {activeProviderChannel} provider.
        slots:
          activeProviderChannel: path.activeProviderChannel
      method: generated
      generated: '2026-10-01'