PhoneNotify
The system will attempt to call a number 1 time until it is answered (Can be modified with the TryCount property).
We now accept Extension numbers by using an 'x' in the phone number (ex:555-555-1000x3025).
A reminder about abuse: Threats and illegal activity can be shared with the authorities.
For Advanced TextToSay Commands Visit: http://wiki.cdyne.com/index.php/Notify_TextToSay_Commands
The following operations are supported. For a formal definition, please review the Service Description.
-
AssignIncomingNumber
This method will assign a Incoming Number to a License Key. Returns true if assignment is successful. Returns false if the number is claimed or not available. Numbers are billed at $5/month per number. Normal fees for transactions apply. -
CancelConference
Cancels/Kills a Conference by a Conference Key -
CancelNotify
Cancels a single notify. This will not cancel completed calls or calls in progress. You will credited for any successfully cancelled notify that returns a true. -
CancelNotifyByReferenceID
Cancels a batch notify by ReferenceID. This will not cancel completed calls or calls in progress. You will credited for any successfully cancelled notifies and that number will return greater than zero. -
GetAssignedNumbers
Gets a list of Incoming Numbers assigned to a LicenseKey -
GetAvailableAreaCodes
This method returns all the available area codes in our system. Please contact info@cdyne.com if you need more listed. -
GetAvailableIncomingNumbers
This method will list a random 10 lines available for incoming calls. You can assign these lines via the AssignIncomingNumber method to your license key. You can leave the area code field blank to get any available toll-free lines (888 and 877 numbers are currently the most common). -
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. -
GetMultipleQueueIdStatus
This Method returns information about the status of multiple notifies via queueid (delimited by a semicolon). This transaction is free, but does require a valid licensekey. -
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. -
GetResponseCodes
This method will list all of the Response Codes. -
GetSoundFile
Sound file Retrieval. (free) -
GetSoundFileInMP3
Sound file Retrieval (returns an MP3 encoded in 32,64, or 128). (free) -
GetSoundFileInUlaw
Sound file Retrieval (returns ULAW encoded file). (free) -
GetSoundFileLength
Gets a Sound File length in Seconds. (free) -
GetSoundFileURL
Sound file Retrieval. Returns a URL to Listen to a particular Sound File in MP3 (free) -
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) -
GetVersion
This method returns CDYNE Version information -
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 it's 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. For more information visit: http://wiki.cdyne.com/wiki/index.php?title=Phone_Notify%21_LM_DialList -
LM_DialListAdvanced
List Management - Dial a list by ListID that allows you to set more advanced properties. -
LM_GetListIDsByLicensekey
List Management - Obtains all the list IDs from a specific License key. -
LM_GetListMembersByListID
List Management - Gets all the phone numbers with their first and last names. -
LicenseKeyVariableLoad
Variable Management - Load a key's variable (The Variable name can be up to 50 characters long). -
LicenseKeyVariableSave
Variable Management - Save a variable (VariableName can only be 50 characters or less). Saving a Variable with an existing name will overwrite the old Variable. Saving a blank value will delete the variable. -
NotifyMultiplePhoneAdvanced
Allows you to control the notifies with a class. This Function allows Multiple Notifies to be sent in one send. This allows for the maximum combinations of using notify. We suggest using our list management features for Notify batches over 100. -
NotifyMultiplePhoneBasic
This Method will call phone numbers with a default of 3000 calls per minute. (delimited by a semicolon) in the US/Canada and read the TextToSay to that phone number. You must use a license key for this function. Your billing will be charged per phone number. -
NotifyMultiplePhoneBasicWithCPM
This Method will call phone numbers with a way to set calls per minute. (delimited by a semicolon) in the US/Canada and read the TextToSay to that phone number. You must use a license key for this function. Your billing will be charged per phone number. -
NotifyMultiplePhoneBasicWithCPMandReferenceID
This Method will call phone numbers with a way to set calls per minute. (delimited by a semicolon) in the US/Canada and read the TextToSay to that phone number. You must use a license key for this function. Your billing will be charged per phone number. -
NotifyPhoneAdvanced
Allows you to control the notifies with a class. This allows for the maximum combinations of using notify. -
NotifyPhoneBasic
This Method will call any phone number in the US/Canada and read the TextToSay to that phone number.
Set VoiceID equal to 0 for TTS Diane to speak the Text. For a list of Voices with their ID look at getVoices. PhoneNumberToDial and CallerID must be filled in (They can be in any format as long as there is 10 digits).
A reminder about abuse: Threats and illegal activity can be shared with the authorities.
Use a LicenseKey of 0 for testing. -
NotifyPhoneBasicWithTransfer
You must have a valid CDYNE key to use this. Please test with our other methods. This Method is exactly like the NotifyPhoneBasic with one exception. It allows you to transfer a call by pressing 0. Put the Transfer phone number in TransferNumberToOnDigit. -
NotifyPhoneBasicWithTryCount
Same as NotifyPhoneBasic with a number of times it will retry the call. The max is 3. -
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).
A reminder about abuse: Threats and illegal activity can be shared with the authorities.
Use a LicenseKey of 0 for testing. -
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. (free) -
RenameSoundFile
Sound file rename. (free) -
ReturnSoundFileIDs
Get available sound files that you can add to your stream via a license key. (free) -
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. -
UploadSoundFile
Sound file upload. Our system accepts WAV (PCM, U-law, A-law, MS ADPCM) Files. We plan on adding more very soon.
To use the sound file in the notify put ~ around it and start it with a ^.Example "Hello ~^soundfile~, you are cool."(This would text to speech Hello and you are cool,adding the sound file in the middle). (free) -
getVoices
This method will list all the voices available for your notification. Use the VoiceID for the Notification Methods