Ringover · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Ringover Public Users API
13 actions
13 updates
phrasing
extends
openapi/ringover-users-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.
What the actions change
x-apievangelist-phrasing
Targets 13
$.info
$.paths['/users'].get
$.paths['/users'].post
$.paths['/users/{userId}'].get
$.paths['/users/{userId}'].delete
$.paths['/users/{userId}/profiles/{profileId}'].post
$.paths['/users/{userId}/plannings'].get
$.paths['/users/{userId}/plannings'].put
$.paths['/users/{userId}/plannings/{day}'].put
$.paths['/users/{userId}/presences'].get
$.paths['/users/{userId}/snooze/log'].get
$.paths['/users/{userId}/snooze'].put
$.paths['/users/invite'].post
OpenAPI Overlay
# 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 Users API
version: 1.0.0
extends: openapi/ringover-users-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: 12
- target: $.paths['/users'].get
update:
x-apievangelist-phrasing:
intent: List all team users
effect: read
questions:
- Who are the users on my team?
- Can I see every user's phone number and status?
instructions:
- text: List all users on my team.
- text: Show every team member with their assigned numbers and status.
method: generated
generated: '2026-11-20'
- target: $.paths['/users'].post
update:
x-apievangelist-phrasing:
intent: Create a user by email and number (deprecated)
effect: write
questions:
- How do I add a new user to the team from their email and phone number?
- Is there an older endpoint for creating users from an email address?
instructions:
- text: Create a user with email {email} and phone number {number}.
slots:
email: requestBody.email
number: requestBody.number
- text: Add {email} as a new user on {number} using the deprecated create endpoint.
slots:
email: requestBody.email
number: requestBody.number
method: generated
generated: '2026-11-20'
- target: $.paths['/users/{userId}'].get
update:
x-apievangelist-phrasing:
intent: Get a user's profile and numbers
effect: read
questions:
- What phone numbers and status does a specific user have?
- Can I look up one user's profile by ID?
instructions:
- text: Get user {userId}.
slots:
userId: path.userId
- text: Show the profile, numbers and status of user {userId}.
slots:
userId: path.userId
method: generated
generated: '2026-11-20'
- target: $.paths['/users/{userId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete or archive a user
effect: destructive
questions:
- How do I permanently delete a user's account?
- Can I archive a user instead of deleting them?
instructions:
- text: Delete user {userId}.
slots:
userId: path.userId
- text: Archive user {userId} with type {type}.
slots:
userId: path.userId
type: query.type
method: generated
generated: '2026-11-20'
- target: $.paths['/users/{userId}/profiles/{profileId}'].post
update:
x-apievangelist-phrasing:
intent: Assign a profile to a user
effect: write
questions:
- How do I change a user's telephony profile?
- Does reassigning a profile change how a user handles calls?
instructions:
- text: Assign profile {profileId} to user {userId}.
slots:
profileId: path.profileId
userId: path.userId
- text: Replace the profile of user {userId} with {profileId}.
slots:
userId: path.userId
profileId: path.profileId
method: generated
generated: '2026-11-20'
- target: $.paths['/users/{userId}/plannings'].get
update:
x-apievangelist-phrasing:
intent: Get a user's weekly availability planning
effect: read
questions:
- When is a user available each day of the week?
- Can I see a user's weekly planning with start and end times?
instructions:
- text: Get the weekly planning for user {userId}.
slots:
userId: path.userId
- text: Show when user {userId} is available each day.
slots:
userId: path.userId
method: generated
generated: '2026-11-20'
- target: $.paths['/users/{userId}/plannings'].put
update:
x-apievangelist-phrasing:
intent: Replace a user's full weekly planning
effect: write
questions:
- How do I set a user's availability for the whole week at once?
- What happens if I replace a user's planning with an empty week?
instructions:
- text: Replace the entire weekly planning of user {userId}.
slots:
userId: path.userId
- text: Set a full week of availability for user {userId}.
slots:
userId: path.userId
method: generated
generated: '2026-11-20'
- target: $.paths['/users/{userId}/plannings/{day}'].put
update:
x-apievangelist-phrasing:
intent: Replace a user's planning for one day
effect: write
questions:
- Can I change a user's availability for just one day?
- How do I set a user's planning for a single day of the week?
instructions:
- text: Replace the planning for {day} for user {userId}.
slots:
day: path.day
userId: path.userId
- text: Set user {userId}'s availability on {day}.
slots:
userId: path.userId
day: path.day
method: generated
generated: '2026-11-20'
- target: $.paths['/users/{userId}/presences'].get
update:
x-apievangelist-phrasing:
intent: Get a user's presence status
effect: read
questions:
- Is a user available, on a call or in snooze right now?
- Which device is a user connected from?
instructions:
- text: Get the presence status of user {userId}.
slots:
userId: path.userId
- text: Show whether user {userId} is available, on a call or in snooze.
slots:
userId: path.userId
method: generated
generated: '2026-11-20'
- target: $.paths['/users/{userId}/snooze/log'].get
update:
x-apievangelist-phrasing:
intent: Get a user's snooze history
effect: read
questions:
- When has a user been snoozed and for how long?
- Can I see a user's snooze history?
instructions:
- text: Get the snooze history for user {userId}.
slots:
userId: path.userId
- text: Show the last {limit_count} snooze events for user {userId}.
slots:
limit_count: query.limit_count
userId: path.userId
method: generated
generated: '2026-11-20'
- target: $.paths['/users/{userId}/snooze'].put
update:
x-apievangelist-phrasing:
intent: Snooze a user for a time
effect: write
questions:
- How do I mark a user as unavailable for a while?
- Can I set a snooze that expires automatically?
instructions:
- text: Snooze user {userId} as {name}.
slots:
userId: path.userId
name: requestBody.name
- text: Snooze user {userId} as {name} for {duration} seconds.
slots:
userId: path.userId
name: requestBody.name
duration: requestBody.duration
method: generated
generated: '2026-11-20'
- target: $.paths['/users/invite'].post
update:
x-apievangelist-phrasing:
intent: Invite users to the team
effect: write
questions:
- How do I invite new users to the team by email?
- Does inviting users consume licences?
instructions:
- text: 'Invite these users to the team: {users}.'
slots:
users: requestBody.users
- text: Invite {users} to the team, with me as the inviter {invited_by}.
slots:
users: requestBody.users
invited_by: requestBody.invited_by
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.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/ringover-users-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.