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

Assistant

answer

assistant.answer Ask the workspace assistant a question Risk: write
Input Output

Calls

end

calls.end Hang up a live call Risk: destructive · Irreversible
Input Output

get

calls.get Get a call by id Risk: read
Input Output

list

calls.list List calls Risk: read
Input: empty object Output: object[]

place

calls.place Place an outbound call. Reserves prepaid balance Risk: write
Input Output

recording

calls.recording Read the call recording download URL Risk: read
Input Output

transcript

calls.transcript Read a call transcript Risk: read
Input Output: object[] \| object

transfer

calls.transfer Blind-transfer a live call Risk: write
Input Output

Connections

create

connections.create Create a hosted or manual connection Risk: write
Input
Output

delete

connections.delete Delete a connection Risk: destructive · Irreversible
Input Output

get

connections.get Get a connection by id Risk: read
Input Output

list

connections.list List connections in the workspace Risk: read
Input: empty object Output: object[]

update

connections.update Update a connection Risk: write
Input
Output

check

consent.check Check whether a contact has active consent Risk: read
Input Output

list

consent.list List consent records Risk: read
Input: empty object Output: object[]

record

consent.record Record consent for a contact Risk: write
Input Output

revoke

consent.revoke Revoke consent for a contact Risk: destructive
Input Output

Custom Voices

create

customVoices.create Upload a custom voice sample. Takes the file as a public link, base64 or a Blob; on Corsair, pass a Files id. Risk: write
Input
Output

delete

customVoices.delete Delete a custom voice Risk: destructive · Irreversible
Input Output

get

customVoices.get Get a custom voice by id Risk: read
Input Output

list

customVoices.list List custom voices Risk: read
Input: empty object Output: object[]

Health

check

health.check Liveness probe Risk: read
Input: empty object Output

Keys

list

keys.list List API keys. Requires the admin scope Risk: read
Input: empty object Output: object[]

mint

keys.mint Mint a child API key. The plaintext token is returned once Risk: write
Input Output

revoke

keys.revoke Revoke an API key Risk: destructive · Irreversible
Input Output

Languages

list

languages.list List supported spoken languages Risk: read
Input: empty object Output: object[]

Messages

list

messages.list List SMS messages, optionally for one number Risk: read
Input Output: object[]

send

messages.send Send an SMS. Billed per segment Risk: write
Input Output

Numbers

assignConnection

numbers.assignConnection Bind a connection to a phone number Risk: write
Input Output

get

numbers.get Get a phone number by id Risk: read
Input Output

list

numbers.list List phone numbers in the workspace Risk: read
Input: empty object Output: object[]

provision

numbers.provision Provision a phone number. Reserves prepaid balance Risk: write
Input Output

release

numbers.release Release a phone number Risk: destructive · Irreversible
Input Output

setCallerId

numbers.setCallerId Set or clear the outbound caller ID name Risk: write
Input Output

setSmsSender

numbers.setSmsSender Set or clear the alphanumeric SMS sender id Risk: write
Input Output

setWebhook

numbers.setWebhook Set the per-number manual-mode brain URL Risk: write
Input Output

Pricing

quote

pricing.quote Quote the monthly and upfront price of a number Risk: read
Input Output

Usage

summary

usage.summary Read usage and the prepaid balance Risk: read
Input Output

Voices

list

voices.list List in-network voices Risk: read
Input Output: object[]