Ringover · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ringover Public Contacts API

14 actions 14 updates phrasing extends openapi/ringover-contacts-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 14

$.info
$.paths['/contacts'].get
$.paths['/contacts'].post
$.paths['/contacts/{contactId}'].get
$.paths['/contacts/{contactId}'].put
$.paths['/contacts/{contactId}'].delete
$.paths['/contacts/{contactId}/shared/toggle'].patch
$.paths['/contacts/{contactId}/firstname/{firstname}'].patch
$.paths['/contacts/{contactId}/lastname/{lastname}'].patch
$.paths['/contacts/{contactId}/company/{company}'].patch
$.paths['/contacts/{contactId}/numbers'].post
$.paths['/contacts/{contactId}/numbers'].delete
$.paths['/contacts/{contactId}/numbers/{number}'].put
$.paths['/contacts/{contactId}/numbers/{number}'].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 Ringover Public Contacts API
  version: 1.0.0
extends: openapi/ringover-contacts-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: 13
- target: $.paths['/contacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List contacts
      effect: read
      questions:
      - How do I list all my contacts and the ones shared with me?
      - Can I search my contacts by name or company?
      instructions:
      - text: List my contacts.
      - text: Find contacts matching {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-11-20'
- target: $.paths['/contacts'].post
  update:
    x-apievangelist-phrasing:
      intent: Retrieve or create contacts
      effect: read
      questions:
      - How do I create new contacts in one request?
      - Can I retrieve contacts using a filter object instead of listing them all?
      instructions:
      - text: Create these new contacts.
      - text: Retrieve contacts matching a filter.
      method: generated
      generated: '2026-11-20'
- target: $.paths['/contacts/{contactId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contact
      effect: read
      questions:
      - How do I look up one contact's full details and phone numbers?
      - What data is returned for a single contact?
      instructions:
      - text: Get contact {contactId}.
        slots:
          contactId: path.contactId
      - text: Show me the phone numbers of contact {contactId}.
        slots:
          contactId: path.contactId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/contacts/{contactId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a contact
      effect: write
      questions:
      - How do I change a contact's first name or company?
      - Does updating a contact replace its phone numbers?
      instructions:
      - text: Update contact {contactId} with first name {firstname}.
        slots:
          contactId: path.contactId
          firstname: requestBody.firstname
      - text: Replace the phone numbers of contact {contactId} with {numbers}.
        slots:
          contactId: path.contactId
          numbers: requestBody.numbers
      method: generated
      generated: '2026-11-20'
- target: $.paths['/contacts/{contactId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contact
      effect: destructive
      questions:
      - How do I permanently delete a contact?
      - Can I remove a contact from my address book?
      instructions:
      - text: Delete contact {contactId}.
        slots:
          contactId: path.contactId
      - text: Remove the contact {contactId} from my address book.
        slots:
          contactId: path.contactId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/contacts/{contactId}/shared/toggle'].patch
  update:
    x-apievangelist-phrasing:
      intent: Share or unshare a contact
      effect: write
      questions:
      - How do I make a contact visible to my team?
      - Can I stop sharing a contact with others?
      instructions:
      - text: Toggle the shared status of contact {contactId}.
        slots:
          contactId: path.contactId
      - text: Make contact {contactId} visible to my team members.
        slots:
          contactId: path.contactId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/contacts/{contactId}/firstname/{firstname}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a contact's first name
      effect: write
      questions:
      - How do I change just a contact's first name?
      - Can I update a contact's first name in the URL path?
      instructions:
      - text: Set the first name of contact {contactId} to {firstname}.
        slots:
          contactId: path.contactId
          firstname: path.firstname
      - text: Rename contact {contactId} to {firstname}.
        slots:
          contactId: path.contactId
          firstname: path.firstname
      method: generated
      generated: '2026-11-20'
- target: $.paths['/contacts/{contactId}/lastname/{lastname}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a contact's last name
      effect: write
      questions:
      - How do I change a contact's last name?
      - Can I update a contact's surname in the path?
      instructions:
      - text: Set the last name of contact {contactId} to {lastname}.
        slots:
          contactId: path.contactId
          lastname: path.lastname
      - text: Rename contact {contactId}'s surname to {lastname}.
        slots:
          contactId: path.contactId
          lastname: path.lastname
      method: generated
      generated: '2026-11-20'
- target: $.paths['/contacts/{contactId}/company/{company}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a contact's company
      effect: write
      questions:
      - How do I change the company name on a contact?
      - Can I update a contact's company in the URL path?
      instructions:
      - text: Set the company of contact {contactId} to {company}.
        slots:
          contactId: path.contactId
          company: path.company
      - text: Rename contact {contactId}'s company to {company}.
        slots:
          contactId: path.contactId
          company: path.company
      method: generated
      generated: '2026-11-20'
- target: $.paths['/contacts/{contactId}/numbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add phone numbers to a contact
      effect: write
      questions:
      - How do I add a new phone number to a contact?
      - Can I add several numbers to a contact at once?
      instructions:
      - text: Add these numbers to contact {contactId}.
        slots:
          contactId: path.contactId
      - text: Append new phone numbers to contact {contactId}.
        slots:
          contactId: path.contactId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/contacts/{contactId}/numbers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all phone numbers of a contact
      effect: destructive
      questions:
      - How do I remove every phone number from a contact?
      - Can I clear all numbers on a contact?
      instructions:
      - text: Delete all phone numbers of contact {contactId}.
        slots:
          contactId: path.contactId
      - text: Clear every number on contact {contactId}.
        slots:
          contactId: path.contactId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/contacts/{contactId}/numbers/{number}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a contact's phone number
      effect: write
      questions:
      - How do I replace an existing phone number on a contact?
      - Can I change a contact's number to a new E.164 number?
      instructions:
      - text: Replace number {number} on contact {contactId} with {new_number}.
        slots:
          number: path.number
          contactId: path.contactId
          new_number: requestBody.number
      - text: Update contact {contactId}'s existing number {number} to {new_number}.
        slots:
          contactId: path.contactId
          number: path.number
          new_number: requestBody.number
      method: generated
      generated: '2026-11-20'
- target: $.paths['/contacts/{contactId}/numbers/{number}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one phone number from a contact
      effect: destructive
      questions:
      - How do I remove a single phone number from a contact?
      - Can I delete one specific number from a contact?
      instructions:
      - text: Delete number {number} from contact {contactId}.
        slots:
          number: path.number
          contactId: path.contactId
      - text: Remove the {number} number on contact {contactId}.
        slots:
          number: path.number
          contactId: path.contactId
      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-contacts-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.