With over 50 programming methods, you can build powerful applications with Phone Notify! that will handle complex phone scripts, send immediate or scheduled phone calls, respond to call actions in real time, and manage call lists. Phone Notify! allows programmers to send automated phone alerts, conduct phone surveys, perform conference calls, and integrate custom business applications into their existing system.
The following list shows Phone Notify! operations by category. You may view each method’s parameters, data type, and sample input and output data on the Phone Notify! developer’s wiki . A compiled list of operation notes may also be found in the Phone Notify! Specification PDF.
Send and Receive Phone Calls
Basic Methods for Single or Multiple Calls
NotifyPhoneBasic
This method will call any phone number in the US/Canada and read the TextToSay to that phone number.
NotifyPhoneBasicWithTryCount
Same as NotifyPhoneBasic with a number of times it will retry the call. The max is 3.
NotifyPhoneBasicWithTransfer
This method will call any phone number in the US/Canada and read the TextToSay to that phone number. It also allows you to transfer a call by pressing 0.
NotifyPhoneEnglishBasic
This method will call any phone number in the US/Canada and read the TextToSay to that phone number using the voice of Diane (VoiceID: 0). PhoneNumberToDial must be filled in (They can be in any format as long as there is 10 digits).
NotifyMultiplePhoneBasic
This method will call phone numbers with a default of 3,000 calls per minute (delimited by a semicolon) in the US/Canada and read the TextToSay to that phone number.
NotifyMultiplePhoneBasicWithCPM
This method includes a way to set the calls per minute (CPM) when calling phone numbers in the US/Canada, and will read the TextToSay to that phone number.
Advanced Methods for Single or Multiple Calls
NotifyPhoneAdvanced
Allows you to control notifies with a class. This method allows for the maximum combinations of using Phone Notify! API.
NotifyMultiplePhoneAdvanced
Allows you to control notifies with a class. This function allows multiple notifies to be sent at one time. This allows for the maximum combinations of using Phone Notify! API. We suggest using our list management features for batches over 100.
Additional Methods
CancelNotify
Cancels a single notify. This will not cancel completed calls or calls in progress. You will receive credit for any successfully cancelled notify that returns “true.”
getVoices
This method will list all the voices available for your notification. Use the VoiceID for the Notification Methods
GetIncomingCallScript
Allows you to get the call script for incoming calls for a particular number. You must have incoming phone numbers set by CDYNE Staff.
CancelConference
Cancels a conference by conference key.
Status Report Management
GetQueueIDStatus
Returns a status on a particular QueueID.
GetQueueIDStatusWithAdvancedInfo
Returns a status on a particular QueueID. This also includes variable information and more.
GetQueueIDStatusesByPhoneNumber
Returns the last 10 phone notifications for a particular phone number.
GetMultipleQueueIdStatus
This method returns information about the status of multiple notifies via QueueID (delimited by a semicolon). The QueueID returns a specific phone call ID.
GetResponseCodes
This method will list all of the response codes.
Script Management
ScriptDelete
Script Management – Delete a script.
ScriptList
Script Management – Lists the scripts belonging to a license key. Set IncludeGlobalScripts to true if you would like CDYNE global scripts to be included.
ScriptLoad
Script Management – Load a script’s text.
ScriptSave
Script Management – Save a script (Scriptname can only be 50 characters or less). Saving a script with an existing name will overwrite the old script.
SetIncomingCallScript
Allows you to update a Call Script for incoming calls. You must have incoming phone numbers set by CDYNE Staff.
Sound File Management
UploadSoundFile
Sound file upload. Our system accepts WAV (PCM, U-law, A-law, MS ADPCM) Files. To use the sound file in the notify put ~ around it and start it with a ^.Example “Hello ~^soundfile~, you are cool.”(This would TextToSay “Hello,” and “you are cool,” adding the sound file in the middle).
GetSoundFile
Sound file retrieval.
GetSoundFileInMP3
Sound file retrieval (returns an MP3 encoded in 32,64, or 128).
GetSoundFileInUlaw
Sound file retrieval (returns ULAW encoded file).
GetSoundFileLength
Gets a sound file length in seconds.
GetSoundFileURL
Sound file retrieval. Returns a URL to listen to a particular sound file in MP3.
GetTTSInMP3
Allows you to convert text into a MP3 encoded sound file. Returns an MP3 encoded in 32,64, or 128 (May require a additional License Key).
GetTTSInULAW
Allows you to convert text into a ULAW encoded sound file (May require an additional License Key).
RecordSoundViaPhoneCall
Request the system to call you to record a sound file. SoundfileIDs can only be lowercase and contain normal file characters. The CallerIDName will be the SoundFileID and the number will be 8000000000.
RemoveSoundFile
Sound file delete.
RenameSoundFile
Sound file rename.
ReturnSoundFileIDs
Get available sound files that you can add to your stream via a license key.
List Management
LM_AddListMember
List Management – Allows you to add contacts to a List. You will need the ListID. The only required fields are ListID, PhoneNumber, and LicenseKey. Returns a List Member ID.
LM_AddNewList
List Management – Allows you to add a list that can contain members (Contacts). You can also attach this list to be apart of a Parent List, otherwise leave ParentList ID = 0.
LM_AlterListID
List Management – Allows you alter a ListMember, use 0 if you do not want to have a ParentListID, and -1 if you do not wish to change the ParentListID.
LM_AlterListMember
List Management – Allows you alter a ListMember.
LM_DeleteList
List Management – Deletes a List and its sub-lists (The lists that have is as a ParentListID).
LM_DeleteListMember
List Management – Deletes a List’s Member (or contact).
LM_DialList
List Management – Dial a List by ListID. Returns a Batch ID for the list and begins dialing at the scheduled time. Scheduled times are in UTC.
LM_DialListAdvanced
List Management – Dial a list by ListID that allows you to set more advanced properties.
LM_GetListIDsByLicensekey
List Management – Obtains all list IDs from a specific License key.
LM_GetListMembersByListID
List Management – Gets all the phone numbers with their first and last names.
For more information about CDYNE Phone Notify! API, please contact an account representative at 1-800-984-3710, inquire by email, or initiate a chat for more details.
Or sign up for a free trial license key to test CDYNE Phone Notify! API.