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

Account

balance

account.balance Read the account balance, its credit limit and the outstanding amount where one is owed Risk: read
Input: empty object Output

Calls

create

calls.create Place a click-to-call between two numbers, which bills per minute once answered Risk: destructive
Input destination_displayname is required alongside both numbers. Output

list

calls.list List calls with their duration, cost and hangup reason, filtered by direction or start time Risk: read
Input Output

Campaigns

action

campaigns.action Start, pause or stop a campaign; start sends to every contact in its groups Risk: destructive
Input start sends to every contact in the campaign groups, pause stops it temporarily and stop ends it. Output

create

campaigns.create Create an SMS campaign for a set of contact groups; it does not send until campaigns.action starts it Risk: write
Input Output

delete

campaigns.delete Delete an SMS campaign and its history Risk: destructive · Irreversible
Input Output

get

campaigns.get Read one SMS campaign by ID Risk: read
Input Output

list

campaigns.list List SMS campaigns with their state, sender and rate Risk: read
Input Output

update

campaigns.update Change a campaign’s title, sender, groups, message or rate Risk: write
Input Output

Contact Groups

contacts

contactGroups.contacts List the contacts in one group Risk: read
Input Output

create

contactGroups.create Create a contact group Risk: write
Input Output

delete

contactGroups.delete Delete a contact group and its contacts Risk: destructive · Irreversible
Input Output

get

contactGroups.get Read one contact group by ID Risk: read
Input Output

list

contactGroups.list List contact groups with their contact counts Risk: read
Input Output

update

contactGroups.update Rename a contact group Risk: write
Input Output

Contacts

create

contacts.create Add a contact to a contact group Risk: write
Input group_id is required; get it from contactGroups.list. Output

createBulk

contacts.createBulk Add many contacts in one call; a partial result reports which entries failed Risk: write
Input
Output

delete

contacts.delete Delete a contact Risk: destructive · Irreversible
Input Output

get

contacts.get Read one contact by ID Risk: read
Input Output

list

contacts.list List contacts with their group and custom fields Risk: read
Input Output

update

contacts.update Change a contact’s phone, group or custom fields Risk: write
Input Output

Inbox

get

inbox.get Read one inbound message by ID Risk: read
Input Output

list

inbox.list List inbound messages with their sender and handler Risk: read
Input Output

Number Countries

get

numberCountries.get Read one number country by ID Risk: read
Input Output

list

numberCountries.list List the countries numbers can be ordered in, with their prefix and SMS support Risk: read
Input: empty object Returns every country in one answer; the route takes no paging. Output

Numbers

get

numbers.get Read one DID number by ID Risk: read
Input Output

list

numbers.list List the DID numbers on the account with their renewal date and SMS settings Risk: read
Input Output

update

numbers.update Change a number’s auto-renew or SMS handler URL and email Risk: write
Input auto_renew is a boolean in the request; the answer is the updated number, where auto_renew reads 0 or 1. Output

Price Groups

list

priceGroups.list List a country’s price groups, whose IDs an order takes Risk: read
Input Output

Sms

send

sms.send Send one SMS from a verified number or sender ID, charging the account per part Risk: destructive
Input Charges the account per part; a numeric sender must be a DID on the account and an alphanumeric sender ID must be 3 to 11 characters. Output

sendBulk

sms.sendBulk Send many SMS in one call; a partial result answers 207 with the messages that failed Risk: destructive
Input A partial result answers 207 with success and errors arrays under data; both shapes parse.
Output

Sms Reports

get

smsReports.get Read one outbound message report by ID Risk: read
Input Output

list

smsReports.list List outbound messages with their state, price and delivery details, filtered by number or date Risk: read
Input limit runs from 1 to 5000 and defaults to 500; offset skips results. state is NEW, PROC, WAIT, DONE, ERROR or CANCEL; filters travel in one filter value. Output

Users

list

users.list List the account users with their login and email; their API keys are left out Risk: read
Input Each user comes back without the api_key field TelTEL includes. Output