What is Phone Notify! API?
CDYNE’s Phone Notify! API is a hosted, programmable XML Web Service that can send or receive up to 12,000 Tier 1 quality phone calls per minute using text-to-speech, WAV files, or both.
What can I use Phone Notify! for?
- Emergency Alerts and School Closing Calls
- Automated Appointment and Payment Reminders
- Product Delivery Status Notifications
- Credit Card Verifications and Password Resets
- Automated Courtesy Holiday or Birthday Greeting Calls
- Political Campaign Messages
- Event Planning (Clubs, Sports, Churches)
- Phone Call Blasts (One-Day Sales, VIP Reservations, Job Notifications)
How does text-to-speech work?
CDYNE’s text-to-speech engine converts raw text to written-out words and then assigns phonetic transcriptions to those words. Text-to-speech can also be combined with recorded WAV files to create relevant call scripts according to your phone messaging web service needs. You can select from 14 different voice IDs:
- Diane—US English (Female—35)
- David—US English (Male—30)
- William—US English (Male—30)
- Emily—US English (Female—30)
- Callie—US English (Female—30)
- Lawrence—UK English (Male—55)
- Millie—UK English (Female—45)
- Isabelle— Canadian French (Female—30)
- Katrin—German (Female—35)
- Marta—Americas Spanish (Female—30)
- Vittoria—Italian (Female—30)
- Jean—Pierre—Canadian French (Male—30)
- Miguel—Americas Spanish (Male—30)
- Matthias—German (Male—30)
- Ashley—US English (Female)
- James—US English (Male)
- Violeta—Mexican Spanish (Female)
- Francisco—Mexican Spanish (Male)
When are my calls sent out?
Calls are sent out at the date and time you schedule them. They can be sent out immediately or scheduled for a later date. A specific time and date are required for a call to be made.
How many phone calls can I send with Phone Notify!?
You can send or receive up to 12,000 Tier 1 quality calls per minute using text-to-speech or recorded WAV files, or both.
Does Phone Notify! support incoming calls?
Yes, CDYNE’s Phone Notify! supports incoming call scripts. All of the commands utilized when sending an outbound call can be used the same way for incoming calls.
How does Phone Notify! handle the status of the phone call?
You can use the
StatusChangePostURL to post back information about the call to a URL you specify. It will post the following values:
QueueID: Contains the ID of the call
ResponseCode: 1 = call answered, 2 or more = call unanswered
StartTime: Start time in Universal Time (UTC)
EndTime: End time in Universal Time (UTC)
Duration: Call length in seconds
Machinedetection: Currently only HUMAN, MACHINE, FAX
AC: Contains a status code. This is for advanced problem solving with Tech Support.
DigitsDialed: Contains all the digits dialed during the call
trueif the call was an incoming call
- Variables that you collected: Any additional variables that you collected during the call
What coverage can I expect?
Calls outside of the U.S. and Canada incur an extra charge based on carrier. Please contact us for rates per country.
What is a transaction?
A Phone Notify! transaction is defined by the number of seconds the call is connected (ringing does not count). The first Phone Notify! transaction is 120 seconds. Every additional 60 seconds counts as another transaction. A failed or busy signal qualifies as a transaction, but retries to the same number are free if the original call was unanswered or busy when using the
TryCount command. There is no extra charge to initiate a transfer call. International calls have an extra charge based on carrier. Incoming calls are billed the same as outgoing.
What is the difference between Phone Notify! and Phone Verify?
Phone Notify! sends text-to-speech or recorded phone calls and supports incoming call scripts. Phone Verify validates the area code and prefix of U.S. and Canadian phone numbers, and also determines whether the number is from a cell phone or landline. Phone Verify! can detect and automatically correct errors in area codes, which allows businesses to have the most up-to-date data.
How reliable is CDYNE’s Phone Notify! API?
CDYNE’s Service Level Agreement (SLA) promises to protect clients from unpredicted outages and guarantees 99.9% uptime.
How do I get started with Phone Notify!
Can the CallerID number be the same as the recipent number?
CallerIDNumber parameter value cannot be the same as the recipient number.
What is the maximum packet size I can send?
The largest packet size CDYNE will accept is 4MB.
Do I have to provide my own storage for the sound files I upload to my key?
No. When uploading sound files to your license key, they are automatically stored on a CDYNE database. This is free of cost, but CDYNE reserves the right to charge for storage at any point in the future.
Does your API support calls to extensions?
Yes. If you would like to send a call to a recipient that has an extension, provide the full number in the
PhoneNumberToDial parameter using this format: 17575449510x000
Does Phone Notify! support calls to outside the U.S. and Canada?
Yes, international calls are supported by our API. To send a call to an international recipient the number needs to be formatted as: 011 + country code + phone number. For example: 0014458965203248
Can an international number be set as the CallerID number?
Yes. Either an international number or valid U.S. number can be set as the CallerID number. If none is preset the system defaults to the Reverse Notify/Replay number (1-866-665-4386).
How do I integrate Phone Notify! into my application or system?
To use the service, add a web reference to your application allowing it to call the Phone Notify! API on our server for processing. For a detailed guide take a look at our Quick Start section to see examples in your desired programming language.
Can I configure the sending number, or does it have to be the number you provide?
Yes, you can use the
CallerIDNumber parameter to input the display number on the receiving party’s caller ID.
How do I get customer support or technical support?
For customer and technical support visit our contact page.
Where can I find more technical resources?
More technical resources are available on our Developer Wiki.
How do I include a sound file?
TextToSay parameter of your request code, add
~^soundfilenamehere~ to include any sound files within your call scripts that are associated with your Phone Notify! license key.