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 Campaign API

Campaign operations

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

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

This API exposes 13 operations across 11 paths, and defines 16 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.

13 operations 11 paths 16 schemas 1 DELETE8 GET3 POST1 PUT

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 Campaign 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 13

Across 11 paths, the API surfaces 13 operations — 1 DELETE, 8 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Campaign 13

Campaign operations

GET
/10dlc/campaign
List Campaigns
GetCampaigns 4 params → 2004224XX
POST
/10dlc/campaign/acceptSharing/{campaignId}
Accept Shared Campaign
AcceptCampaign 1 param → 2024224XX
GET
/10dlc/campaign/usecase/cost
Get Campaign Cost
GetCampaignCost 1 param → 2004224XX
DELETE
/10dlc/campaign/{campaignId}
Deactivate campaign
DeactivateCampaign 1 param → 2004224XX
GET
/10dlc/campaign/{campaignId}
Get campaign
GetCampaign 1 param → 2004224XX
PUT
/10dlc/campaign/{campaignId}
Update campaign
UpdateCampaign 1 param body → 2004224XX
POST
/10dlc/campaign/{campaignId}/appeal
Submit campaign appeal for manual review
AppealCampaign 1 param body → 2004004044224XX
GET
/10dlc/campaign/{campaignId}/mnoMetadata
Get Campaign Mno Metadata
GetCampaignMnoMetadata 1 param → 2004XX5XX
GET
/10dlc/campaign/{campaignId}/operationStatus
Get campaign operation status
GetCampaignOperationStatus 1 param → 2004224XX
GET
/10dlc/campaign/{campaignId}/osr/attributes
Get OSR campaign attributes
GetCampaignOsrAttributes 1 param → 2004224XX
GET
/10dlc/campaign/{campaignId}/sharing
Get Sharing Status
GetCampaignSharingStatus 1 param → 2004224XX
POST
/10dlc/campaignBuilder
Submit Campaign
PostCampaign body → 2004004024224XX
GET
/10dlc/campaignBuilder/brand/{brandId}/usecase/{usecase}
Qualify By Usecase
GetUsecaseQualification 2 params → 2004224XX

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are TelnyxCampaignWithAssignedCount_CSP (51 properties), TelnyxCampaign_CSP (50 properties), CampaignRequest (35 properties), UpdateCampaignRequest (11 properties). Each schema is shown below with its type and property counts.

UsecaseMetadata
object
7 properties
10dlc_Error
object
4 properties 2 required
MnoMetadata
object
1 property
CampaignDeletionResponse
object
3 properties 1 required
10dlc_Errors
object
1 property
ValidationError
object
3 properties 3 required
CampaignRecordSet_CSP
object
3 properties
CampaignSharingStatus
object
5 properties
TelnyxCampaign_CSP
object
Campaign is generated by the 10DLC registry once the corresponding campaign request is approved. Each campaign is assigned a unique identifier - campaignId. On…
50 properties 8 required
UpdateCampaignRequest
object
11 properties
CampaignSharingChain
object
2 properties
TelnyxCampaignWithAssignedCount_CSP
object
51 properties
HTTPValidationError
object
1 property
MnoMetadataItem
object
10 properties 10 required
CampaignRequest
object
CampaignRequest object describes the campaign to be submitted via '/campaignBuilder/brand/{brandId}/usecase/{usecase}' operation. It is also used in operations…
35 properties 3 required
CampaignCost
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-campaign-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