Ringover · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ringover Public WhatsApp API

10 actions 10 updates phrasing extends openapi/ringover-whatsapp-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 10

$.info
$.paths['/whatsapp/templates/send'].post
$.paths['/whatsapp/templates'].post
$.paths['/whatsapp/templates/{template_uuid}'].put
$.paths['/whatsapp/templates/{template_uuid}'].delete
$.paths['/whatsapp/accounts'].get
$.paths['/whatsapp/{account_uuid}/templates'].get
$.paths['/whatsapp/conversations'].post
$.paths['/whatsapp/messages'].post
$.paths['/whatsapp/conversations/{conversation_uuid}/messages'].get

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 WhatsApp API
  version: 1.0.0
extends: openapi/ringover-whatsapp-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: 9
- target: $.paths['/whatsapp/templates/send'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a WhatsApp template message
      effect: write
      questions:
      - How do I send a WhatsApp template message to a customer's number?
      - Can I pass variables into a WhatsApp template when I send it?
      - Does sending a WhatsApp template count as a template message for Meta billing?
      instructions:
      - text: Send WhatsApp template {template_uuid} to {external_number}.
        slots:
          template_uuid: requestBody.template_uuid
          external_number: requestBody.external_number
      - text: Send template {template_uuid} to {external_number} with variables {variables}.
        slots:
          template_uuid: requestBody.template_uuid
          external_number: requestBody.external_number
          variables: requestBody.variables
      method: generated
      generated: '2026-11-20'
- target: $.paths['/whatsapp/templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a WhatsApp message template
      effect: write
      questions:
      - How do I create a WhatsApp template for marketing messages?
      - What naming rules apply to WhatsApp templates?
      - Can I build a WhatsApp template from structured components instead of plain text?
      instructions:
      - text: Create WhatsApp template {name} on account {account_uuid}.
        slots:
          name: requestBody.name
          account_uuid: requestBody.account_uuid
      - text: Create template {name} on {account_uuid} with components {components}.
        slots:
          name: requestBody.name
          account_uuid: requestBody.account_uuid
          components: requestBody.components
      method: generated
      generated: '2026-11-20'
- target: $.paths['/whatsapp/templates/{template_uuid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a WhatsApp template
      effect: write
      questions:
      - How do I change the category of an existing WhatsApp template?
      - Does updating a WhatsApp template replace its components entirely?
      instructions:
      - text: Update template {template_uuid} to category {category} with components {components}.
        slots:
          template_uuid: path.template_uuid
          category: requestBody.category
          components: requestBody.components
      - text: Change the category of WhatsApp template {template_uuid} to {category}.
        slots:
          template_uuid: path.template_uuid
          category: requestBody.category
      method: generated
      generated: '2026-11-20'
- target: $.paths['/whatsapp/templates/{template_uuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a WhatsApp template
      effect: destructive
      questions:
      - How do I delete a WhatsApp template I no longer use?
      - Can I remove a WhatsApp template by its UUID?
      instructions:
      - text: Delete WhatsApp template {template_uuid}.
        slots:
          template_uuid: path.template_uuid
      - text: Remove the WhatsApp template with UUID {template_uuid}.
        slots:
          template_uuid: path.template_uuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/whatsapp/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List WhatsApp accounts
      effect: read
      questions:
      - Which WhatsApp accounts are linked to my Ringover user?
      - What WhatsApp numbers can I send messages from?
      instructions:
      - text: List my WhatsApp accounts.
      - text: Show every WhatsApp number linked to my user.
      method: generated
      generated: '2026-11-20'
- target: $.paths['/whatsapp/{account_uuid}/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List WhatsApp templates for an account
      effect: read
      questions:
      - What WhatsApp templates are available on a particular WhatsApp account?
      - Can I see all message templates for one WhatsApp number?
      instructions:
      - text: List WhatsApp templates for account {account_uuid}.
        slots:
          account_uuid: path.account_uuid
      - text: Show the message templates on WhatsApp number {account_uuid}.
        slots:
          account_uuid: path.account_uuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/whatsapp/conversations'].post
  update:
    x-apievangelist-phrasing:
      intent: List WhatsApp conversations
      effect: read
      questions:
      - How do I see the WhatsApp conversations my WhatsApp account is handling?
      - Can I page through WhatsApp conversations for one account?
      instructions:
      - text: List WhatsApp conversations for account {account_uuid}.
        slots:
          account_uuid: requestBody.account_uuid
      - text: Show {limit_count} WhatsApp conversations starting at offset {limit_offset}.
        slots:
          limit_count: requestBody.limit_count
          limit_offset: requestBody.limit_offset
      method: generated
      generated: '2026-11-20'
- target: $.paths['/whatsapp/messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a text message in an existing WhatsApp conversation
      effect: write
      questions:
      - How do I reply to a customer in an existing WhatsApp conversation?
      - Can I send a plain text message inside an open WhatsApp chat?
      instructions:
      - text: Send {data} in WhatsApp conversation {conversation_uuid}.
        slots:
          data: requestBody.data
          conversation_uuid: requestBody.conversation_uuid
      - text: Reply to the existing WhatsApp chat {conversation_uuid} with {data}.
        slots:
          conversation_uuid: requestBody.conversation_uuid
          data: requestBody.data
      method: generated
      generated: '2026-11-20'
- target: $.paths['/whatsapp/conversations/{conversation_uuid}/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the message history of a WhatsApp conversation
      effect: read
      questions:
      - How do I read the message history of a WhatsApp conversation?
      - Can I fetch older WhatsApp messages by message UUID?
      instructions:
      - text: Get the message history of WhatsApp conversation {conversation_uuid}.
        slots:
          conversation_uuid: path.conversation_uuid
      - text: Show {limit_count} WhatsApp messages older than {last_message_uuid} in conversation {conversation_uuid}.
        slots:
          limit_count: query.limit_count
          last_message_uuid: query.last_message_uuid
          conversation_uuid: path.conversation_uuid
      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-whatsapp-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.