Ringover · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ringover Public Sms API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/push/sms'].post
$.paths['/push/sms/v1'].post
$.paths['/sms/opt-out'].post
$.paths['/sms/opt-in'].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 Ringover Public Sms API
  version: 1.0.0
extends: openapi/ringover-sms-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-20'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/push/sms'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an SMS from a team number
      effect: write
      questions:
      - How do I send an SMS from my own phone number?
      - Can I schedule an SMS to go out later?
      instructions:
      - text: Send {content} to {to_number}.
        slots:
          content: requestBody.content
          to_number: requestBody.to_number
      - text: Send {content} from {from_number} to {to_number} at {scheduled_at}.
        slots:
          content: requestBody.content
          from_number: requestBody.from_number
          to_number: requestBody.to_number
          scheduled_at: requestBody.scheduled_at
      method: generated
      generated: '2026-11-20'
- target: $.paths['/push/sms/v1'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a one-way SMS as admin
      effect: write
      questions:
      - Can an admin send a one-way SMS that recipients can't reply to?
      - What's the admin-only way to push a text message?
      instructions:
      - text: Send one-way SMS {content} from the brand {from_alphanum} to {to_number}.
        slots:
          content: requestBody.content
          from_alphanum: requestBody.from_alphanum
          to_number: requestBody.to_number
      - text: Admin {user_id} sends {content} to {to_number} from brand {from_alphanum}.
        slots:
          user_id: requestBody.user_id
          content: requestBody.content
          to_number: requestBody.to_number
          from_alphanum: requestBody.from_alphanum
      method: generated
      generated: '2026-11-20'
- target: $.paths['/sms/opt-out'].post
  update:
    x-apievangelist-phrasing:
      intent: Opt a number out of SMS
      effect: destructive
      questions:
      - How do I stop sending SMS to a number a customer asked to stop?
      - Is there a way to block a number from receiving SMS?
      instructions:
      - text: Opt {phone_number} out of SMS.
        slots:
          phone_number: requestBody.phone_number
      - text: Block all future SMS to {phone_number}.
        slots:
          phone_number: requestBody.phone_number
      method: generated
      generated: '2026-11-20'
- target: $.paths['/sms/opt-in'].post
  update:
    x-apievangelist-phrasing:
      intent: Opt a number back in to SMS
      effect: write
      questions:
      - How do I let a customer receive SMS again after they opted out?
      - Can I undo an SMS opt-out for a number?
      instructions:
      - text: Opt {phone_number} back in to SMS.
        slots:
          phone_number: requestBody.phone_number
      - text: Re-enable SMS to {phone_number}.
        slots:
          phone_number: requestBody.phone_number
      method: generated
      generated: '2026-11-20'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/ringover-sms-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.