canonical: https://jentic.com/apis/surevoip.co.uk/the-surevoip-restful-api

# Surevoip The SureVoIP RESTful API

Introduction Welcome to the SureVoIP RESTful hypermedia API (sometimes known as a VoIP REST API, Telecom REST API, SIP API, Hypermedia API or just VoIP API.) The SureVoIP API is a way for you to automate your interaction with the SureVoIP platforms. With the API, you can create your own scripts, applications or mashups which can: * List calls * create customers * search numbers * provision numbers. The API exposes 28 endpoints secured with basic, oauth2, openIdConnect authentication.

## For AI agents

Programmatically list global resources, add a new announcement audio file. Covers 28 operations with basic, oauth2, openIdConnect authentication.

## Scope

Does not handle payments, communications, or crm - use for productivity only.

## Capabilities

- List global resources
- Add a new announcement audio file
- Create phone calls with or without announcements and scheduled hangups
- Validate a phone number by calling it once
- Monitor The SureVoIP RESTful API operational status and events

## Use cases

### Productivity Operations

Use the The SureVoIP RESTful API to perform productivity operations programmatically. The API provides 28 endpoints covering core functionality including list global resources, add a new announcement audio file, list global announcements.

Example prompt: Call GET / to list global resources

### Automated announcements Management

Automate announcements operations by combining multiple The SureVoIP RESTful API endpoints. Agents can add a new announcement audio file and then list global announcements in a single workflow.

Example prompt: Call POST /announcements to add a new announcement audio file, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call The SureVoIP RESTful API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle basic, oauth2, openIdConnect tokens manually.

Example prompt: Search Jentic for 'list global resources', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/` | List global resources |
| POST | `/announcements` | Add a new announcement audio file |
| GET | `/announcements` | List global announcements |
| GET | `/areacodes` | List areacodes |
| GET | `/billing` | List global billing detail |
| POST | `/calls` | Create phone calls with or without announcements and scheduled hangups |
| GET | `/calls` | Validate a phone number by calling it once |
| POST | `/charges` | Create charges for invoices |

## Key resources

- **announcements** — Announcements that can be played during or before a call
- **areacodes** — Areacodes of numbers that SureVoIP can supply
- **billing** — Billing details and invoices
- **calls** — Create phone calls via an API
- **charges** — Create a charge for a customer

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 46 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 72 / 100
  - Developer Experience & Jentic Compatibility: 45 / 100
  - AI-Readiness & Agent Experience: 25 / 100
  - Agent Usability: 94 / 100
  - Security: 48 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/surevoip.co.uk/the-surevoip-restful-api/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the SureVoIP RESTful API by hand means supporting HTTP basic auth and its OAuth 2.0 and OpenID Connect flow, choosing between the production and sandbox hosts, and managing retries yourself. Through Jentic you install once, import the SureVoIP RESTful API from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** The SureVoIP operations here work at the collection level, taking their targets in the request body rather than as URL path ids, so scope the agent to the operations it needs, such as listing calls or reading billing. Write operations like creating an announcement or a charge are only in reach if you include them in the allowed set.
- **Credential handling:** Your SureVoIP RESTful API credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list global resources' or 'read the billing summary', and Jentic returns the matching SureVoIP RESTful API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Asana** — Alternative productivity API
- **Monday** — Alternative productivity API
- **Clickup** — Complementary productivity API

## FAQ

### What authentication does the The SureVoIP RESTful API use?

The The SureVoIP RESTful API uses basic, oauth2, openIdConnect authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I list global resources with the The SureVoIP RESTful API?

Yes. Use the GET / endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the The SureVoIP RESTful API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I list global resources through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list global resources'. Jentic returns the matching The SureVoIP RESTful API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the The SureVoIP RESTful API have?

The The SureVoIP RESTful API exposes 28 endpoints covering announcements, areacodes, billing operations.

### Can I limit what my agent is allowed to do with the SureVoIP RESTful API?

Yes. Because you run Jentic One yourself, your own rules decide which SureVoIP operations and credentials the agent can use, and these operations work at the collection level with their targets passed in the request body rather than as URL path ids. You can scope the agent to just the read operations it needs, such as listing calls or reading the billing detail, and leave everything else out of the allowed set. Write operations like creating an announcement or adding a charge are only reachable if you explicitly include them.