# The SureVoIP RESTful API API

> The SureVoIP RESTful API API on Apizie: 30 endpoints (List global resources, List global announcements, Add a new announcement audio file, List areacodes, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/communication:surevoip-co-uk/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `communication:surevoip-co-uk`
- Category: Communication
- Status: byok
- Source: https://www.surevoip.co.uk/contact-surevoip
- Page: https://apizie.tech/api/communication/surevoip-co-uk
- OpenAPI: https://apizie.tech/api/communication/surevoip-co-uk/openapi.json

# 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…

## Endpoints

### List global resources
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| hypermedia | string | no | Disable Hypermedia |
| content-type | string | no | Content Type |

### List global announcements
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-announcements` (byok)

### Add a new announcement audio file
`POST https://apizie.tech/v1/communication:surevoip-co-uk/post-announcements` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

### List areacodes
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-areacodes` (byok)

### List global billing detail
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-billing` (byok)

### Validate a phone number by calling it once
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-calls` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| validate | integer | no | Validate a phone number by calling it for one ring. Note; not 100% proof the number is in service. |

### Create phone calls with or without announcements and scheduled hangups
`POST https://apizie.tech/v1/communication:surevoip-co-uk/post-calls` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List charges
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-charges` (byok)

### Create charges for invoices
`POST https://apizie.tech/v1/communication:surevoip-co-uk/post-charges` (byok)

### List contacts
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-contacts` (byok)

### List all customers or find your own account
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-customers` (byok)

### Represents a customer
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account | integer | yes | Account ID of customer |

### List of announcement audio files
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-customers-account-announcements` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account | integer | yes | Account ID of customer |

### Represents an announcement audio file
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-customers-account-announcements-announcement-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| announcement_id | string | yes | Announcement ID of audio file |
| account | string | yes | Path parameter {account} |

### Delete an announcement audio file
`POST https://apizie.tech/v1/communication:surevoip-co-uk/delete-customers-account-announcements-announcement-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account | string | yes | Path parameter {account} |
| announcement_id | string | yes | Path parameter {announcement_id} |

### List global ongoing faxes
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-faxes` (byok)

### List Hosted VoIP domains
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-hosted` (byok)

### Return the IP address from where your API request originated
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-ip-address` (byok)

### List mobile accounts
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-mobile` (byok)

### List available SureVoIP Ofcom number allocations for purchase
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-numbers` (byok)

### Search available numbers by areacode
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-numbers-areacodes` (byok)

### List SureVoIP Partner accounts
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-partners` (byok)

### List ported numbers
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-porting` (byok)

### List all Service Status messages
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-service-status` (byok)

### List all SIP accounts
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-sip` (byok)

### List SMS
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-sms` (byok)

### Return your POSTed data for testing
`POST https://apizie.tech/v1/communication:surevoip-co-uk/post-support-echo` (byok)

### Return the IP address from where your API request originated
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-support-ip-address` (byok)

### List all Service Status messages
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-support-service-status` (byok)

### List all account credit topups
`GET https://apizie.tech/v1/communication:surevoip-co-uk/get-topups` (byok)

## Example
```
curl "https://apizie.tech/v1/communication:surevoip-co-uk/get" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the The SureVoIP RESTful API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/communication:surevoip-co-uk/get with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the The SureVoIP RESTful API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. The SureVoIP RESTful API itself also needs your own key from surevoip.co.uk.

### Can AI agents use the The SureVoIP RESTful API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key communication:surevoip-co-uk.

### What is the status of the The SureVoIP RESTful API API?
Needs your own provider key (bring your own key)