Ringover · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ringover Public Campaigns API

29 actions 29 updates phrasing extends openapi/ringover-campaigns-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 29 · first 16 shown; the file carries all of them

$.info
$.paths['/campaigns/call'].get
$.paths['/campaigns/call/user'].get
$.paths['/campaigns/call/{campaignscalllistuuid}'].get
$.paths['/campaigns/call/{campaignscalllistuuid}/start'].patch
$.paths['/campaigns/call/{campaignscalllistuuid}/start/edit'].patch
$.paths['/campaigns/call/{campaignscalllistuuid}/stop'].patch
$.paths['/campaigns/call/{campaignscalllistuuid}/reset'].post
$.paths['/campaigns/call/{campaignscalllistuuid}/numbers'].get
$.paths['/campaigns/call/{campaignscalllistuuid}/numbers'].post
$.paths['/campaigns/call/{campaignscalllistuuid}/numbers'].delete
$.paths['/campaigns/call/{campaignscalllistuuid}/numbers'].patch
$.paths['/campaigns/call/{campaignscalllistuuid}/numbers/columns'].post
$.paths['/campaigns/call/{campaignscalllistuuid}/numbers/columns'].delete
$.paths['/campaigns/call/{campaignscalllistuuid}/numbers/columns/rename'].patch
$.paths['/campaigns/call/{campaignscalllistuuid}/numbers/columns/switch'].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 Campaigns API
  version: 1.0.0
extends: openapi/ringover-campaigns-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: 28
- target: $.paths['/campaigns/call'].get
  update:
    x-apievangelist-phrasing:
      intent: List all outbound call campaigns
      effect: read
      questions:
      - Which outbound call campaigns are configured for my team?
      - Can I list only the campaigns that are currently running?
      instructions:
      - text: List all outbound call campaigns.
      - text: List call campaigns where is_running is {is_running}.
        slots:
          is_running: query.is_running
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/user'].get
  update:
    x-apievangelist-phrasing:
      intent: List call campaigns assigned to me
      effect: read
      questions:
      - Which outbound call campaigns are assigned to the user behind my API key?
      - What campaigns do I need to work on right now?
      instructions:
      - text: List the active call campaigns assigned to the current user.
      - text: Show my call campaigns, {limit_count} per page.
        slots:
          limit_count: query.limit_count
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an outbound call campaign
      effect: read
      questions:
      - What are the full settings of a specific outbound call campaign?
      - Can I see the contact queue progress for one campaign?
      instructions:
      - text: Get call campaign {campaignscalllistuuid}.
        slots:
          campaignscalllistuuid: path.campaignscalllistuuid
      - text: Show the full configuration of campaign {campaignscalllistuuid}.
        slots:
          campaignscalllistuuid: path.campaignscalllistuuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/start'].patch
  update:
    x-apievangelist-phrasing:
      intent: Start an outbound call campaign
      effect: write
      questions:
      - How do I start an outbound call campaign so it begins calling contacts?
      - Can I schedule a campaign to start at a later date?
      instructions:
      - text: Start call campaign {campaignscalllistuuid}.
        slots:
          campaignscalllistuuid: path.campaignscalllistuuid
      - text: Start campaign {campaignscalllistuuid} on {start_date}.
        slots:
          campaignscalllistuuid: path.campaignscalllistuuid
          start_date: requestBody.start_date
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/start/edit'].patch
  update:
    x-apievangelist-phrasing:
      intent: Reschedule a campaign's start date
      effect: write
      questions:
      - Can I change the scheduled start time of a campaign that hasn't started yet?
      - How do I reschedule a campaign without restarting it?
      instructions:
      - text: Reschedule the start of campaign {campaignscalllistuuid} to {start_date}.
        slots:
          campaignscalllistuuid: path.campaignscalllistuuid
          start_date: requestBody.start_date
      - text: Edit the scheduled start date of call campaign {campaignscalllistuuid}.
        slots:
          campaignscalllistuuid: path.campaignscalllistuuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/stop'].patch
  update:
    x-apievangelist-phrasing:
      intent: Stop a running call campaign
      effect: write
      questions:
      - How do I stop an outbound call campaign that is still running?
      - Do calls already in progress get interrupted when I stop a campaign?
      instructions:
      - text: Stop call campaign {campaignscalllistuuid}.
        slots:
          campaignscalllistuuid: path.campaignscalllistuuid
      - text: Pause campaign {campaignscalllistuuid} so it stops calling new contacts.
        slots:
          campaignscalllistuuid: path.campaignscalllistuuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset a call campaign to its initial state
      effect: destructive
      questions:
      - Can I clear all call statistics on a campaign and start over from scratch?
      - What happens to contacts that haven't been called yet when I reset a campaign?
      instructions:
      - text: Reset call campaign {campaignscalllistuuid} to its initial state.
        slots:
          campaignscalllistuuid: path.campaignscalllistuuid
      - text: Clear call statistics on campaign {campaignscalllistuuid} and reset retry counts.
        slots:
          campaignscalllistuuid: path.campaignscalllistuuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/numbers'].get
  update:
    x-apievangelist-phrasing:
      intent: List contacts in a call campaign's queue
      effect: read
      questions:
      - Which phone numbers are still in the queue of a call campaign?
      - Can I see the call status and retry count for each contact in a campaign?
      instructions:
      - text: List the contacts in call campaign {campaignscalllistuuid}'s queue.
        slots:
          campaignscalllistuuid: path.campaignscalllistuuid
      - text: Show {limit_count} queued contacts for campaign {campaignscalllistuuid}.
        slots:
          limit_count: query.limit_count
          campaignscalllistuuid: path.campaignscalllistuuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/numbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add contacts to a call campaign's queue
      effect: write
      questions:
      - How do I add new phone numbers to an outbound call campaign?
      - Can I add contacts with custom fields to a campaign's queue?
      instructions:
      - text: Add contacts {to_numbers} to call campaign {campaignscalllistuuid}.
        slots:
          to_numbers: requestBody.to_numbers
          campaignscalllistuuid: path.campaignscalllistuuid
      - text: Bulk add new numbers to the queue of campaign {campaignscalllistuuid}.
        slots:
          campaignscalllistuuid: path.campaignscalllistuuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/numbers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove contacts from a call campaign's queue
      effect: destructive
      questions:
      - How do I remove phone numbers from a call campaign's queue?
      - Can I take a number out of a campaign without deleting the contact?
      instructions:
      - text: Remove contacts {to_numbers} from call campaign {campaignscalllistuuid}'s queue.
        slots:
          to_numbers: query.to_numbers
          campaignscalllistuuid: path.campaignscalllistuuid
      - text: Delete numbers {to_numbers} from campaign {campaignscalllistuuid}.
        slots:
          to_numbers: query.to_numbers
          campaignscalllistuuid: path.campaignscalllistuuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/numbers'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update metadata for call campaign contacts
      effect: write
      questions:
      - Can I change the first name or company on contacts already in a call campaign?
      - How do I edit the metadata of numbers in a campaign's queue?
      instructions:
      - text: Update the metadata of contacts {to_numbers} in call campaign {campaignscalllistuuid}.
        slots:
          to_numbers: requestBody.to_numbers
          campaignscalllistuuid: path.campaignscalllistuuid
      - text: Edit contact information for {to_numbers} in campaign {campaignscalllistuuid}.
        slots:
          to_numbers: requestBody.to_numbers
          campaignscalllistuuid: path.campaignscalllistuuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/numbers/columns'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a custom column to call campaign contacts
      effect: write
      questions:
      - How do I add a new custom field to every contact in a call campaign?
      - Can I give a default value when adding a column to campaign contacts?
      instructions:
      - text: Add a custom column {name} to all contacts in call campaign {campaignscalllistuuid}.
        slots:
          name: requestBody.name
          campaignscalllistuuid: path.campaignscalllistuuid
      - text: Add column {name} to campaign {campaignscalllistuuid} contacts with values {numbers_data}.
        slots:
          name: requestBody.name
          campaignscalllistuuid: path.campaignscalllistuuid
          numbers_data: requestBody.numbers_data
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/numbers/columns'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom column from call campaign contacts
      effect: destructive
      questions:
      - How do I remove a custom column from every contact in a call campaign?
      - Can I delete a column that was added to campaign contacts?
      instructions:
      - text: Delete column {name} from all contacts in call campaign {campaignscalllistuuid}.
        slots:
          name: query.name
          campaignscalllistuuid: path.campaignscalllistuuid
      - text: Remove the {name} column from campaign {campaignscalllistuuid} contacts.
        slots:
          name: query.name
          campaignscalllistuuid: path.campaignscalllistuuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/numbers/columns/rename'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a custom column in call campaign contacts
      effect: write
      questions:
      - Can I rename a custom column on contacts in a call campaign?
      - What happens to existing values when I rename a campaign contact column?
      instructions:
      - text: Rename column {old_name} to {new_name} in call campaign {campaignscalllistuuid} contacts.
        slots:
          old_name: requestBody.old_name
          new_name: requestBody.new_name
          campaignscalllistuuid: path.campaignscalllistuuid
      - text: Change the name of the {old_name} column in campaign {campaignscalllistuuid} contacts.
        slots:
          old_name: requestBody.old_name
          campaignscalllistuuid: path.campaignscalllistuuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/numbers/columns/switch'].patch
  update:
    x-apievangelist-phrasing:
      intent: Swap the position of two custom columns
      effect: write
      questions:
      - Can I change which custom column appears first on contacts in a call campaign?
      - How do I reorder two columns in a campaign's contact data?
      instructions:
      - text: Swap the positions of columns {column1} and {column2} in call campaign {campaignscalllistuuid} contacts.
        slots:
          column1: requestBody.column1
          column2: requestBody.column2
          campaignscalllistuuid: path.campaignscalllistuuid
      - text: Move column {column1} before column {column2} in campaign {campaignscalllistuuid} contacts.
        slots:
          column1: requestBody.column1
          column2: requestBody.column2
          campaignscalllistuuid: path.campaignscalllistuuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/name/{newname}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a call campaign
      effect: write
      questions:
      - How do I change the display name of an outbound call campaign?
      - Can I rename a campaign without touching its contacts or settings?
      instructions:
      - text: Rename call campaign {campaignscalllistuuid} to {newname}.
        slots:
          campaignscalllistuuid: path.campaignscalllistuuid
          newname: path.newname
      - text: Change the name of campaign {campaignscalllistuuid} to {newname}.
        slots:
          campaignscalllistuuid: path.campaignscalllistuuid
          newname: path.newname
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/maxretry/{newMaxRetry}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a campaign's maximum retry attempts
      effect: write
      questions:
      - How do I make a campaign retry each contact more times?
      - Can I reset all contacts' retry counters when I change the max retry limit?
      instructions:
      - text: Set the maximum retry attempts on call campaign {campaignscalllistuuid} to {newMaxRetry}.
        slots:
          campaignscalllistuuid: path.campaignscalllistuuid
          newMaxRetry: path.newMaxRetry
      - text: Change campaign {campaignscalllistuuid} max retry to {newMaxRetry}.
        slots:
          campaignscalllistuuid: path.campaignscalllistuuid
          newMaxRetry: path.newMaxRetry
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List groups assigned to a call campaign
      effect: read
      questions:
      - Which call groups are assigned to a specific campaign?
      - How are contacts in a campaign distributed to agents?
      instructions:
      - text: List the groups assigned to call campaign {campaignscalllistuuid}.
        slots:
          campaignscalllistuuid: path.campaignscalllistuuid
      - text: Show which call groups campaign {campaignscalllistuuid} sends contacts to.
        slots:
          campaignscalllistuuid: path.campaignscalllistuuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign groups to a call campaign
      effect: write
      questions:
      - How do I assign call groups to a campaign so agents can receive its calls?
      - Can I add several groups to a campaign at once?
      instructions:
      - text: Assign groups {to_groups} to call campaign {campaignscalllistuuid}.
        slots:
          to_groups: requestBody.to_groups
          campaignscalllistuuid: path.campaignscalllistuuid
      - text: Add call groups {to_groups} to campaign {campaignscalllistuuid}.
        slots:
          to_groups: requestBody.to_groups
          campaignscalllistuuid: path.campaignscalllistuuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/groups'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove groups from a call campaign
      effect: destructive
      questions:
      - How do I stop certain call groups from receiving a campaign's calls?
      - Can I remove a group from a campaign without deleting the group itself?
      instructions:
      - text: Remove groups {to_groups} from call campaign {campaignscalllistuuid}.
        slots:
          to_groups: query.to_groups
          campaignscalllistuuid: path.campaignscalllistuuid
      - text: Take call groups {to_groups} off campaign {campaignscalllistuuid}.
        slots:
          to_groups: query.to_groups
          campaignscalllistuuid: path.campaignscalllistuuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users assigned to a call campaign
      effect: read
      questions:
      - Which individual users are assigned to a call campaign, not just through groups?
      - Can I page through a campaign's direct user assignments?
      instructions:
      - text: List users directly assigned to call campaign {campaign}.
        slots:
          campaign: path.campaignscalllistuuid
      - text: Show {count} users assigned to campaign {campaign}, skipping {offset}.
        slots:
          count: query.limit_count
          campaign: path.campaignscalllistuuid
          offset: query.limit_offset
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign individual users to a call campaign
      effect: write
      questions:
      - How do I add specific agents to a call campaign?
      - Can I assign several users to a campaign at once?
      instructions:
      - text: Assign users {to_Users} to call campaign {campaign}.
        slots:
          to_Users: requestBody.to_Users
          campaign: path.campaignscalllistuuid
      - text: Add {to_Users} as direct agents on campaign {campaign}.
        slots:
          to_Users: requestBody.to_Users
          campaign: path.campaignscalllistuuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/users'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove individual users from a call campaign
      effect: destructive
      questions:
      - How do I take agents off a call campaign?
      - Can I remove several users from a campaign at once?
      instructions:
      - text: Remove users {to_Users} from call campaign {campaign}.
        slots:
          to_Users: query.to_Users
          campaign: path.campaignscalllistuuid
      - text: Take {to_Users} off campaign {campaign} so they stop getting calls.
        slots:
          to_Users: query.to_Users
          campaign: path.campaignscalllistuuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/tags'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace all tags on a call campaign
      effect: write
      questions:
      - How do I set the exact tag set on a call campaign?
      - Does replacing a campaign's tags remove tags I leave out?
      instructions:
      - text: Replace all tags on call campaign {campaign} with {tags}.
        slots:
          campaign: path.campaignscalllistuuid
          tags: requestBody.tags
      - text: Set the tag list of campaign {campaign} to {tags}.
        slots:
          campaign: path.campaignscalllistuuid
          tags: requestBody.tags
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/tags'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove all tags from a call campaign
      effect: destructive
      questions:
      - How do I clear every tag from a call campaign?
      - Can I remove all tags from a campaign in one call?
      instructions:
      - text: Remove all tags from call campaign {campaign}.
        slots:
          campaign: path.campaignscalllistuuid
      - text: Clear every tag on campaign {campaign}.
        slots:
          campaign: path.campaignscalllistuuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/tags/{tagID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one tag from a call campaign
      effect: destructive
      questions:
      - How do I take a single tag off a call campaign?
      - Can I keep other tags while removing one from a campaign?
      instructions:
      - text: Remove tag {tagID} from call campaign {campaign}.
        slots:
          tagID: path.tagID
          campaign: path.campaignscalllistuuid
      - text: Keep campaign {campaign} but drop tag {tagID}.
        slots:
          campaign: path.campaignscalllistuuid
          tagID: path.tagID
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/script'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign or remove a call script
      effect: write
      questions:
      - How do I give agents a call script during a campaign?
      - Can I remove the script from a campaign?
      instructions:
      - text: Assign call script {script_uuid} to campaign {campaign}.
        slots:
          script_uuid: requestBody.script_uuid
          campaign: path.campaignscalllistuuid
      - text: Remove the call script from campaign {campaign}.
        slots:
          campaign: path.campaignscalllistuuid
      method: generated
      generated: '2026-11-20'
- target: $.paths['/campaigns/call/{campaignscalllistuuid}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a call campaign's audit log
      effect: read
      questions:
      - Who started, stopped or reset a call campaign?
      - Can I audit changes made to a campaign?
      instructions:
      - text: Show the audit log for call campaign {campaign}.
        slots:
          campaign: path.campaignscalllistuuid
      - text: List every change made to campaign {campaign}.
        slots:
          campaign: path.campaignscalllistuuid
      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-campaigns-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.