Ringover · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ringover Public Blacklist API

11 actions 11 updates phrasing extends openapi/ringover-blacklist-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 11

$.info
$.paths['/blacklists/numbers'].get
$.paths['/blacklists/numbers'].post
$.paths['/blacklists/numbers/{phoneNumber}'].get
$.paths['/blacklists/numbers/{phoneNumber}'].delete
$.paths['/blacklists/numbers/{phoneNumber}/comment/{newComment}'].patch
$.paths['/users/{userId}/blacklists/numbers'].get
$.paths['/users/{userId}/blacklists/numbers'].post
$.paths['/users/{userId}/blacklists/numbers/{phoneNumber}'].get
$.paths['/users/{userId}/blacklists/numbers/{phoneNumber}'].delete
$.paths['/users/{userId}/blacklists/numbers/{phoneNumber}/comment/{newComment}'].patch

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 Blacklist API
  version: 1.0.0
extends: openapi/ringover-blacklist-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: 10
- target: $.paths['/blacklists/numbers'].get
  update:
    x-apievangelist-phrasing:
      intent: List numbers on the team blacklist
      effect: read
      questions:
      - Which phone numbers are on our team's shared blacklist?
      - Can I page through the team blacklist entries?
      instructions:
      - text: List the numbers on our team blacklist.
      - text: Show {limit_count} team blacklist numbers starting at offset {limit_offset}.
        slots:
          limit_count: query.limit_count
          limit_offset: query.limit_offset
      method: generated
      generated: '2026-11-20'
- target: $.paths['/blacklists/numbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a number to the team blacklist
      effect: write
      questions:
      - How do I block a spam caller for everyone on my team?
      - Can I add a number to the team blacklist with a comment explaining why?
      instructions:
      - text: Add {number} to the team blacklist.
        slots:
          number: requestBody.number
      - text: Block {number} for all team members because {comment}.
        slots:
          number: requestBody.number
          comment: requestBody.comment
      method: generated
      generated: '2026-11-20'
- target: $.paths['/blacklists/numbers/{phoneNumber}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a number is on the team blacklist
      effect: read
      questions:
      - Is a particular number already on our team blacklist?
      - Can I look up a team blacklist entry by phone number?
      instructions:
      - text: Check whether {phoneNumber} is on the team blacklist.
        slots:
          phoneNumber: path.phoneNumber
      - text: Look up team blacklist entry {phoneNumber}.
        slots:
          phoneNumber: path.phoneNumber
      method: generated
      generated: '2026-11-20'
- target: $.paths['/blacklists/numbers/{phoneNumber}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a number from the team blacklist
      effect: destructive
      questions:
      - How do I unblock a number for everyone on my team?
      - What happens if I remove a number that isn't on the team blacklist?
      instructions:
      - text: Remove {phoneNumber} from the team blacklist.
        slots:
          phoneNumber: path.phoneNumber
      - text: Unblock {phoneNumber} for the whole team.
        slots:
          phoneNumber: path.phoneNumber
      method: generated
      generated: '2026-11-20'
- target: $.paths['/blacklists/numbers/{phoneNumber}/comment/{newComment}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the comment on a team blacklisted number
      effect: write
      questions:
      - Can I change the reason on a team blacklist entry?
      - Is it possible to update the comment for a number already on the team blacklist?
      instructions:
      - text: Change the team blacklist comment on {phoneNumber} to {newComment}.
        slots:
          phoneNumber: path.phoneNumber
          newComment: path.newComment
      - text: Update the reason for blacklisting {phoneNumber} to {newComment}.
        slots:
          phoneNumber: path.phoneNumber
          newComment: path.newComment
      method: generated
      generated: '2026-11-20'
- target: $.paths['/users/{userId}/blacklists/numbers'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's personal blacklist
      effect: read
      questions:
      - Which numbers has a specific user blocked on their own?
      - Can I page through one user's personal blacklist?
      instructions:
      - text: List the personal blacklist of user {userId}.
        slots:
          userId: path.userId
      - text: Show {limit_count} numbers blocked by user {userId}.
        slots:
          limit_count: query.limit_count
          userId: path.userId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/users/{userId}/blacklists/numbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a number to a user's personal blacklist
      effect: write
      questions:
      - How do I block a number for one user only?
      - Can I add a number to a user's blacklist with a comment?
      instructions:
      - text: Add {number} to the personal blacklist of user {userId}.
        slots:
          number: requestBody.number
          userId: path.userId
      - text: Block {number} for user {userId} because {comment}.
        slots:
          number: requestBody.number
          userId: path.userId
          comment: requestBody.comment
      method: generated
      generated: '2026-11-20'
- target: $.paths['/users/{userId}/blacklists/numbers/{phoneNumber}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a number is in a user's blacklist
      effect: read
      questions:
      - Is a number already blocked on a specific user's personal blacklist?
      - Can I check one user's blacklist for a number?
      instructions:
      - text: Check whether {phoneNumber} is in the personal blacklist of user {userId}.
        slots:
          phoneNumber: path.phoneNumber
          userId: path.userId
      - text: Look up user {userId}'s blacklist entry for {phoneNumber}.
        slots:
          userId: path.userId
          phoneNumber: path.phoneNumber
      method: generated
      generated: '2026-11-20'
- target: $.paths['/users/{userId}/blacklists/numbers/{phoneNumber}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a number from a user's blacklist
      effect: destructive
      questions:
      - How do I unblock a number for one user?
      - What if I remove a number from a user's blacklist that they didn't block?
      instructions:
      - text: Remove {phoneNumber} from the personal blacklist of user {userId}.
        slots:
          phoneNumber: path.phoneNumber
          userId: path.userId
      - text: Unblock {phoneNumber} for user {userId}.
        slots:
          phoneNumber: path.phoneNumber
          userId: path.userId
      method: generated
      generated: '2026-11-20'
- target: $.paths['/users/{userId}/blacklists/numbers/{phoneNumber}/comment/{newComment}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the comment on a user's blacklisted number
      effect: write
      questions:
      - Can I change the reason on a user's blacklist entry?
      - Is it possible to update the comment for a number already blocked by a user?
      instructions:
      - text: Change the comment on {phoneNumber} in user {userId}'s blacklist to {newComment}.
        slots:
          phoneNumber: path.phoneNumber
          userId: path.userId
          newComment: path.newComment
      - text: Update the reason for blocking {phoneNumber} on user {userId}'s blacklist to {newComment}.
        slots:
          phoneNumber: path.phoneNumber
          userId: path.userId
          newComment: path.newComment
      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-blacklist-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.