Web Service Details: PhoneNotify

Seekda Community Feedback

• PhoneNotifySoap (Protocol: SOAP11_HTTP)

  • 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.
    Input: CancelNotify
    Output: CancelNotifyResponse
  • 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.
    Input: GetIncomingCallScript
    Output: GetIncomingCallScriptResponse
  • 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.
    Input: GetMultipleQueueIdStatus
    Output: GetMultipleQueueIdStatusResponse
  • GetQueueIDStatus
    Returns a status on a particular QueueID.
    Input: GetQueueIDStatus
    Output: GetQueueIDStatusResponse
  • GetQueueIDStatusesByPhoneNumber
    Returns the last 10 phone notifications for a particular phone number.
    Input: GetQueueIDStatusesByPhoneNumber
    Output: GetQueueIDStatusesByPhoneNumberResponse
  • GetQueueIDStatusWithAdvancedInfo
    Returns a status on a particular QueueID. This also includes Variable information and more.
    Input: GetQueueIDStatusWithAdvancedInfo
    Output: GetQueueIDStatusWithAdvancedInfoResponse
  • GetResponseCodes
    This method will list all of the Response Codes.
    Input: GetResponseCodes
    Output: GetResponseCodesResponse
  • GetSoundFile
    Sound file Retrieval (returns ADPCM encoded file). (free)
    Input: GetSoundFile
    Output: GetSoundFileResponse
  • GetSoundFileInMP3
    Sound file Retrieval (returns an MP3 encoded in 32,64, or 128). (free)
    Input: GetSoundFileInMP3
    Output: GetSoundFileInMP3Response
  • GetSoundFileInUlaw
    Sound file Retrieval (returns ULAW encoded file). (free)
    Input: GetSoundFileInUlaw
    Output: GetSoundFileInUlawResponse
  • GetSoundFileLength
    Gets a Sound File length in Seconds. (free)
    Input: GetSoundFileLength
    Output: GetSoundFileLengthResponse
  • GetSoundFileURL
    Sound file Retrieval. Returns a URL to Listen to a particular Sound File in MP3 (free)
    Input: GetSoundFileURL
    Output: GetSoundFileURLResponse
  • 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)
    Input: GetTTSInMP3
    Output: GetTTSInMP3Response
  • GetTTSInULAW
    Allows you to convert text into a ULAW encoded sound file. (May require an additional License Key)
    Input: GetTTSInULAW
    Output: GetTTSInULAWResponse
  • GetVersion
    This method returns CDYNE Version information
    Input: GetVersion
    Output: GetVersionResponse
  • getVoices
    This method will list all the voices available for your notification. Use the VoiceID for the Notification Methods
    Input: getVoices
    Output: getVoicesResponse
  • LicenseKeyVariableLoad
    Variable Management - Load a key's variable (The Variable name can be up to 50 characters long).
    Input: LicenseKeyVariableLoad
    Output: LicenseKeyVariableLoadResponse
  • 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.
    Input: LicenseKeyVariableSave
    Output: LicenseKeyVariableSaveResponse
  • 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.
    Input: LM_AddListMember
    Output: LM_AddListMemberResponse
  • 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.
    Input: LM_AddNewList
    Output: LM_AddNewListResponse
  • 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
    Input: LM_AlterListID
    Output: LM_AlterListIDResponse
  • LM_AlterListMember
    List Management - Allows you alter a ListMember
    Input: LM_AlterListMember
    Output: LM_AlterListMemberResponse
  • LM_DeleteList
    List Management - Deletes a List and it's sub-lists (The lists that have is as a ParentListID).
    Input: LM_DeleteList
    Output: LM_DeleteListResponse
  • LM_DeleteListMember
    List Management - Deletes a List's Member (or contact)
    Input: LM_DeleteListMember
    Output: LM_DeleteListMemberResponse
  • 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
    Input: LM_DialList
    Output: LM_DialListResponse
  • LM_DialListAdvanced
    List Management - Dial a list by ListID that allows you to set more advanced properties.
    Input: LM_DialListAdvanced
    Output: LM_DialListAdvancedResponse
  • LM_GetListIDsByLicensekey
    List Management - Obtains all the list IDs from a specific License key.
    Input: LM_GetListIDsByLicensekey
    Output: LM_GetListIDsByLicensekeyResponse
  • LM_GetListMembersByListID
    List Management - Gets all the phone numbers with their first and last names.
    Input: LM_GetListMembersByListID
    Output: LM_GetListMembersByListIDResponse
  • 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. Demos are not allowed.
    Input: NotifyMultiplePhoneAdvanced
    Output: NotifyMultiplePhoneAdvancedResponse
  • 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.
    Input: NotifyMultiplePhoneBasic
    Output: NotifyMultiplePhoneBasicResponse
  • 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.
    Input: NotifyMultiplePhoneBasicWithCPM
    Output: NotifyMultiplePhoneBasicWithCPMResponse
  • NotifyPhoneAdvanced
    Allows you to control the notifies with a class. This allows for the maximum combinations of using notify. Demos are not allowed.
    Input: NotifyPhoneAdvanced
    Output: NotifyPhoneAdvancedResponse
  • 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.
    Input: NotifyPhoneBasic
    Output: NotifyPhoneBasicResponse
  • 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.
    Input: NotifyPhoneBasicWithTransfer
    Output: NotifyPhoneBasicWithTransferResponse
  • NotifyPhoneBasicWithTryCount
    Same as NotifyPhoneBasic with a number of times it will retry the call. The max is 3. Demos are not allowed.
    Input: NotifyPhoneBasicWithTryCount
    Output: NotifyPhoneBasicWithTryCountResponse
  • 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.
    Input: NotifyPhoneEnglishBasic
    Output: NotifyPhoneEnglishBasicResponse
  • 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. Demos are not allowed.
    Input: RecordSoundViaPhoneCall
    Output: RecordSoundViaPhoneCallResponse
  • RemoveSoundFile
    Sound file delete. (free)
    Input: RemoveSoundFile
    Output: RemoveSoundFileResponse
  • ReturnSoundFileIDs
    Get available sound files that you can add to your stream via a license key. (free)
    Input: ReturnSoundFileIDs
    Output: ReturnSoundFileIDsResponse
  • ScriptDelete
    Script Management - Delete a script
    Input: ScriptDelete
    Output: ScriptDeleteResponse
  • 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.
    Input: ScriptList
    Output: ScriptListResponse
  • ScriptLoad
    Script Management - Load a script's text
    Input: ScriptLoad
    Output: ScriptLoadResponse
  • 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.
    Input: ScriptSave
    Output: ScriptSaveResponse
  • SetIncomingCallScript
    Allows you to update a Call Script for incoming calls. You must have incoming phone numbers set by CDYNE Staff.
    Input: SetIncomingCallScript
    Output: SetIncomingCallScriptResponse
  • 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)
    Input: UploadSoundFile
    Output: UploadSoundFileResponse

• PhoneNotifyHttpGet (Protocol: HTTP_GET)

  • 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.
    Input: QueueID, LicenseKey
    Output: boolean
  • 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.
    Input: LicenseKey, PhoneNumber
    Output: string
  • 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.
    Input: QueueIDs, LicenseKey
    Output: ArrayOfNotifyReturn
  • GetQueueIDStatus
    Returns a status on a particular QueueID.
    Input: QueueID
    Output: NotifyReturn
  • GetQueueIDStatusesByPhoneNumber
    Returns the last 10 phone notifications for a particular phone number.
    Input: LicenseKey, PhoneNumber
    Output: ArrayOfNotifyReturn
  • GetQueueIDStatusWithAdvancedInfo
    Returns a status on a particular QueueID. This also includes Variable information and more.
    Input: QueueID, LicenseKey
    Output: NotifyReturn
  • GetResponseCodes
    This method will list all of the Response Codes.
    Input:
    Output: ArrayOfResponse
  • GetSoundFile
    Sound file Retrieval (returns ADPCM encoded file). (free)
    Input: LicenseKey, SoundFileID
    Output: base64Binary
  • GetSoundFileInMP3
    Sound file Retrieval (returns an MP3 encoded in 32,64, or 128). (free)
    Input: BitRate, SoundFileID, LicenseKey
    Output: base64Binary
  • GetSoundFileInUlaw
    Sound file Retrieval (returns ULAW encoded file). (free)
    Input: LicenseKey, SoundFileID
    Output: base64Binary
  • GetSoundFileLength
    Gets a Sound File length in Seconds. (free)
    Input: LicenseKey, SoundFileID
    Output: double
  • GetSoundFileURL
    Sound file Retrieval. Returns a URL to Listen to a particular Sound File in MP3 (free)
    Input: SoundFileID, LicenseKey
    Output: string
  • 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)
    Input: TTSvolume, TextToSay, BitRate, VoiceID, TTSrate, LicenseKey
    Output: base64Binary
  • GetTTSInULAW
    Allows you to convert text into a ULAW encoded sound file. (May require an additional License Key)
    Input: VoiceID, TTSrate, LicenseKey, TextToSay, TTSvolume
    Output: base64Binary
  • GetVersion
    This method returns CDYNE Version information
    Input:
    Output: string
  • getVoices
    This method will list all the voices available for your notification. Use the VoiceID for the Notification Methods
    Input:
    Output: ArrayOfVoice
  • LicenseKeyVariableLoad
    Variable Management - Load a key's variable (The Variable name can be up to 50 characters long).
    Input: VariableName, LicenseKey
    Output: string
  • 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.
    Input: VariableValue, LicenseKey, VariableName
    Output: boolean
  • 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.
    Input: PhoneNumber, ListID, LastName, ClientID, LicenseKey, FirstName
    Output: int
  • 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.
    Input: LicenseKey, ListName, ParentListID
    Output: int
  • 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
    Input: ParentListID, Licensekey, ListID, ListName
    Output: boolean
  • LM_AlterListMember
    List Management - Allows you alter a ListMember
    Input: PhoneNumber, licensekey, LastName, ClientID, ListMemberID, FirstName
    Output: boolean
  • LM_DeleteList
    List Management - Deletes a List and it's sub-lists (The lists that have is as a ParentListID).
    Input: LicenseKey, ListID
    Output: boolean
  • LM_DeleteListMember
    List Management - Deletes a List's Member (or contact)
    Input: LicenseKey, ListMemberID
    Output: boolean
  • 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
    Input: ListID, CallerID, TextToSay, DialRecursiveLists, VoiceID, LicenseKey, CallerIDName
    Output: LM_DialReturn
  • LM_GetListIDsByLicensekey
    List Management - Obtains all the list IDs from a specific License key.
    Input: licensekey
    Output: ArrayOfLM_ListIDs
  • LM_GetListMembersByListID
    List Management - Gets all the phone numbers with their first and last names.
    Input: ListID, Licensekey
    Output: ArrayOfLM_ListMembers
  • 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.
    Input: PhoneNumbersToDial, VoiceID, LicenseKey, CallerIDname, TextToSay, CallerID
    Output: ArrayOfNotifyReturn
  • 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.
    Input: PhoneNumbersToDial, CallsPerMinute, TextToSay, CallerIDname, LicenseKey, VoiceID, CallerID
    Output: ArrayOfNotifyReturn
  • 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.
    Input: CallerID, PhoneNumberToDial, TextToSay, CallerIDname, LicenseKey, VoiceID
    Output: NotifyReturn
  • 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.
    Input: TextToSay, CallerID, PhoneNumberToDial, VoiceID, TransferNumber, LicenseKey, CallerIDname
    Output: NotifyReturn
  • NotifyPhoneBasicWithTryCount
    Same as NotifyPhoneBasic with a number of times it will retry the call. The max is 3. Demos are not allowed.
    Input: CallerIDname, TextToSay, PhoneNumberToDial, CallerID, VoiceID, TryCount, LicenseKey
    Output: NotifyReturn
  • 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.
    Input: PhoneNumberToDial, TextToSay, LicenseKey
    Output: NotifyReturn
  • 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. Demos are not allowed.
    Input: PhoneNumberToDial, LicenseKey, SoundFileID
    Output: boolean
  • RemoveSoundFile
    Sound file delete. (free)
    Input: LicenseKey, SoundFileID
    Output: boolean
  • ReturnSoundFileIDs
    Get available sound files that you can add to your stream via a license key. (free)
    Input: LicenseKey
    Output: ArrayOfString
  • ScriptDelete
    Script Management - Delete a script
    Input: LicenseKey, ScriptName
    Output: boolean
  • 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.
    Input: IncludeGlobalScripts, LicenseKey
    Output: ArrayOfString
  • ScriptLoad
    Script Management - Load a script's text
    Input: LicenseKey, ScriptName
    Output: string
  • 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.
    Input: ScriptName, LicenseKey, ScriptText
    Output: boolean
  • SetIncomingCallScript
    Allows you to update a Call Script for incoming calls. You must have incoming phone numbers set by CDYNE Staff.
    Input: Script, LicenseKey, PhoneNumber
    Output: boolean
  • 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)
    Input: SoundFileID, LicenseKey, FileBinary
    Output: UploadFileResponse

• PhoneNotifyHttpPost (Protocol: HTTP_POST)

  • 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.
    Input: QueueID, LicenseKey
    Output: boolean
  • 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.
    Input: LicenseKey, PhoneNumber
    Output: string
  • 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.
    Input: QueueIDs, LicenseKey
    Output: ArrayOfNotifyReturn
  • GetQueueIDStatus
    Returns a status on a particular QueueID.
    Input: QueueID
    Output: NotifyReturn
  • GetQueueIDStatusesByPhoneNumber
    Returns the last 10 phone notifications for a particular phone number.
    Input: LicenseKey, PhoneNumber
    Output: ArrayOfNotifyReturn
  • GetQueueIDStatusWithAdvancedInfo
    Returns a status on a particular QueueID. This also includes Variable information and more.
    Input: QueueID, LicenseKey
    Output: NotifyReturn
  • GetResponseCodes
    This method will list all of the Response Codes.
    Input:
    Output: ArrayOfResponse
  • GetSoundFile
    Sound file Retrieval (returns ADPCM encoded file). (free)
    Input: LicenseKey, SoundFileID
    Output: base64Binary
  • GetSoundFileInMP3
    Sound file Retrieval (returns an MP3 encoded in 32,64, or 128). (free)
    Input: BitRate, SoundFileID, LicenseKey
    Output: base64Binary
  • GetSoundFileInUlaw
    Sound file Retrieval (returns ULAW encoded file). (free)
    Input: LicenseKey, SoundFileID
    Output: base64Binary
  • GetSoundFileLength
    Gets a Sound File length in Seconds. (free)
    Input: LicenseKey, SoundFileID
    Output: double
  • GetSoundFileURL
    Sound file Retrieval. Returns a URL to Listen to a particular Sound File in MP3 (free)
    Input: SoundFileID, LicenseKey
    Output: string
  • 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)
    Input: TTSvolume, TextToSay, BitRate, VoiceID, TTSrate, LicenseKey
    Output: base64Binary
  • GetTTSInULAW
    Allows you to convert text into a ULAW encoded sound file. (May require an additional License Key)
    Input: VoiceID, TTSrate, LicenseKey, TextToSay, TTSvolume
    Output: base64Binary
  • GetVersion
    This method returns CDYNE Version information
    Input:
    Output: string
  • getVoices
    This method will list all the voices available for your notification. Use the VoiceID for the Notification Methods
    Input:
    Output: ArrayOfVoice
  • LicenseKeyVariableLoad
    Variable Management - Load a key's variable (The Variable name can be up to 50 characters long).
    Input: VariableName, LicenseKey
    Output: string
  • 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.
    Input: VariableValue, LicenseKey, VariableName
    Output: boolean
  • 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.
    Input: PhoneNumber, ListID, LastName, ClientID, LicenseKey, FirstName
    Output: int
  • 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.
    Input: LicenseKey, ListName, ParentListID
    Output: int
  • 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
    Input: ParentListID, Licensekey, ListID, ListName
    Output: boolean
  • LM_AlterListMember
    List Management - Allows you alter a ListMember
    Input: PhoneNumber, licensekey, LastName, ClientID, ListMemberID, FirstName
    Output: boolean
  • LM_DeleteList
    List Management - Deletes a List and it's sub-lists (The lists that have is as a ParentListID).
    Input: LicenseKey, ListID
    Output: boolean
  • LM_DeleteListMember
    List Management - Deletes a List's Member (or contact)
    Input: LicenseKey, ListMemberID
    Output: boolean
  • 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
    Input: ListID, CallerID, TextToSay, DialRecursiveLists, VoiceID, LicenseKey, CallerIDName
    Output: LM_DialReturn
  • LM_GetListIDsByLicensekey
    List Management - Obtains all the list IDs from a specific License key.
    Input: licensekey
    Output: ArrayOfLM_ListIDs
  • LM_GetListMembersByListID
    List Management - Gets all the phone numbers with their first and last names.
    Input: ListID, Licensekey
    Output: ArrayOfLM_ListMembers
  • 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.
    Input: PhoneNumbersToDial, VoiceID, LicenseKey, CallerIDname, TextToSay, CallerID
    Output: ArrayOfNotifyReturn
  • 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.
    Input: PhoneNumbersToDial, CallsPerMinute, TextToSay, CallerIDname, LicenseKey, VoiceID, CallerID
    Output: ArrayOfNotifyReturn
  • 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.
    Input: CallerID, PhoneNumberToDial, TextToSay, CallerIDname, LicenseKey, VoiceID
    Output: NotifyReturn
  • 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.
    Input: TextToSay, CallerID, PhoneNumberToDial, VoiceID, TransferNumber, LicenseKey, CallerIDname
    Output: NotifyReturn
  • NotifyPhoneBasicWithTryCount
    Same as NotifyPhoneBasic with a number of times it will retry the call. The max is 3. Demos are not allowed.
    Input: CallerIDname, TextToSay, PhoneNumberToDial, CallerID, VoiceID, TryCount, LicenseKey
    Output: NotifyReturn
  • 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.
    Input: PhoneNumberToDial, TextToSay, LicenseKey
    Output: NotifyReturn
  • 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. Demos are not allowed.
    Input: PhoneNumberToDial, LicenseKey, SoundFileID
    Output: boolean
  • RemoveSoundFile
    Sound file delete. (free)
    Input: LicenseKey, SoundFileID
    Output: boolean
  • ReturnSoundFileIDs
    Get available sound files that you can add to your stream via a license key. (free)
    Input: LicenseKey
    Output: ArrayOfString
  • ScriptDelete
    Script Management - Delete a script
    Input: LicenseKey, ScriptName
    Output: boolean
  • 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.
    Input: IncludeGlobalScripts, LicenseKey
    Output: ArrayOfString
  • ScriptLoad
    Script Management - Load a script's text
    Input: LicenseKey, ScriptName
    Output: string
  • 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.
    Input: ScriptName, LicenseKey, ScriptText
    Output: boolean
  • SetIncomingCallScript
    Allows you to update a Call Script for incoming calls. You must have incoming phone numbers set by CDYNE Staff.
    Input: Script, LicenseKey, PhoneNumber
    Output: boolean
  • 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)
    Input: SoundFileID, LicenseKey, FileBinary
    Output: UploadFileResponse

• PhoneNotifySoap (Protocol: SOAP12_HTTP)

  • 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.
    Input: CancelNotify
    Output: CancelNotifyResponse
  • 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.
    Input: GetIncomingCallScript
    Output: GetIncomingCallScriptResponse
  • 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.
    Input: GetMultipleQueueIdStatus
    Output: GetMultipleQueueIdStatusResponse
  • GetQueueIDStatus
    Returns a status on a particular QueueID.
    Input: GetQueueIDStatus
    Output: GetQueueIDStatusResponse
  • GetQueueIDStatusesByPhoneNumber
    Returns the last 10 phone notifications for a particular phone number.
    Input: GetQueueIDStatusesByPhoneNumber
    Output: GetQueueIDStatusesByPhoneNumberResponse
  • GetQueueIDStatusWithAdvancedInfo
    Returns a status on a particular QueueID. This also includes Variable information and more.
    Input: GetQueueIDStatusWithAdvancedInfo
    Output: GetQueueIDStatusWithAdvancedInfoResponse
  • GetResponseCodes
    This method will list all of the Response Codes.
    Input: GetResponseCodes
    Output: GetResponseCodesResponse
  • GetSoundFile
    Sound file Retrieval (returns ADPCM encoded file). (free)
    Input: GetSoundFile
    Output: GetSoundFileResponse
  • GetSoundFileInMP3
    Sound file Retrieval (returns an MP3 encoded in 32,64, or 128). (free)
    Input: GetSoundFileInMP3
    Output: GetSoundFileInMP3Response
  • GetSoundFileInUlaw
    Sound file Retrieval (returns ULAW encoded file). (free)
    Input: GetSoundFileInUlaw
    Output: GetSoundFileInUlawResponse
  • GetSoundFileLength
    Gets a Sound File length in Seconds. (free)
    Input: GetSoundFileLength
    Output: GetSoundFileLengthResponse
  • GetSoundFileURL
    Sound file Retrieval. Returns a URL to Listen to a particular Sound File in MP3 (free)
    Input: GetSoundFileURL
    Output: GetSoundFileURLResponse
  • 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)
    Input: GetTTSInMP3
    Output: GetTTSInMP3Response
  • GetTTSInULAW
    Allows you to convert text into a ULAW encoded sound file. (May require an additional License Key)
    Input: GetTTSInULAW
    Output: GetTTSInULAWResponse
  • GetVersion
    This method returns CDYNE Version information
    Input: GetVersion
    Output: GetVersionResponse
  • getVoices
    This method will list all the voices available for your notification. Use the VoiceID for the Notification Methods
    Input: getVoices
    Output: getVoicesResponse
  • LicenseKeyVariableLoad
    Variable Management - Load a key's variable (The Variable name can be up to 50 characters long).
    Input: LicenseKeyVariableLoad
    Output: LicenseKeyVariableLoadResponse
  • 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.
    Input: LicenseKeyVariableSave
    Output: LicenseKeyVariableSaveResponse
  • 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.
    Input: LM_AddListMember
    Output: LM_AddListMemberResponse
  • 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.
    Input: LM_AddNewList
    Output: LM_AddNewListResponse
  • 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
    Input: LM_AlterListID
    Output: LM_AlterListIDResponse
  • LM_AlterListMember
    List Management - Allows you alter a ListMember
    Input: LM_AlterListMember
    Output: LM_AlterListMemberResponse
  • LM_DeleteList
    List Management - Deletes a List and it's sub-lists (The lists that have is as a ParentListID).
    Input: LM_DeleteList
    Output: LM_DeleteListResponse
  • LM_DeleteListMember
    List Management - Deletes a List's Member (or contact)
    Input: LM_DeleteListMember
    Output: LM_DeleteListMemberResponse
  • 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
    Input: LM_DialList
    Output: LM_DialListResponse
  • LM_DialListAdvanced
    List Management - Dial a list by ListID that allows you to set more advanced properties.
    Input: LM_DialListAdvanced
    Output: LM_DialListAdvancedResponse
  • LM_GetListIDsByLicensekey
    List Management - Obtains all the list IDs from a specific License key.
    Input: LM_GetListIDsByLicensekey
    Output: LM_GetListIDsByLicensekeyResponse
  • LM_GetListMembersByListID
    List Management - Gets all the phone numbers with their first and last names.
    Input: LM_GetListMembersByListID
    Output: LM_GetListMembersByListIDResponse
  • 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. Demos are not allowed.
    Input: NotifyMultiplePhoneAdvanced
    Output: NotifyMultiplePhoneAdvancedResponse
  • 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.
    Input: NotifyMultiplePhoneBasic
    Output: NotifyMultiplePhoneBasicResponse
  • 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.
    Input: NotifyMultiplePhoneBasicWithCPM
    Output: NotifyMultiplePhoneBasicWithCPMResponse
  • NotifyPhoneAdvanced
    Allows you to control the notifies with a class. This allows for the maximum combinations of using notify. Demos are not allowed.
    Input: NotifyPhoneAdvanced
    Output: NotifyPhoneAdvancedResponse
  • 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.
    Input: NotifyPhoneBasic
    Output: NotifyPhoneBasicResponse
  • 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.
    Input: NotifyPhoneBasicWithTransfer
    Output: NotifyPhoneBasicWithTransferResponse