Telnyx Calling: Trusted Calling — Documentation Index
Trusted Calling documentation within the Calling section of the Telnyx developer docs (https://developers.telnyx.com). Root index: https://developers.telnyx.com/llms.txt · Calling index: https://developers.telnyx.com/development/llms/calling-llms-txt.md · Full content for this subsection: https://developers.telnyx.com/development/llms/calling-trusted-calling-llms-full-txt.md
- Overview: Display your business name, logo, and call reason on recipients’ phone screens with Branded Calling.
- Quickstart: Get your first branded call working, from Terms of Service to a verified DIR with phone numbers attached.
- Pricing: Branded Calling pricing — enterprise registration is free, brand registration has a one-time and monthly cost, plus a per-call charge.
- Overview: Register your business as an enterprise to use Branded Calling.
- Overview: Create and manage Display Identity Records (DIRs), the display identity shown to call recipients.
- Overview: Attach phone numbers to a verified DIR and inspect the carrier-network vetting batches.
- Overview: Configure the call reason text displayed to recipients, explaining why your business is calling.
- Overview: Accept the Branded Calling Terms of Service before activating Branded Calling on an enterprise.
- Overview: Inspect, contest, and resolve infringement claims filed against your DIR.
API Reference (Trusted Calling)
Enterprises
- List enterprises: Return the enterprises you own, paginated. The default page size is 20; the maximum is 250.
- Create an enterprise: Create the legal entity (enterprise) that represents your business on the Telnyx platform.
- Get an enterprise: Retrieve a single enterprise by id. Returns
404if the id does not exist or does not belong to your account. - Replace an enterprise: Replace the enterprise’s mutable fields. Only mutable fields may be sent. Server-assigned and immutable fields (
id,record_type,created_at,updated_at… - Delete an enterprise: Soft-delete an enterprise.
- Activate Branded Calling on an enterprise: Branded Calling is a paid product that must be activated on each enterprise. Activation is idempotent:
Display Identity Records
- List DIRs in an enterprise: Return the DIRs (Display Identity Records) belonging to a single enterprise. Pagination is JSON:API style (
page[number],page[size], max 250). Supports `fi… - Create a Display Identity Record (DIR): Create a new DIR under the given enterprise. The DIR starts in
draftstatus; it must be submitted (POST .../submit) and approved by Telnyx before any phone… - List all DIRs across your enterprises: Returns every DIR (Display Identity Record) you own, across all of your enterprises, as a single list. Pagination is JSON:API style (
page[number], `page[size… - Get a DIR by id: Returns a single DIR by id. The enterprise is resolved server-side from the DIR id. Returns
404if the DIR does not exist or is not yours. - Update a DIR: Edit a DIR. DIRs in
draft,rejected,unsuccessful, orsuspendedcan be edited freely: PATCH is a pure edit,statusis never changed, and you re-vet b… - Delete a DIR: Delete a DIR. Failure modes:
400if a child phone number is in a non-deletable status,409if the DIR has an unresolved infringement claim,404if the DI… - Submit a DIR for vetting: Submit a DIR for vetting. Sends the DIR back through the vetting cycle from any non-terminal status. When re-submitting from
suspendedorexpired, the DIR’… - Render the Branded Calling LOA for a DIR: Generate a pre-filled Letter of Authorization (LOA) PDF for a DIR. Enterprise identity (legal name, DBA, address, contact, website, tax id) and the DIR display…
Reference Data
- List supported DIR document types: Reference list of
document_typevalues accepted byDirCreateRequest.documents[].document_typeand the infringement-contest endpoint. Each entry has a stabl… - List standard call reasons: Telnyx maintains a library of pre-vetted call-reason phrases (e.g. “Appointment reminders”, “Billing inquiries”) that carry through DIR vetting smoothly. You c…
- Validate a list of call reasons: Check up to 10 candidate
call_reasonsstrings against Telnyx’s vetting heuristics before sending them on a DIR create or update. The endpoint flags strings t…
Comments
- List comments on a DIR: List the comments on a DIR. The enterprise is resolved server-side from the DIR id.
- Post a comment on a DIR: Post a customer comment on a DIR (for example, to respond to reviewer notes). Send only
content(1–5000 chars) and an optionalparent_comment_id; the serve…
Phone Numbers
- List phone numbers attached to a DIR: List the phone numbers registered under a DIR. The enterprise is resolved server-side from the DIR id.
- Add phone numbers to a DIR: Register phone numbers under a DIR. The enterprise is resolved server-side from the DIR id. Same body, failure modes, and batch semantics whichever path form y…
- Remove phone numbers from a DIR: Deregister phone numbers from a DIR. The enterprise is resolved server-side from the DIR id. Returns a partial-success envelope.
Phone Number Batches
- List phone-number batches for a DIR: List the phone-number batches submitted under a DIR. The enterprise is resolved server-side from the DIR id.
- Get a phone-number batch: Get a single phone-number batch by id. The enterprise is resolved server-side from the DIR id.
Infringement Claims
- List infringement claims for a DIR: Return the trademark or copyright claims filed against this DIR. Each claim’s
statusispending(newly filed; DIR auto-suspended),contested(you have su… - Update a DIR to resolve an infringement concern: Push a fix for a DIR that is
suspendedwith an open infringement claim back into vetting.POST /dir/{dir_id}/submitis blocked while a claim is open, so th… - Get an infringement claim: Retrieve a single claim by id. Returns
404if the claim does not exist or is not against a DIR you own. - Contest an infringement claim: Submit a written response and supporting documents disputing the claim. The first call moves the claim from
pendingtocontested; subsequent calls append s…
Terms of Service
- Agree to the Branded Calling Terms of Service: Records the authenticated user’s agreement to the current Branded Calling ToS. No body required. Idempotent - re-calling after agreement is a no-op and returns…
- Get Terms of Service information: Returns the available Terms of Service agreements (product, current version, terms URL, effective date). Omit
product_typeto return all products; pass it to… - Get the calling user’s Terms of Service status: Returns whether the authenticated user has agreed to the current Terms of Service for the product given by
product_type. Used during onboarding to decide whe… - List the calling user’s Terms of Service agreements: Returns the Terms of Service agreements the authenticated user has on file. Each entry records the version agreed to and when. Most users only have one agreeme…
- Get a Terms of Service agreement by id: Retrieve a single ToS agreement record. Returns
404if the agreement does not exist or does not belong to the authenticated user.