Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zavu Phone Numbers API

The Phone Numbers API from Zavu — 4 operation(s) for phone numbers.

Zavu Phone Numbers API is one of 21 APIs that Zavu publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Phone Numbers. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and rate-limit docs.

This API exposes 7 operations across 4 paths, and defines 15 schemas. It is described by OpenAPI 3.0.3, at version 0.2.0.

Requests are made against a single base URL, https://api.zavu.dev.

7 operations 4 paths 15 schemas 1 DELETE4 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.2.0
Base URL
https://api.zavu.dev/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Zavu Phone Numbers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Phone Numbers 7
GET
/v1/phone-numbers/requirements
Get regulatory requirements
getPhoneNumberRequirements 2 params → 200400401
GET
/v1/phone-numbers/available
Search available phone numbers
searchAvailablePhoneNumbers 4 params → 200400401
POST
/v1/phone-numbers
Purchase a phone number
purchasePhoneNumber body → 201400401402
GET
/v1/phone-numbers
List phone numbers
listPhoneNumbers 3 params → 200401
GET
/v1/phone-numbers/{phoneNumberId}
Get phone number
getPhoneNumber 1 param → 200401404
PATCH
/v1/phone-numbers/{phoneNumberId}
Update phone number
updatePhoneNumber 1 param body → 200400401404
DELETE
/v1/phone-numbers/{phoneNumberId}
Release phone number
releasePhoneNumber 1 param → 204400401404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are OwnedPhoneNumber (10 properties), AvailablePhoneNumber (6 properties), RequirementType (6 properties), Requirement (5 properties). Each schema is shown below with its type and property counts.

AvailablePhoneNumber
object
6 properties 3 required
PhoneNumberUpdateRequest
object
2 properties
PhoneNumberStatus
string
OwnedPhoneNumberPricing
object
4 properties
RequirementType
object
A specific requirement type within a requirement group.
6 properties 4 required
RequirementAcceptanceCriteria
object
Acceptance criteria for a requirement.
4 properties
PhoneNumberType
string
PhoneNumberPricing
object
3 properties
Requirement
object
A group of requirements for a specific country/phone type combination.
5 properties 5 required
PhoneNumberCapabilities
object
3 properties
Error
object
3 properties 2 required
OwnedPhoneNumber
object
10 properties 6 required
PhoneNumberResponse
object
1 property 1 required
RequirementFieldType
string
Type of requirement field.
PhoneNumberPurchaseRequest
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zavu-phone-numbers-api-openapi.yml Raw ↑

Other APIs Zavu publishes across the network.

Zavu 10DLC API
Zavu Account API
Zavu Agent Flows API
Zavu Agent Knowledge Bases API
Zavu Agent Tools API
Zavu Agents API
Zavu Balance API
Zavu Broadcasts API
Zavu Contacts API
Zavu Functions API
Zavu Introspect API
Zavu Invitations API