PHONE CALLS

AssignIncomingNumber

This method assigns an incoming number to a license key. You can get available incoming numbers with the GetAvailableIncomingNumbers method. (Numbers are billed at $5/month per number. Normal fees for transactions apply.)

Syntax

AssignIncomingNumber(IncomingPhoneNumber, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
IncomingPhoneNumber	The incoming phone number.	String	True	7575551111
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Boolean

Description: True if assignment was successful. False if the number is already claimed or otherwise unavailable.

CancelConference

Use this method to cancel a conference.

Syntax

CancelConference(ConferenceKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
ConferenceKey	The key of the conference you want to cancel.	String	True	b825700e-5180-4e77-8599-2e2eb6c4c1ba

Response

Returns: void

CancelNotify

This method cancels a single call that is scheduled for the future. It will not cancel completed calls or calls in progress. You will receive credit for any successfully cancelled call.

Syntax

CancelNotify(QueueID, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
QueueID	The unique ID of a single call, as returned from any Notify* operation.	Long	True	4093249
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Boolean

Description: True if cancellation was successful. False otherwise.

CancelNotifyByReferenceID

This method cancels any calls that have a given reference ID. This method will not cancel completed calls or calls in progress. You will receive credit for any successfully cancelled calls. (Reference IDs can be assigned when scheduling calls with the NotifyPhoneAdvanced, NotifyMultiplePhoneAdvanced, or NotifyMultiplePhoneBasicWithCPMandReferenceID methods.)

Syntax

CancelNotifyByReferenceID(ReferenceID, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
ReferenceID	The reference ID of one or more calls.	String	True	notify1
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Integer

Description: Total number of calls that were cancelled.

GetAssignedNumbers

This method gets the incoming numbers assigned to a given license key.

Syntax

GetAssignedNumbers(LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Array of String values

Description: A list of assigned numbers.

GetAvailableAreaCodes

This method retrieves all the area codes that are available for incoming numbers. You can search for area codes when using the GetAvailableIncomingNumbers method.

Syntax

GetAvailableAreaCodes()

Request Parameters

This method has no request parameters.

Response

Returns: Array of AreaCode objects

Description: A list of available area codes.

GetAvailableIncomingNumbers

This method will retrieve 10 random lines available for incoming calls. You can assign these lines to your license key via the AssignIncomingNumber method.

Syntax

GetAvailableIncomingNumbers(AreaCodeFilter)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
AreaCodeFilter	Area code to search for. If fewer than 10 numbers are available for this area code, numbers with other area codes will be included in the results. Use an empty string to get any available toll-free lines.	String	False (may be an empty string)	877

Response

Returns: Array of String values

Description: A list of available incoming numbers.

GetVersion

This method retrieves the current version of the Phone Broadcast API.

Syntax

GetVersion()/sms-broadcasting-software

Request Parameters

This method has no request parameters.

Response

Returns: String

Description: The current version of the Phone Broadcast API.

Sample:
1.1.0

getVoices

This method retrieves all the voices available for calls. You can use the VoiceID to change the voice used when reading a message.

Syntax

getVoices()

Request Parameters

This method has no request parameters.

Response

Returns: Array of Voice objects

LicenseKeyVariableLoad

This method retrieves the value of a variable. Variables can be used in your call scripts.

Syntax

LicenseKeyVariableLoad(VariableName, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
VariableName	The variable name. Values longer than 50 characters will be truncated.	String	True	country
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: String

Description: The value of the variable.

LicenseKeyVariableSave

This method saves a new value to a variable. Variables can be used in your call scripts.

Syntax

LicenseKeyVariableSave(VariableName, VariableValue, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
VariableName	Whatever name you want for the variable. Values longer than 50 characters will be truncated. Saving a variable with an existing name will overwrite the old variable.	String	True	country
VariableValue	The value to assign to the variable. Saving a blank value will delete the variable.	String	False (may be an empty string)	Mexico
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Boolean

Description: Whether the variable was successfully saved.

NotifyPhoneAdvanced

This method calls any phone number and read aloud the contents of TextToSay. Use NotifyMultiplePhoneAdvanced to call multiple phone numbers.

Syntax

NotifyPhoneAdvanced(Request)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
PhoneNumberToDial	The phone number to call. It can be in any format, as long as there are 10 digits. To dial an extension, add x followed by the extension.	String	True	7575559999
TransferNumber	The phone number that the call will be transferred to if the call recipient presses 0. Transfer behavior can be further modified with TextToSay commands.	String	False	7575558888
VoiceID	The text-to-speech voice ID.	Integer	True	2
CallerIDNumber	The number to display on the receiving party’s Caller ID.	String	False	7575550000
CallerIDName	The name to display on the receiving party’s Caller ID. (Most carriers ignore this and use their own directory assistance to display name information.)	String	False	Esendex Services
TextToSay	The text-to-speech text or combination of text-to-speech and script to be read to the receiving party.	String	True	Hello, this is a sample call from Phone Notify.
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000
TryCount	The number of times to attempt dialing if the initial call is unanswered or busy. The maximum is 3.	Integer	True	2
NextTryInSeconds	The number of seconds to wait until the next retry is performed if the original call is unanswered or busy. We recommend waiting at least 60 seconds.	Integer	True	180
UTCScheduledDateTime	The date and time at which to send the call, specified as Coordinated Universal Time (UTC).	DateTime	True	2020-11-17T08:25:08.336Z
TTSrate	The speed that text-to-speech (TTS) will use when speaking the text. The value ranges from 0 to 20 (10 being normal). This can also be controlled within the TextToSay parameter.	Byte	True	10
TTSvolume	The volume that text-to-speech (TTS) will use when speaking the text. The value ranges from 0 to 100 (100 being the default). This can also be controlled within the TextToSay parameter.	Byte	True	100
MaxCallLength	The maximum time duration of the call, in seconds. We recommend you do not change this unless you absolutely need to.	Integer	True	80
StatusChangePostUrl	The URL to post call status changes to. The URL must be in lowercase. The system posts OutgoingPostback data for outgoing calls and IncomingPostback data for incoming calls.	String	False	https://example.com/callprogress.aspx
ReferenceID	An optional ID to help you identify the call.	String	False	notify1

Response

Returns: NotifyReturn object

NotifyPhoneBasic

This method calls any phone number and read aloud the contents of TextToSay. Additional options are available in the NotifyPhoneAdvanced method.

Syntax

NotifyPhoneBasic(PhoneNumberToDial, TextToSay, CallerID, CallerIDName, VoiceID, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
PhoneNumberToDial	The phone number to call. It can be in any format, as long as there are 10 digits. To dial an extension, add x followed by the extension.	String	True	7575559999
TextToSay	The text-to-speech text or combination of text-to-speech and script to be read to the receiving party.	String	True	Hello, this is a sample call from Phone Notify.
CallerID	The number to display on the receiving party’s Caller ID.	String	False (may be an empty string)	7575550000
CallerIDname	The name to display on the receiving party’s Caller ID. (Most carriers ignore this and use their own directory assistance to display name information.)	String	False (may be an empty string)	Esendex Services
VoiceID	The text-to-speech voice ID.	String	True	2
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: NotifyReturn object

NotifyPhoneBasicWithTransfer

This method calls any phone number and read aloud the contents of TextToSay. The recipient will be transferred upon pressing 0. Additional options are available in the NotifyPhoneAdvanced method.

Syntax

NotifyPhoneBasicWithTransfer(PhoneNumberToDial, TransferNumber, TextToSay, CallerID, CallerIDName, VoiceID, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
PhoneNumberToDial	The phone number to call. It can be in any format, as long as there are 10 digits. To dial an extension, add x followed by the extension.	String	True	7575559999
TransferNumber	The phone number that the call will be transferred to if the call recipient presses 0. Transfer behavior can be further modified with TextToSay commands.	String	True	7575558888
TextToSay	The text-to-speech text or combination of text-to-speech and script to be read to the receiving party.	String	True	Hello, this is a sample call from Phone Notify.
CallerID	The number to display on the receiving party’s Caller ID.	String	False (may be an empty string)	7575550000
CallerIDname	The name to display on the receiving party’s Caller ID. (Most carriers ignore this and use their own directory assistance to display name information.)	String	False (may be an empty string)	Esendex Services
VoiceID	The text-to-speech voice ID.	String	True	2
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: NotifyReturn object

NotifyPhoneBasicWithTryCount

This method calls any phone number and read aloud the contents of TextToSay. Use the TryCount parameter to specify the number of times the operation should retry the call if the original call is unanswered or busy. Additional options are available in the NotifyPhoneAdvanced method.

Syntax

NotifyPhoneBasicWithTryCount(TryCount, PhoneNumberToDial, TextToSay, CallerID, CallerIDName, VoiceID, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
TryCount	The number of times to attempt dialing if the initial call is unanswered or busy. The maximum is 3.	String	True	2
PhoneNumberToDial	The phone number to call. It can be in any format, as long as there are 10 digits. To dial an extension, add x followed by the extension.	String	True	7575559999
TextToSay	The text-to-speech text or combination of text-to-speech and script to be read to the receiving party.	String	True	Hello, this is a sample call from Phone Notify.
CallerID	The number to display on the receiving party’s Caller ID.	String	False (may be an empty string)	7575550000
CallerIDname	The name to display on the receiving party’s Caller ID. (Most carriers ignore this and use their own directory assistance to display name information.)	String	False (may be an empty string)	Esendex Services
VoiceID	The text-to-speech voice ID.	String	True	2
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: NotifyReturn object

NotifyPhoneEnglishBasic

This method calls any phone number and read aloud the contents of TextToSay using the voice of Diane (VoiceID: 0). Additional options are available in the NotifyPhoneAdvanced method.

Syntax

NotifyPhoneEnglishBasic(PhoneNumberToDial, TextToSay, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
PhoneNumberToDial	The phone number to call. It can be in any format, as long as there are 10 digits. To dial an extension, add x followed by the extension.	String	True	7575559999
TextToSay	The text-to-speech text or combination of text-to-speech and script to be read to the receiving party.	String	True	Hello, this is a sample call from Phone Notify.
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: NotifyReturn object

NotifyMultiplePhoneAdvanced

This method sends multiple calls. (We suggest using member lists for batches of over 100 messages. See the LM_DialListAdvanced method.)

Syntax

NotifyMultiplePhoneAdvanced(MultipleANR)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
MultipleANR	One or more calls that you want to send.	Array of AdvancedNotifyRequest objects	True

Response

Returns: Array of NotifyReturn objects

NotifyMultiplePhoneBasic

This method calls multiple phone numbers and reads aloud the contents of TextToSay. Additional options are available with the NotifyMultiplePhoneAdvanced method.

Syntax

NotifyMultiplePhoneBasic(PhoneNumbersToDial, TextToSay, CallerID, CallerIDName, VoiceID, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
PhoneNumbersToDial	One or more phone numbers to call. Separate each number with a semicolon.	String	True	7575559999; 9135550102; 9135550104
TextToSay	The text-to-speech text or combination of text-to-speech and script to be read to the receiving party.	String	True	Hello, this is a sample call from Phone Notify.
CallerID	The number to display on the receiving party’s Caller ID.	String	False (may be an empty string)	7575550000
CallerIDName	The name to display on the receiving party’s Caller ID. (Most carriers ignore this and use their own directory assistance to display name information.)	String	False (may be an empty string)	Esendex Services
VoiceID	The text-to-speech voice ID.	String	True	2
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Array of NotifyReturn objects

NotifyMultiplePhoneBasicWithCPM

This method calls multiple phone numbers and reads aloud the contents of TextToSay. Use the CallsPerMinute parameter to set the number of calls per minute (CPM). Additional options are available with the NotifyMultiplePhoneAdvanced method.

Syntax

NotifyMultiplePhoneBasicWithCPM(PhoneNumbersToDial, TextToSay, CallerID, CallerIDName, VoiceID, CallsPerMinute, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
PhoneNumbersToDial	One or more phone numbers to call. Separate each number with a semicolon.	String	True	7575559999; 9135550102; 9135550104
TextToSay	The text-to-speech text or combination of text-to-speech and script to be read to the receiving party.	String	True	Hello, this is a sample call from Phone Notify.
CallerID	The number to display on the receiving party’s Caller ID.	String	False (may be an empty string)	7575550000
CallerIDname	The name to display on the receiving party’s Caller ID. (Most carriers ignore this and use their own directory assistance to display name information.)	String	False (may be an empty string)	Esendex Services
VoiceID	The text-to-speech voice ID.	String	True	2
CallsPerMinute	The number of calls to send per minute.	Integer	True	50
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Array of NotifyReturn objects

NotifyMultiplePhoneBasicWithCPMandReferenceID

This method calls multiple phone numbers and reads aloud the contents of TextToSay. Use the CallsPerMinute parameter to set the number of calls per minute (CPM). Use the ReferenceID parameter to set a custom ID for the calls. Additional options are available with the NotifyMultiplePhoneAdvanced method.

Syntax

NotifyMultiplePhoneBasicWithCPM(PhoneNumbersToDial, TextToSay, CallerID, CallerIDName, VoiceID, CallsPerMinute, ReferenceID, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
PhoneNumbersToDial	One or more phone numbers to call. Separate each number with a semicolon.	String	True	7575559999; 9135550102; 9135550104
TextToSay	The text-to-speech text or combination of text-to-speech and script to be read to the receiving party.	String	True	Hello, this is a sample call from Phone Notify.
CallerID	The number to display on the receiving party’s Caller ID.	String	False (may be an empty string)	7575550000
CallerIDname	The name to display on the receiving party’s Caller ID. (Most carriers ignore this and use their own directory assistance to display name information.)	String	False (may be an empty string)	Esendex Services
VoiceID	The text-to-speech voice ID.	String	True	2
CallsPerMinute	The number of calls to send per minute.	Integer	True	50
ReferenceID	An ID to help you identify the calls.	String	True	batch1
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Array of NotifyReturn objects

STATUS REPORTS

GetMultipleQueueIdStatus

This method retrieves the statuses of one or more calls.

Syntax

GetMultipleQueueIdStatus(QueueIDs, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
QueueIDs	One or more call IDs, as returned from any Notify* operation. Separate the IDs with semicolons.	String	True	4093249; 4093250; 4093251
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Array of NotifyReturn objects

GetQueueIDStatus

This method retrieves the status of a given call.

Syntax

GetQueueIDStatus(QueueID)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
QueueID	The unique ID of a single call, as returned from any Notify* operation.	Long	True	4093249

Response

Returns: NotifyReturn object

GetQueueIDStatusesByPhoneNumber

This method retrieves the last 10 phone calls for a given phone number.

Syntax

GetQueueIDStatusesByPhoneNumber(PhoneNumber, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
PhoneNumber	The phone number for which you want to get statuses.	String	True	7575449510
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Array of NotifyReturn objects

GetQueueIDStatusWithAdvancedInfo

This method retrieves the status of a given call. This method retrieves variable information and more.

Syntax

GetQueueIDStatusWithAdvancedInfo(QueueID, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
QueueID	The unique ID of a single call, as returned from any Notify* operation.	Long	True	4093249
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: NotifyReturn object

GetResponseCodes

This method retrieves all response codes that may be returned when invoking Notify* methods.

Syntax

GetResponseCodes()

Request Parameters

This method has no request parameters.

Response

Returns: Array of Response objects

SCRIPTS

GetIncomingCallScript

This method retrieves the call script for incoming calls to a given number. (Contact Esendex to enable incoming phone numbers.)

Syntax

GetIncomingCallScript(PhoneNumber, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
PhoneNumber	Your incoming phone number.	String	True	8005551234
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: String

Description: The script currently in use for incoming calls to the specified phone number.

Sample:
~\Label(Begin)~
~\ClearDTMF()~
~\ActOnDigitPress(false)~
~\SetVar(Attempt|1)~
Hello. Welcome to Esendex.
Press 1 to speak to a sales representative or press…, etc.
~\EndCall()~

ScriptDelete

This method deletes a call script.

Syntax

ScriptDelete(ScriptName, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
ScriptName	The name of the script to delete.	String	True	Script1
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Boolean

ScriptList

This method retrieves a list of call scripts available for your license key.

Syntax

ScriptList(IncludeGlobalScripts, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
IncludeGlobalScripts	Whether you want to include Esendex Global Scripts in the returned list.	Boolean	True	False
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Array of String values

Description: The names of all call scripts that were found.

ScriptLoad

This method retrieves the contents of a script.

Syntax

ScriptLoad(ScriptName, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
ScriptName	The name of the script to load.	String	True	Script1
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: String

Description: The text (contents) of the specified script.

ScriptSave

This method saves a call script.

Syntax

ScriptSave(ScriptName, ScriptText, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
ScriptName	The script name. Must be 50 characters or fewer. Using an existing name will overwrite the old script.	String	True	Script1
ScriptText	The text-to-speech text or combination of text-to-speech and script to be read.	String	True	Hello. Welcome to Esendex.
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Boolean

Description: True if the save succeeded. False otherwise.

SetIncomingCallScript

This method updates the call script for incoming calls to a given number. (Contact Esendex to enable incoming phone numbers.)

Syntax

SetIncomingCallScript(PhoneNumber, Script, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
PhoneNumber	Your incoming phone number.	String	True	8005551234
Script	The text-to-speech text or combination of text-to-speech and script to use for inbound phone calls.	String	True	Hello. Welcome to Esendex.
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Boolean

Description: Returns true if the operation succeeded, false if not.

SOUND FILES

GetSoundFileInMP3

This method retrieves a sound file encoded as an MP3 in a 32, 64, or 128 kbit/s bit rate.

Syntax

GetSoundFileInMP3(SoundFileID, BitRate, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
SoundFileID	The sound file’s ID.	String	True	greeting
BitRate	The desired bit rate in kbit/s for the returned MP3 file. Valid bit rates are 32, 64, and 128.	Integer	True	128
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: GetSoundFileInMP3Response

Description: The sound file.

GetSoundFileInMP3

This method retrieves a sound file encoded as an MP3 in a 32, 64, or 128 kbit/s bit rate.

Syntax

GetSoundFileInMP3(SoundFileID, BitRate, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
SoundFileID	The sound file’s ID.	String	True	greeting
BitRate	The desired bit rate in kbit/s for the returned MP3 file. Valid bit rates are 32, 64, and 128.	Integer	True	128
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: GetSoundFileInMP3Response

Description: The sound file.

GetSoundFileInUlaw

This method retrieves a sound file encoded in μ-law (u-law) format.

Syntax

GetSoundFileInUlaw(SoundFileID, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
SoundFileID	The sound file’s ID.	String	True	greeting
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: GetSoundFileInUlawResponse

Description: The sound file.

GetSoundFileLength

This method retrieves a sound file’s length in seconds.

Syntax

GetSoundFileLength(SoundFileID, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
SoundFileID	The sound file’s ID.	String	True	greeting
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Double

Description: The length of the file, in seconds.

Sample:
6.123

GetSoundFileURL

This method retrieves a URL to listen to a particular sound file in MP3 format.

Syntax

GetSoundFileURL(SoundFileID, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
SoundFileID	The sound file’s ID.	String	True	greeting
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: String

Description: The URL of the MP3 file.

Sample:
https://ws.esendex.us/notifyws/p.aspx?s=

GetTTSInMP3

This method returns text-to-speech (TTS) as a sound file in the MP3 format. This method returns an MP3 encoded in a 32, 64, or 128 kbit/s bit rate. (An additional license key is required for this method. Please contact Esendex to activate a TTS License Key.)

Syntax

GetTTSInMP3(TextToSay, VoiceID, BitRate, TTSrate, TTSvolume, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
TextToSay	The text-to-speech text or combination of text-to-speech and script to be read.	String	True	Hello, this is a sample call from Phone Notify.
VoiceID	The text-to-speech voice ID.	Integer	True	2
BitRate	The bit rate for the MP3 file, in kbit/s. Valid bit rates are 32, 64, and 128.	Integer	True	128
TTSrate	The speed that text-to-speech (TTS) will use when speaking the text. The value ranges from 0 to 20 (10 being normal). This can also be controlled within the TextToSay parameter.	Byte	True	10
TTSvolume	The volume that text-to-speech (TTS) will use when speaking the text. The value ranges from 0 to 100 (100 is the default). This can also be controlled within the TextToSay parameter.	Byte	True	100
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: GetTTSInMP3Response

Description: The result of the text-to-speech file in MP3 format.

GetTTSInULAW

This method returns text-to-speech (TTS) as a sound file in the μ-law (u-law) format. (An additional license key is required for this method. Please contact Esendex to activate a TTS License Key.)

Syntax

GetTTSInULAW(TextToSay, VoiceID, TTSrate, TTSvolume, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
TextToSay	The text-to-speech text or combination of text-to-speech and script to be read.	String	True	Hello, this is a sample call from Phone Notify.
VoiceID	The text-to-speech voice ID.	Integer	True	2
TTSrate	The speed that text-to-speech (TTS) will use when speaking the text. The value ranges from 0 to 20 (10 being normal). This can also be controlled within the TextToSay parameter.	Byte	True	10
TTSvolume	The volume that text-to-speech (TTS) will use when speaking the text. The value ranges from 0 to 100 (100 being the default). This can also be controlled within the TextToSay parameter.	Byte	True	100
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: GetTTSInULAWResponse

Description: The result of the text-to-speech file in μ-law (u-law) format.

RecordSoundViaPhoneCall

This method will call you in order to record a sound file. Follow the instructions during the call to record your sound.

Syntax

RecordSoundViaPhoneCall(PhoneNumberToDial, SoundFileID, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
PhoneNumberToDial	The phone number the system should call to get a voice recording. To dial an extension, add x followed by the extension.	String	True	7575551234
SoundFileID	The name you want for your file, for use in future retrieval. The ID will be converted to lowercase.	String	True	greeting
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Boolean

Description: True if the call was sent. False otherwise.

RemoveSoundFile

This method deletes a given sound file.

Syntax

RemoveSoundFile(SoundFileID, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
SoundFileID	The ID of the sound file to delete.	String	True	greeting
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Boolean

Description: True if the deletion was successful. False otherwise.

RenameSoundFile

This method renames a given sound file.

Syntax

RenameSoundFile(SoundFileID, NewSoundFileID, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
SoundFileID	The current sound file ID (name).	String	True	hello
NewSoundFileID	The new sound file ID (name). The ID will be converted to lowercase.	String	True	greeting
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Boolean

Description: True if the renaming was successful. False otherwise.

ReturnSoundFileIDs

This method retrieves the IDs of all sound files that you can use in your calls.

Syntax

ReturnSoundFileIDs(LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Array of String objects

Description: The IDs of all uploaded or recorded sound files available on your license key.

UploadSoundFile

This method uploads a sound file. Our system accepts WAV files (PCM, u-law, A-law, or MS ADPCM). To use the sound file in a message, put tildes (~) around it and start it with a caret (^). Example: Hello ~^soundfile~, you are great. (The message would say “Hello,” then play the sound file, and then say “you are great.”)

Syntax

UploadSoundFile(FileBinary, SoundFileID, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
FileBinary	The WAV file to upload. The minimum recommended sound quality is 16-bit mono PCM. The maximum file size allowed is 2 MB. Split your sound into multiple files if it is larger than 2 MB.	Array of Byte values	True
SoundFileID	The ID to use for retrieving the sound file later on. The ID will be converted to lowercase.	String	True	greeting
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: UploadSoundFileResponse object

LISTS

LM_AddListMember

This method adds a contact (member) to a list. If you don’t have a list yet, create it first using the LM_AddNewList method.

Syntax

LM_AddListMember(ListID, LicenseKey, PhoneNumber, ClientID, FirstName, LastName)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
ListID	The ID of the list that the new member will be added to.	Integer	True	1234
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000
PhoneNumber	The member’s phone number.	String	True	7575449510
ClientID	The member’s business or consumer full name. This parameter can also be used to save additional information about the member.	String	False (may be an empty string)	client1
FirstName	The member’s first name.	String	False (may be an empty string)	John
LastName	The member’s last name.	String	False (may be an empty string)	Smith

Response

Returns: Integer

Description: If the operation succeeded, it returns a positive number that is the new member’s ID. (You will need this ID to alter the member.) If the operation failed, the operation returns -1 (the phone number might be invalid).

LM_AddNewList

This method creates a list. Lists are used to store a list of contacts (members). Use the LM_DialList or LM_DialListAdvanced methods to send a message to all the members of a list.

Syntax

LM_AddNewList(ListName, ParentListID, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
ListName	The name you want to apply to the new list.	String	True	List Three
ParentListID	The ID of a list which will be this list’s parent. If you don’t want your list to have a parent, set this value to 0.	Integer	True	1230
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Integer

Description: If this operation succeeded, it returns a positive number that is the new list’s ID. (You will need this ID to alter or send messages to the list.)

LM_AlterListID

This method changes the parent list or name of an existing list.

Syntax

LM_AlterListID(ListID, ParentListID, ListName, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
ListID	The list’s ID.	Integer	True	1234
ParentListID	The ID of a list which will be this list’s parent. If you don’t want your list to have a parent, set this value to 0. To leave the parent list setting unchanged, set this value to -1.	Integer	True	1230
ListName	The name you want to apply to the list.	String	True	List Three
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Boolean

Description: True if the alteration succeeded. False otherwise.

LM_AlterListMember

This method modifies an existing list member (contact).

Syntax

LM_AlterListMember(ListMemberID, LicenseKey, ClientID, FirstName, LastName, PhoneNumber)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
ListMemberID	The member’s ID.	Integer	True	123
ClientID	The member’s business or consumer full name. This parameter can also be used to save additional information about the member. Use an empty string to keep the previous value.	String	False (may be an empty string)	client1
FirstName	The member’s first name. Use an empty string to keep the previous value.	String	False (may be an empty string)	John
LastName	The member’s last name. Use an empty string to keep the previous value.	String	False (may be an empty string)	Smith
PhoneNumber	The member’s phone number.	String	True	7575449510
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Boolean

Description: True if the alteration succeeded. False otherwise.

LM_DeleteList

This method deletes a list and all its sub-lists (the lists that have it as their ParentListID).

Syntax

LM_DeleteList(ListID, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
ListID	The ID of the list you want to delete.	Integer	True	1234
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Boolean

Description: True if the deletion succeeded. False otherwise.

LM_DeleteListMember

This method deletes a member (contact) from a list.

Syntax

LM_DeleteListMember(ListMemberID, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
ListMemberID	The ID of the member you want to delete.	Integer	True	123
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: Boolean

Description: True if the deletion succeeded. False otherwise.

LM_DialList

This method dials all the members of a list and reads aloud the contents of TextToSay. Additional options are available in the LM_DialListAdvanced method.

Syntax

LM_DialList(ListID, DialRecursiveLists, CallerID, CallerIDName, VoiceID, TextToSay, LicenseKey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
ListID	The ID of the list to dial.	Integer	True	1234
DialRecursiveLists	Whether to dial child lists.	Boolean	True	False
CallerID	The number to display on the receiving party’s Caller ID.	String	True	7575550000
CallerIDName	The name to display on the receiving party’s Caller ID. (Most carriers ignore this and use their own directory assistance to display name information.)	String	False (may be an empty string)	Esendex Services
VoiceID	The text-to-speech voice ID.	Byte	True	2
TextToSay	The text-to-speech text or combination of text-to-speech and script to be read to the receiving party.	String	True	Hello, this is a sample call from Phone Notify.
LicenseKey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: LM_DialReturn object

LM_DialListAdvanced

This method dials all the members of a list and reads aloud the contents of TextToSay.

Syntax

LM_DialListAdvanced(Request)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
CallerID	The number to display on the receiving party’s Caller ID.	String	True	7575550000
CallerIDName	The name to display on the receiving party’s Caller ID. (Most carriers ignore this and use their own directory assistance to display name information.)	String	False	Esendex Services
VoiceID	The text-to-speech voice ID.	Byte	True	2
TextToSay	The text-to-speech text or combination of text-to-speech and script to be read to the receiving party.	String	True	Hello, this is a sample call from Phone Notify.
TryCount	The number of times to attempt dialing if the initial call is unanswered or busy. The maximum is 3.	Byte	True	2
Licensekey	Your license key.	String	True	00000000-0000-0000-0000-000000000000
Extension	The phone number extension.	String	False	333
TransferNumber	The phone number that the call will be transferred to if the call recipient presses 0. Transfer behavior can be further modified with TextToSay commands.	String	False	7575558888
NextTryInSeconds	The number of seconds to wait until the next retry is performed if the original call is unanswered or busy. We recommend waiting at least 60 seconds.	Integer	True	180
TTSRate	The speed that text-to-speech (TTS) will use when speaking the text. The value ranges from 0 to 20 (10 being normal). This can also be controlled within the TextToSay parameter.	Byte	True	10
TTSVolume	The volume that text-to-speech (TTS) will use when speaking the text. The value ranges from 0 to 100 (100 being the default). This can also be controlled within the TextToSay parameter.	Byte	True	100
ScheduledUTCDatetime	The date and time at which to send the call. This is specified as Coordinated Universal Time (UTC).	DateTime	True	2020-11-17T08:25:08.336Z
ListID	The ID of the list to dial.	Integer	True	1234
DialRecursiveLists	Whether to dial child lists.	Boolean	True	False

Response

Returns: LM_DialReturn object

LM_GetListIDsByLicensekey

This method retrieves all the lists from a given license key.

Syntax

LM_GetListIDsByLicensekey(Licensekey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
Licensekey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: LM_GetListIDsByLicensekeyResponse

LM_GetListMembersByListID

This method retrieves all the members (contacts) in a given list.

Syntax

LM_GetListMembersByListID(ListID, Licensekey)

Request Parameters

Parameter Name	Description	Data Type	Required	Sample Value
ListID	The ID of the list you want to get.	Integer	True	1234
Licensekey	Your license key.	String	True	00000000-0000-0000-0000-000000000000

Response

Returns: LM_GetListMembersByListIDResponse

TYPES

AdvancedNotifyRequest

This type is used in the NotifyMultiplePhoneAdvanced method.

Type Properties

Property Name	Description	Data Type	Sample
PhoneNumberToDial	The phone number to call. It can be in any format, as long as there are 10 digits. To dial an extension, add x followed by the extension.	String	7575559999
TransferNumber	The phone number that the call will be transferred to if the call recipient presses 0. Transfer behavior can be further modified with TextToSay commands.	String	7575558888
VoiceID	The text-to-speech voice ID.	Integer	2
CallerIDNumber	The number to display on the receiving party’s Caller ID.	String	7575550000
CallerIDName	The name to display on the receiving party’s Caller ID. (Most carriers ignore this and use their own directory assistance to display name information.)	String	Esendex Services
TextToSay	The text-to-speech text or combination of text-to-speech and script to be read to the receiving party.	String	Hello, this is a sample call from Phone Notify.
LicenseKey	Your license key.	String	00000000-0000-0000-0000-000000000000
TryCount	The number of times to attempt dialing if the initial call is unanswered or busy. The maximum is 3.	Integer	2
NextTryInSeconds	The number of seconds to wait until the next retry is performed if the original call is unanswered or busy. We recommend waiting at least 60 seconds.	Integer	180
UTCScheduledDateTime	The date and time at which to send the call, specified as Coordinated Universal Time (UTC).	DateTime	2020-11-17T08:25:08.336Z
TTSrate	The speed that text-to-speech (TTS) will use when speaking the text. The value ranges from 0 to 20 (10 being normal). This can also be controlled within the TextToSay parameter.	Byte	10
TTSvolume	The volume that text-to-speech (TTS) will use when speaking the text. The value ranges from 0 to 100 (100 being the default). This can also be controlled within the TextToSay parameter.	Byte	100
MaxCallLength	The maximum time duration of the call, in seconds. We recommend you do not change this unless you absolutely need to.	Integer	80
StatusChangePostUrl	The URL to post call status changes to. The URL must be in lowercase. The system posts OutgoingPostback data for outgoing calls and IncomingPostback data for incoming calls.	String	https://example.com/callprogress.aspx
ReferenceID	An optional ID to help you identify the call.	String	notify1

AreaCode

This type is returned by the GetAvailableAreaCodes method.

Type Properties

Property Name	Description	Data Type	Sample
AreaCodeNumber	The area code number.	String	855
Location	The area code location.	String	Toll Free

GetSoundFileInMP3Response

This type is returned by the GetSoundFileInMP3 method.

Type Properties

Property Name	Description	Data Type	Sample
GetSoundFileInMP3Result	The sound file data.	Array of Byte values

GetSoundFileInUlawResponse

This type is returned by the GetSoundFileInUlaw method.

Type Properties

Property Name	Description	Data Type	Sample
GetSoundFileInUlawResult	The sound file data.	Array of Byte values

GetSoundFileResponse

This type is returned by the GetSoundFile method.

Type Properties

Property Name	Description	Data Type	Sample
GetSoundFileResult	The sound file data.	Array of Byte values

GetTTSInMP3Response

This type is returned by the GetTTSInMP3 method.

Type Properties

Property Name	Description	Data Type	Sample
GetTTSInMP3Result	The sound file data.	Array of Byte values

GetTTSInULAWResponse

This type is returned by the GetTTSInULAW method.

Type Properties

Property Name	Description	Data Type	Sample
GetTTSInULAWResult	The sound file data.	Array of Byte values

IncomingPostback

Incoming postbacks describe incoming calls. To receive postbacks, specify a StatusChangePostUrl URL in the NotifyPhoneAdvanced or NotifyMultiplePhoneAdvanced methods.

Type Properties

Property Name	Description	Data Type	Sample
QueueID	The unique ID of the call.	Long	4093249
ResponseCode	Status code for the call.	QueueIDStatusCode	0
StartTime	The UTC time when the call started.	DateTime	2020-08-28T00:53:06.608Z
EndTime	The UTC time when the call ended.	DateTime	2020-08-28T00:53:43.654Z
Duration	The total duration of the call, in seconds.	Integer	37
incoming	Whether the call was an incoming call.	Boolean	True
transfercallerid	The number displayed on the receiving party’s Caller ID, if the call is transferred.	String	7575550000
machinedetection	Whether the call was answered by a human or a machine.ValueDescriptionHUMANThe call was answered by a human.MACHINEThe call was answered by a machine.FAXThe call was answered by a fax machine.UNKNOWN	String	HUMAN
digitsdialed	The digits pressed while the call was active.	String	345
extension	The extension of the recipient dialed.	String
lastrecordlength	The duration (in seconds) for the call or portion of the call that was recorded.		37
callerid	The number displayed on the receiving party’s Caller ID.	String	7575550000
phonenumber	The number that received the call.	String	8005551234

LM_DialReturn

Type Properties

Property Name	Description	Data Type	Sample
Success	Whether the operation was successful or not.	Boolean	True
BatchID	A batch ID for the dialed list.	Integer
ResponseCode	Status code for the call.	QueueIDStatusCode	0
ErrorText		String

LM_GetListIDsByLicensekeyResponse

This type is returned by the LM_GetListIDsByLicensekey method.

Type Properties

Property Name	Description	Data Type	Sample
LM_GetListIDsByLicensekeyResult	Zero or more lists assigned to the license key.	Array of LM_ListIDs objects

LM_GetListMembersByListIDResponse

This type is returned by the LM_GetListMembersByListID method.

Type Properties

Property Name	Description	Data Type	Sample
LM_GetListMembersByListIDResult	Zero or more members assigned to the list.	Array of LM_ListMembers objects

LM_ListIDs

This type is included in the LM_GetListIDsByLicensekeyResponse type.

Type Properties

Property Name	Description	Data Type	Sample
ListID	The ID of the list.	Integer	1234
ParentListID	The ID of the parent list. This is 0 if there is no parent list.	Integer	1230
ListName	The name of the list.	String	List Three

LM_ListMembers

This type describes a member (contact) in a list. It is included in the LM_GetListMembersByListIDResponse type.

Type Properties

Property Name	Description	Data Type	Sample
ListMemberID	The member’s ID.	Integer	12
PhoneNumber	The member’s phone number.	String	7575449510
ClientID	The member’s business or consumer full name. This parameter can also be used to save additional information about the member.	String	client1
FirstName	The member’s first name.	String	John
LastName	The member’s last name.	String	Smith

NotifyReturn

This type includes details about a call that you created with the Phone Notify! API.

Type Properties

Property Name	Description	Data Type	Sample
ResponseCode	Status code for the call.	QueueIDStatusCode	1
ResponseText	Status description of the call.	QueueIDStatusText	Call Answered
CallAnswered	Whether the call was answered.	Boolean	True
QueueID	The unique ID of the call. Use this at any time to get the call’s current status with the GetQueueIDStatus and GetQueueIDStatusWithAdvancedInfo methods.	Long	4093249
TryCount	The number of times to attempt dialing if the initial call is unanswered or busy.	Integer	2
Demo		Boolean	False
DigitsPressed	The digits pressed while the call was active.	String	345
MachineDetection	Whether the call was answered by a human or a machine.ValueDescriptionHUMANThe call was answered by a human.MACHINEThe call was answered by a machine.FAXThe call was answered by a fax machine.UNKNOWN	String	HUMAN
Duration	The total duration of the call, in seconds.	Integer	37
StartTime	The UTC time when the call started.	DateTime	2020-08-28T00:53:06.608Z
EndTime	The UTC time when the call ended.	DateTime	2020-08-28T00:53:43.654Z
MinuteRate		Decimal
Country	The country called, if other than U.S. or Canada.	String
CallComplete	Whether the call is complete.	Boolean	True
TextToSay	The text-to-speech text or combination of text-to-speech and script to be read to the receiving party.	String
VariableArray		Array of Variable objects

OutgoingPostback

Outgoing postbacks describe outgoing calls. To receive postbacks, specify a StatusChangePostUrl URL in the NotifyPhoneAdvanced or NotifyMultiplePhoneAdvanced methods.

Type Properties

Property Name	Description	Data Type	Sample
QueueID	The unique ID of the call.	Long	4093249
ResponseCode	Status code for the call.	QueueIDStatusCode	0
StartTime	The UTC time when the call started.	DateTime	2020-08-28T00:53:06.608Z
EndTime	The UTC time when the call ended.	DateTime	2020-08-28T00:53:43.654Z
Duration	The total duration of the call, in seconds.	Integer	37
isWireless	Whether the recipient number is wireless.	Boolean	False
telcoLATA	Local Access and Transport Area. This is the recipient telco’s geographical area.		252
telcoOCN	Operating Company Number. This can tell you which company a call went to.		8825
telcoCarrierName	Recipient telco carrier name.	String
telcoCarrierType	Recipient telco carrier type.
telcoLRN	Location Routing Number. The LRN is a unique 10-digit number that represents a telephone switch through which multiple phone numbers are routed.		7573740000
telcoSwitchName	Recipient telco switch name.		NORFOLK
digitsdialed	The digits pressed while the call was active.	String	345
incallringcount	Number of audible rings after a connection is made. This variable is only present if at least one ring was detected.	Integer	3
qasoundid	Unique identifier to retrieve a call recording, if a call was recorded.
callerid	The number displayed on the receiving party’s Caller ID.	String	7575550000
extension	The extension of the recipient dialed.	String
phonenumber	The number that received the call.	String	7575559999
transfercalleridname	The name displayed on the receiving party’s Caller ID, if the call is transferred. (Most carriers ignore this and use their own directory assistance to display name information.)	String	Esendex Services
lastrecordlength	The duration (in seconds) for the call or portion of the call that was recorded.		37
qarecord	Whether the call was recorded for quality assurance (QA) purposes.	Boolean	False
transfercallerid	The number displayed on the receiving party’s Caller ID, if the call is transferred.	String	7575550000
calleridname	The name displayed on the receiving party’s Caller ID. (Most carriers ignore this and use their own directory assistance to display name information.)	String	Esendex Services
machinedetection	Whether the call was answered by a human or a machine.ValueDescriptionHUMANThe call was answered by a human.MACHINEThe call was answered by a machine.FAXThe call was answered by a fax machine.UNKNOWN	String	HUMAN

QueueIDStatusCode

This type is included in the Response, NotifyReturn, LM_DialReturn, IncomingPostback, and OutgoingPostback types.

Type: Integer

Possible Values

Value	Description
0	Queued
1	Call Answered
2	Call Unanswered
3	Invalid Phone Number
4	Invalid CallerID
5	Invalid VoiceID
6	Invalid Number to Transfer To
7	Invalid Digit for Transfer
8	Busy
9	Universal Error
10	Demo allowance exceeded.
11	Demo not allowed
12	Dialing
13	CallerID and PhoneNumber To Dial cannot match.
14	Key Invalid. IP Address has been suspended.
15	Phone Number Abuse
16	Scheduled Time is not a UTC date/time
17	This site has been identified as a source of abuse.
18	Ringing
19	Trying
20	Call is being Forwarded
21	In Call/Ringing
22	Cancelled
23	Sound File Not Found
24	Transferred
25	Transfer Failed
26	Caller Hung up during transfer
27	Administrative Hold
28	Call Forbidden
29	Incoming Call
30	Incoming Call Complete
31	Incoming Call Transferred
32	TTS Error
33	Time Restriction
34	Congestion/Service Unavail
35	Global Not Acceptable
36	No Supported Media
37	Telecom Timeout
38	Telecom Denied
39	Demo Denied due to FTC regulations
40	TTS Busy – Will Try Again
41	Conference Start
42	Conference Join
43	Telco Reported Vacant Number
44	Number Changed or DisContentected
45	Sound File Processing
46	Ready for Dialer

QueueIDStatusText

Type: String

Possible Values

Value	Description
Queued	Status Code 0
Call Answered	Status Code 1
Call Unanswered	Status Code 2
Invalid Phone Number	Status Code 3
Invalid CallerID	Status Code 4
Invalid VoiceID	Status Code 5
Invalid Number to Transfer To	Status Code 6
Invalid Digit for Transfer	Status Code 7
Busy	Status Code 8
Universal Error	Status Code 9
Demo allowance exceeded.	Status Code 10
Demo not allowed	Status Code 11
Dialing	Status Code 12
CallerID and PhoneNumber To Dial cannot match.	Status Code 13
Key Invalid. IP Address has been suspended.	Status Code 14
Phone Number Abuse	Status Code 15
Scheduled Time is not a UTC date/time	Status Code 16
This site has been identified as a source of abuse.	Status Code 17
Ringing	Status Code 18
Trying	Status Code 19
Call is being Forwarded	Status Code 20
In Call/Ringing	Status Code 21
Cancelled	Status Code 22
Sound File Not Found	Status Code 23
Transferred	Status Code 24
Transfer Failed	Status Code 25
Caller Hung up during transfer	Status Code 26
Administrative Hold	Status Code 27
Call Forbidden	Status Code 28
Incoming Call	Status Code 29
Incoming Call Complete	Status Code 30
Incoming Call Transferred	Status Code 31
TTS Error	Status Code 32
Time Restriction	Status Code 33
Congestion/Service Unavail	Status Code 34
Global Not Acceptable	Status Code 35
No Supported Media	Status Code 36
Telecom Timeout	Status Code 37
Telecom Denied	Status Code 38
Demo Denied due to FTC regulations	Status Code 39
TTS Busy – Will Try Again	Status Code 40
Conference Start	Status Code 41
Conference Join	Status Code 42
Telco Reported Vacant Number	Status Code 43
Number Changed or Disconnected	Status Code 44
Sound File Processing	Status Code 45
Ready for Dialer	Status Code 46

Response

This type describes a possible status for a call. It is returned by the GetResponseCodes method.

Type Properties

Property Name	Description	Data Type	Sample
ResponseCode	Status code for the call.	QueueIDStatusCode	0
ResponseText	Status description of the call.	QueueIDStatusText	Queued

UploadSoundFileResponse

This type is returned by the UploadSoundFile method.

Type Properties

Property Name	Description	Data Type	Sample
UploadSoundFileResult	Result of the upload.	UploadSoundFileResult

UploadSoundFileResult

This type is included in the UploadSoundFileResponse type.

Type Properties

Property Name	Description	Data Type	Sample
UploadedLengthInSeconds	Length of the uploaded file, in seconds.	Integer	8
UploadSuccessful	Whether or not the sound file was uploaded successfully.	Boolean	False
ErrorResponse	If the upload was unsuccessful, an error message describing the problem.	String	Invalid License Key

Variable

Type Properties

Property Name	Description	Data Type	Sample
Name	The name of the variable.	String
Value	The value of the variable.	String

Voice

Voices read the messages delivered by Phone Notify. They use text-to-speech (TTS) technology to transform text into sound. You can get a list of all voices with the getVoices method.

Type Properties

Property Name	Description	Data Type	Sample
VoiceID	The voice’s ID. Use this ID when sending a message to have the text read by a specific voice.	Integer	2
VoiceName	The name of the voice.	String	William
VoiceGender	The gender of the voice.	String	Male
VoiceAge	The age of the voice.	String	30
VoiceLanguage	The language of the voice.	String	US-English
VoiceSummary	The name, language, gender and age of the voice.	String	William – US-English (Male – 30)