Account
balance
account.balance
Read the account balance, its credit limit and the outstanding amount where one is owed
Risk: read
data full type
data full type
Calls
create
calls.create
Place a click-to-call between two numbers, which bills per minute once answered
Risk: destructive
data full type
data full type
list
calls.list
List calls with their duration, cost and hangup reason, filtered by direction or start time
Risk: read
data full type
data full type
Campaigns
action
campaigns.action
Start, pause or stop a campaign; start sends to every contact in its groups
Risk: destructive
data full type
data full type
create
campaigns.create
Create an SMS campaign for a set of contact groups; it does not send until campaigns.action starts it
Risk: write
data full type
data full type
delete
campaigns.delete
Delete an SMS campaign and its history
Risk: destructive · Irreversible
meta full type
meta full type
get
campaigns.get
Read one SMS campaign by ID
Risk: read
data full type
data full type
list
campaigns.list
List SMS campaigns with their state, sender and rate
Risk: read
data full type
data full type
update
campaigns.update
Change a campaign’s title, sender, groups, message or rate
Risk: write
meta full type
meta full type
Contact Groups
contacts
contactGroups.contacts
List the contacts in one group
Risk: read
data full type
data full type
create
contactGroups.create
Create a contact group
Risk: write
data full type
data full type
delete
contactGroups.delete
Delete a contact group and its contacts
Risk: destructive · Irreversible
meta full type
meta full type
get
contactGroups.get
Read one contact group by ID
Risk: read
data full type
data full type
list
contactGroups.list
List contact groups with their contact counts
Risk: read
data full type
data full type
update
contactGroups.update
Rename a contact group
Risk: write
meta full type
meta full type
Contacts
create
contacts.create
Add a contact to a contact group
Risk: write
data full type
data full type
createBulk
contacts.createBulk
Add many contacts in one call; a partial result reports which entries failed
Risk: write
contacts full type
contacts full type
data full type
data full type
delete
contacts.delete
Delete a contact
Risk: destructive · Irreversible
meta full type
meta full type
get
contacts.get
Read one contact by ID
Risk: read
data full type
data full type
list
contacts.list
List contacts with their group and custom fields
Risk: read
data full type
data full type
update
contacts.update
Change a contact’s phone, group or custom fields
Risk: write
meta full type
meta full type
Inbox
get
inbox.get
Read one inbound message by ID
Risk: read
data full type
data full type
list
inbox.list
List inbound messages with their sender and handler
Risk: read
data full type
data full type
Number Countries
get
numberCountries.get
Read one number country by ID
Risk: read
data full type
data full type
list
numberCountries.list
List the countries numbers can be ordered in, with their prefix and SMS support
Risk: read
data full type
data full type
Numbers
get
numbers.get
Read one DID number by ID
Risk: read
data full type
data full type
list
numbers.list
List the DID numbers on the account with their renewal date and SMS settings
Risk: read
data full type
data full type
update
numbers.update
Change a number’s auto-renew or SMS handler URL and email
Risk: write
data full type
data full type
Price Groups
list
priceGroups.list
List a country’s price groups, whose IDs an order takes
Risk: read
data full type
data full type
Sms
send
sms.send
Send one SMS from a verified number or sender ID, charging the account per part
Risk: destructive
data full type
data full type
sendBulk
sms.sendBulk
Send many SMS in one call; a partial result answers 207 with the messages that failed
Risk: destructive
messages full type
messages full type
data full type
data full type
success full type
success full type
errors full type
errors full type
Sms Reports
get
smsReports.get
Read one outbound message report by ID
Risk: read
data full type
data full type
list
smsReports.list
List outbound messages with their state, price and delivery details, filtered by number or date
Risk: read
data full type
data full type
Users
list
users.list
List the account users with their login and email; their API keys are left out
Risk: read
data full type
data full type