Skip to main content
New to Corsair? See API access, authentication, and error handling.

Available Phone Numbers

list

availablePhoneNumbers.list Search the numbers available to buy in a country, filtered by area code, locality or type Risk: read
Input countryCode is required; every other filter, limit included, travels as a filter[..] query key. Output

Call Control Applications

create

callControlApplications.create Create a call control application, which is what calls.create dials through Risk: write
Input webhook_event_url is required because Telnyx delivers every call event there. Output

delete

callControlApplications.delete Delete a call control application; calls that reference it stop working Risk: destructive · Irreversible
Input Output

get

callControlApplications.get Read one call control application by ID Risk: read
Input Output

list

callControlApplications.list List the call control applications with their webhook URLs Risk: read
Input Output

update

callControlApplications.update Change an application’s webhook URL, name or active state Risk: write
Input Output

Calls

create

calls.create Place an outbound call through a call control application, which dials the number and bills per minute Risk: destructive
Input connection_id is the call control application ID, and the call bills per minute once answered. Output

get

calls.get Read one call with its state, direction and timestamps Risk: read
Input Output

hangup

calls.hangup Hang up an active call, ending it for both legs Risk: destructive · Irreversible
Input Output

speak

calls.speak Read text aloud on an active call using text to speech Risk: destructive
Input payload and voice are required; language is optional. Output

Messages

delete

messages.delete Cancel a scheduled message before Telnyx sends it; a message that already went out cannot be cancelled Risk: destructive · Irreversible
Input Cancels a scheduled message that has not been sent yet; answers with the bare message, not wrapped in data. Output

get

messages.get Read one message with its delivery status, parts, cost and the errors Telnyx recorded Risk: read
Input Output

send

messages.send Send an SMS or MMS from a Telnyx number, charging the account per part; text or at least one media URL is required Risk: destructive
Input Charges the account per part; send from, or a messaging_profile_id so the number pool picks the sender; SMS needs text and MMS needs media_urls. Output

Messaging Profiles

create

messagingProfiles.create Create a messaging profile, which groups numbers and sets where inbound messages are delivered Risk: write
Input whitelisted_destinations is required, e.g. [“US”]. Output

delete

messagingProfiles.delete Delete a messaging profile, which detaches its numbers and stops inbound delivery Risk: destructive · Irreversible
Input Detaches the profile from its numbers and stops inbound delivery. Output

get

messagingProfiles.get Read one messaging profile by ID Risk: read
Input Output

list

messagingProfiles.list List the messaging profiles with their webhook destination and enabled state Risk: read
Input Output

update

messagingProfiles.update Change a profile’s name, webhook destination or whitelisted destinations Risk: write
Input Output

Phone Numbers

delete

phoneNumbers.delete Release a phone number from the account; it cannot be recovered once released Risk: destructive · Irreversible
Input Releases the number permanently; it cannot be recovered. Output

get

phoneNumbers.get Read one phone number record by ID Risk: read
Input Output

list

phoneNumbers.list List the numbers on the account with their connection and messaging profile Risk: read
Input Output

update

phoneNumbers.update Attach a number to a call control application or other connection, or change its tags, billing group or customer reference Risk: write
Input Output