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

Telnyx Whatsapp Phone Numbers API

Manage Whatsapp phone numbers

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

Tagged areas include Whatsapp Phone Numbers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 12 operations across 8 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

12 operations 8 paths 13 schemas 2 DELETE4 GET2 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Telnyx Whatsapp Phone Numbers API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 12

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

Whatsapp Phone Numbers 12

Manage Whatsapp phone numbers

POST
/v2/whatsapp/business_accounts/{id}/phone_numbers
Initialize Whatsapp phone number verification
InitializeWhatsappVerification 1 param body → 2044XX
GET
/v2/whatsapp/phone_numbers
List Whatsapp phone numbers
ListPhoneNumbers 1 param → 2004XX
DELETE
/v2/whatsapp/phone_numbers/{phone_number}
Delete a Whatsapp phone number
DeleteWhatsappPhoneNumber 1 param → 2044XX
GET
/v2/whatsapp/phone_numbers/{phone_number}/calling_settings
Get calling settings for a phone number
GetWhatsappCallingSettings 1 param → 2004XX
PATCH
/v2/whatsapp/phone_numbers/{phone_number}/calling_settings
Enable or disable Whatsapp calling for a phone number
PatchWhatsappCallingSettings 1 param body → 2004XX
GET
/v2/whatsapp/phone_numbers/{phone_number}/profile
Get phone number business profile
GetWhatsappProfile 1 param → 2004XX
PATCH
/v2/whatsapp/phone_numbers/{phone_number}/profile
Update phone number business profile
PatchWhatsappProfile 1 param body → 2004XX
DELETE
/v2/whatsapp/phone_numbers/{phone_number}/profile/photo
Delete Whatsapp profile photo
DeleteWhatsappProfilePhoto 1 param → 2044XX
GET
/v2/whatsapp/phone_numbers/{phone_number}/profile/photo
Get Whatsapp profile photo
GetWhatsappProfilePhoto 1 param → 2004XX
POST
/v2/whatsapp/phone_numbers/{phone_number}/profile/photo
Upload Whatsapp profile photo
PostWhatsappProfilePhoto 1 param body → 2004XX
POST
/v2/whatsapp/phone_numbers/{phone_number}/resend_verification
Resend verification code
ResendWhatsappVerification 1 param body → 2044XX
POST
/v2/whatsapp/phone_numbers/{phone_number}/verify
Submit verification code for a phone number
VerifyWhatsappPhoneNumber 1 param body → 2044XX

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are WhatsappProfileData (14 properties), WhatsappPhoneResponse (11 properties), WhatsappUpdateProfileRequest (8 properties), messaging_Error (5 properties). Each schema is shown below with its type and property counts.

WhatsappProfilePhotoResponse
object
1 property
WhatsappProfileData
object
14 properties
WhatsappVerifyCodeRequest
object
1 property 1 required
WhatsappResendVerificationRequest
object
1 property
WhatsappPhoneResponse
object
11 properties
WhatsappCallingSettingsData
object
4 properties
messaging_Errors
object
1 property
WhatsappPhoneNumberVerificationRequest
object
4 properties 2 required
messaging_PaginationMeta
object
4 properties 4 required
WhatsappProfilePhotoData
object
3 properties
WhatsappPatchCallingSettingsRequest
object
1 property 1 required
messaging_Error
object
5 properties 2 required
WhatsappUpdateProfileRequest
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-whatsapp-phone-numbers-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
Telnyx Addresses API
Telnyx Advanced Number Orders API
Telnyx Assistants API
Telnyx Audio API
Telnyx Audit Logs API
Telnyx Authentication Providers API
Telnyx AutoRechargePreferences API
Telnyx Billing API
Telnyx Billing Groups API
Telnyx Brands API
Telnyx Bucket SSL Certificate API