API Recipes
API Recipes
Follow step-by-step walkthroughs for common tasks with CommPeak APIs, with cURL, Node.js, Python, and PHP code, grouped by product.
StepsGET
✓Set your API key
✓Check Portal API access
✓Check Full access
4Read the result
Check that your API key worksOpen Recipe ›
Recipes
Browse by Product
31 recipes
Portal
5 recipesCheck that your API key worksFind out whether your key is valid and has Full access, with two read-only requests.4 stepsCheck your account balanceRead your balance, temporary credit, and SMS balance.3 stepsList the users on your accountSee who can sign in to your Portal account, and with which roles.3 stepsList your paymentsSee your top-ups, deductions, and subscription charges.4 stepsList your invoicesSee your invoices, billing periods, amounts, and payment status.4 steps
TextPeak
3 recipesSIP Trunking
9 recipesPlace a text-to-speech callPlace an automated call that reads a message and collects a keypad answer.5 stepsList your verified caller IDsSee which caller IDs you can call from, and which still wait for verification.3 stepsList your SIP accountsSee your SIP accounts and how each one authenticates, by password or IP address.3 stepsLook up the rate for a destinationFind the per-minute voice rate and billing increment for a destination prefix.3 stepsDownload your voice rate deckDownload every voice rate of your call plan as a CSV or Excel file.4 stepsRetrieve your outbound call recordsRetrieve your outbound calls for a date range, page by page.3 steps
HLR LookUp
2 recipesDialer
8 recipesList your Dialer usersSee your Dialer agents and users, with their extensions and usernames, using the Dialer API.List your Dialer campaignsSee every campaign in your Dialer, with its ID and whether it is active, using the Dialer API.Retrieve your Dialer callsRetrieve the latest calls of a Dialer campaign, with their duration and outcome, using the Dialer API.Find leads in your DialerRetrieve the latest leads in your Dialer, with only the fields you need, using the Dialer API.Check a number against your DNC listFind out whether a phone number is on your Dialer's Do Not Call list before you call it.List your lead statusesGet the lead statuses of a Dialer campaign, with their IDs, to map them to your CRM.
Cloud PBX
1 recipesDID Numbers
3 recipesList your DID numbersSee your active DID numbers, where calls are forwarded, and when each renews.3 stepsRetrieve your inbound call recordsRetrieve the calls received on your DID numbers, page by page.5 stepsList your voicemailsSee the voicemails left on your DID numbers and where they were emailed.4 steps
Need the Full API Reference?
Browse every endpoint, parameter, and response for the Dialer, TextPeak, PBX, Portal, and Lookup APIs.