TeleFlow Dialer XML
From TeleFlow
(New page: This document describes the XML interface to allow a web programmer/designer to populate and query a TeleFlow Dialer installation. All functions are achieved through HTTP Post of XML docu...) |
(→SendTest) |
||
(2 intermediate revisions not shown.) | |||
Line 20: | Line 20: | ||
<b>Body:</b> | <b>Body:</b> | ||
+ | <xml> | ||
{none} | {none} | ||
+ | </xml> | ||
Use this command to “ping” the TeleFlow Dialer web server to ensure it can be reached and is functioning correctly. This command is not required to use TeleFlow Dialer. It is available as a troubleshooting tool. TeleFlow Dialer server will respond with a simple “Hello!” only. | Use this command to “ping” the TeleFlow Dialer web server to ensure it can be reached and is functioning correctly. This command is not required to use TeleFlow Dialer. It is available as a troubleshooting tool. TeleFlow Dialer server will respond with a simple “Hello!” only. | ||
Line 27: | Line 29: | ||
<u>Success:</u> | <u>Success:</u> | ||
+ | <xml> | ||
<Result>Success</Result> | <Result>Success</Result> | ||
+ | </xml> | ||
Line 35: | Line 39: | ||
<b>Body:</b> | <b>Body:</b> | ||
- | < | + | <xml> |
<?xml version='1.0' encoding='utf-8'?> | <?xml version='1.0' encoding='utf-8'?> | ||
<AuthCheck> | <AuthCheck> | ||
Line 42: | Line 46: | ||
<Customer>{customer_name}</Customer> | <Customer>{customer_name}</Customer> | ||
</AuthCheck> | </AuthCheck> | ||
- | </ | + | </xml> |
This command will check your login credentials against the TeleFlow Dialer server to determine if you are permitted to use the system. It does not affect future interactions with the TeleFlow Dialer. Every command must include user/client authentication. | This command will check your login credentials against the TeleFlow Dialer server to determine if you are permitted to use the system. It does not affect future interactions with the TeleFlow Dialer. Every command must include user/client authentication. | ||
Line 49: | Line 53: | ||
<u>Authorized:</u> | <u>Authorized:</u> | ||
- | < | + | <xml> |
<AuthResult> | <AuthResult> | ||
<UserID>{userID}</UserID> | <UserID>{userID}</UserID> | ||
Line 56: | Line 60: | ||
<Result>Success</Result> | <Result>Success</Result> | ||
</AuthResult> | </AuthResult> | ||
- | </ | + | </xml> |
<u>Not Authorized:</u> | <u>Not Authorized:</u> | ||
- | < | + | <xml> |
<AuthResult> | <AuthResult> | ||
<UserID>{userID}</UserID> | <UserID>{userID}</UserID> | ||
Line 65: | Line 69: | ||
<Result>Failure</Result> | <Result>Failure</Result> | ||
</AuthResult> | </AuthResult> | ||
- | </ | + | </xml> |
Line 73: | Line 77: | ||
<b>Body:</b> | <b>Body:</b> | ||
- | < | + | <xml> |
<?xml version="1.0"?> | <?xml version="1.0"?> | ||
- | <InstallVoice version ="1.0"> | + | <InstallVoice version="1.0"> |
<UserID>{userID}</UserID> | <UserID>{userID}</UserID> | ||
<Password>{password}</Password> | <Password>{password}</Password> | ||
Line 83: | Line 87: | ||
<FileContents>{audio_data}</FileContents> | <FileContents>{audio_data}</FileContents> | ||
</InstallVoice> | </InstallVoice> | ||
- | </ | + | </xml> |
All campaigns must have an associated audio file to play. This command will upload audio data in MP3 or WAV format, and establish a tag name to refer to that audio () in subsequent calls. | All campaigns must have an associated audio file to play. This command will upload audio data in MP3 or WAV format, and establish a tag name to refer to that audio () in subsequent calls. | ||
Line 92: | Line 96: | ||
<u>Successful installation:</u> | <u>Successful installation:</u> | ||
- | < | + | <xml> |
<InstallResponse> | <InstallResponse> | ||
<Customer>{customer_name}</Customer> | <Customer>{customer_name}</Customer> | ||
Line 98: | Line 102: | ||
<Result>Success</Result> | <Result>Success</Result> | ||
</InstallResponse> | </InstallResponse> | ||
- | </ | + | </xml> |
<u>Invalid user/password:</u> | <u>Invalid user/password:</u> | ||
- | < | + | <xml> |
<AuthResult> | <AuthResult> | ||
<UserID>{userID}</UserID> | <UserID>{userID}</UserID> | ||
<Failure>UserID and Password combination invalid</Failure> | <Failure>UserID and Password combination invalid</Failure> | ||
</AuthResult> | </AuthResult> | ||
- | </ | + | </xml> |
<u>Bad audio data:</u> | <u>Bad audio data:</u> | ||
- | < | + | <xml> |
<InstallResponse> | <InstallResponse> | ||
<Customer>{customer_name}</Customer> | <Customer>{customer_name}</Customer> | ||
Line 115: | Line 119: | ||
<Result>Failure</Result> | <Result>Failure</Result> | ||
</InstallResponse> | </InstallResponse> | ||
- | </ | + | </xml> |
Line 123: | Line 127: | ||
<b>Body:</b> | <b>Body:</b> | ||
- | < | + | <xml> |
<?xml version="1.0"?> | <?xml version="1.0"?> | ||
<SendTest version="1.0"> | <SendTest version="1.0"> | ||
Line 134: | Line 138: | ||
<SendTo>{test_number}</SendTo> | <SendTo>{test_number}</SendTo> | ||
</SendTest> | </SendTest> | ||
- | </ | + | </xml> |
Use this command to send a test call to one phone number. | Use this command to send a test call to one phone number. | ||
Line 147: | Line 151: | ||
<u>Success:</u> | <u>Success:</u> | ||
- | < | + | <xml> |
<TestSent> | <TestSent> | ||
<Customer>{customer_name}</Customer> | <Customer>{customer_name}</Customer> | ||
Line 155: | Line 159: | ||
<Result>Success</Result> | <Result>Success</Result> | ||
</TestSent> | </TestSent> | ||
- | </ | + | </xml> |
<u>Not Authorized:</u> | <u>Not Authorized:</u> | ||
- | < | + | <xml> |
<AuthResult> | <AuthResult> | ||
<UserID>{userID}</UserID> | <UserID>{userID}</UserID> | ||
<Failure>UserID and Password combination invalid</Failure> | <Failure>UserID and Password combination invalid</Failure> | ||
</AuthResult> | </AuthResult> | ||
- | </ | + | </xml> |
<u>Invalid recording:</u> | <u>Invalid recording:</u> | ||
- | < | + | <xml> |
<VoiceSent> | <VoiceSent> | ||
<Customer>{customer_name}</Customer> | <Customer>{customer_name}</Customer> | ||
Line 172: | Line 176: | ||
<Result>Failure</Result> | <Result>Failure</Result> | ||
</VoiceSent> | </VoiceSent> | ||
- | </ | + | </xml> |
<u>Invalid telephone number:</u> | <u>Invalid telephone number:</u> | ||
+ | <xml> | ||
<VoiceSent> | <VoiceSent> | ||
<Customer>{customer_name}</Customer> | <Customer>{customer_name}</Customer> | ||
Line 180: | Line 185: | ||
<Result>Failure</Result> | <Result>Failure</Result> | ||
</VoiceSent> | </VoiceSent> | ||
+ | </xml> | ||
Telephone number validation only applies to the <SendTo> tag. | Telephone number validation only applies to the <SendTo> tag. | ||
- | |||
===SendVoice=== | ===SendVoice=== | ||
Line 189: | Line 194: | ||
<b>Body:</b> | <b>Body:</b> | ||
- | < | + | <xml> |
<?xml version="1.0"?> | <?xml version="1.0"?> | ||
<SendVoice version="1.0"> | <SendVoice version="1.0"> | ||
Line 203: | Line 208: | ||
<SendTo seq="n">{phone_numberN}</SendTo> | <SendTo seq="n">{phone_numberN}</SendTo> | ||
</SendVoice> | </SendVoice> | ||
- | </ | + | </xml> |
This command sends a list of telephone numbers to be called. Issuing this command creates a TeleFlow Dialer campaign, associating all the phone numbers to a particular audio file tag, and starting the call-out process. | This command sends a list of telephone numbers to be called. Issuing this command creates a TeleFlow Dialer campaign, associating all the phone numbers to a particular audio file tag, and starting the call-out process. | ||
Line 218: | Line 223: | ||
<u>Success:</u> | <u>Success:</u> | ||
- | < | + | <xml> |
<VoiceSent> | <VoiceSent> | ||
<Customer>{customer_name}</Customer> | <Customer>{customer_name}</Customer> | ||
Line 226: | Line 231: | ||
<Result>Success</Result> | <Result>Success</Result> | ||
</VoiceSent> | </VoiceSent> | ||
- | </ | + | </xml> |
<u>Not Authorized:</u> | <u>Not Authorized:</u> | ||
- | < | + | <xml> |
<AuthResult> | <AuthResult> | ||
<UserID>{userID}</UserID> | <UserID>{userID}</UserID> | ||
<Failure>UserID and Password combination invalid</Failure> | <Failure>UserID and Password combination invalid</Failure> | ||
</AuthResult> | </AuthResult> | ||
- | </ | + | </xml> |
<u>Invalid recording:</u> | <u>Invalid recording:</u> | ||
- | < | + | <xml> |
<VoiceSent> | <VoiceSent> | ||
<Customer>{customer_name}</Customer> | <Customer>{customer_name}</Customer> | ||
Line 243: | Line 248: | ||
<Result>Failure</Result> | <Result>Failure</Result> | ||
</VoiceSent> | </VoiceSent> | ||
- | </ | + | </xml> |
<u>Invalid telephone number:</u> | <u>Invalid telephone number:</u> | ||
- | < | + | <xml> |
<VoiceSent> | <VoiceSent> | ||
<Customer>{customer_name}</Customer> | <Customer>{customer_name}</Customer> | ||
Line 252: | Line 257: | ||
<Result>Failure</Result> | <Result>Failure</Result> | ||
</VoiceSent> | </VoiceSent> | ||
- | </ | + | </xml> |
Telephone number validation only applies to <SendTo> tags. | Telephone number validation only applies to <SendTo> tags. | ||
Line 262: | Line 267: | ||
<b>Body:</b> | <b>Body:</b> | ||
- | < | + | <xml> |
<?xml version="1.0"?> | <?xml version="1.0"?> | ||
- | <GetVoice version ="1.0"> | + | <GetVoice version="1.0"> |
<UserID>{userID}</UserID> | <UserID>{userID}</UserID> | ||
<Password>{password}</Password> | <Password>{password}</Password> | ||
Line 270: | Line 275: | ||
<FileId>{message_number}</FileId> | <FileId>{message_number}</FileId> | ||
</GetVoice> | </GetVoice> | ||
- | </ | + | </xml> |
Use this command to retrieve audio data recorded via the TeleFlow Dialer Message Recorder. The Message Recorder service will give you a TeleFlow Dialer Message ID after you have saved your recording. Use this number in the <FileId> tag to refer to your recording. | Use this command to retrieve audio data recorded via the TeleFlow Dialer Message Recorder. The Message Recorder service will give you a TeleFlow Dialer Message ID after you have saved your recording. Use this number in the <FileId> tag to refer to your recording. | ||
Line 277: | Line 282: | ||
<u>Success:</u> | <u>Success:</u> | ||
- | < | + | <xml> |
<GetVoiceResponse> | <GetVoiceResponse> | ||
<Customer>{customer_name}</Customer> | <Customer>{customer_name}</Customer> | ||
Line 284: | Line 289: | ||
<Result>Success</Result> | <Result>Success</Result> | ||
</GetVoiceResponse> | </GetVoiceResponse> | ||
- | </ | + | </xml> |
Note that the actual audio data in the <FileContents> tag will be Base64 encoded data. | Note that the actual audio data in the <FileContents> tag will be Base64 encoded data. | ||
<u>Not Authorized:</u> | <u>Not Authorized:</u> | ||
- | < | + | <xml> |
<AuthResult> | <AuthResult> | ||
<UserID>{userID}</UserID> | <UserID>{userID}</UserID> | ||
<Failure>UserID and Password combination invalid</Failure> | <Failure>UserID and Password combination invalid</Failure> | ||
</AuthResult> | </AuthResult> | ||
- | </ | + | </xml> |
<u>Invalid File ID:</u> | <u>Invalid File ID:</u> | ||
- | < | + | <xml> |
<GetVoiceResponse> | <GetVoiceResponse> | ||
<Customer>{customer_name}</Customer> | <Customer>{customer_name}</Customer> | ||
Line 305: | Line 310: | ||
<Result>Failure</Result> | <Result>Failure</Result> | ||
</GetVoiceResponse> | </GetVoiceResponse> | ||
- | </ | + | </xml> |
Current revision
This document describes the XML interface to allow a web programmer/designer to populate and query a TeleFlow Dialer installation. All functions are achieved through HTTP Post of XML documents to a TeleFlow web server. Each type of document represents a command that can be issued to the application. The format for the commands follows in logical order.
This XML is also used for CampaignDialer
Contents |
Version
TeleFlow Dialer XML Revision 2.1
- Date: June 8, 2007
February 13 2008, 05:46 PM - Wednesday - Vb
- Updated to Wiki format
- Adjust SendList to SendVoice
Commands
The following commands are send via HTTP.
Hello
Body:
{none}
Use this command to “ping” the TeleFlow Dialer web server to ensure it can be reached and is functioning correctly. This command is not required to use TeleFlow Dialer. It is available as a troubleshooting tool. TeleFlow Dialer server will respond with a simple “Hello!” only.
Responses:
Success:
<Result>Success</Result>
Authenticate
Body:
<?xml version='1.0' encoding='utf-8'?> <AuthCheck> <UserID>{userID}</UserID> <Password>{password}</Password> <Customer>{customer_name}</Customer> </AuthCheck>
This command will check your login credentials against the TeleFlow Dialer server to determine if you are permitted to use the system. It does not affect future interactions with the TeleFlow Dialer. Every command must include user/client authentication.
Responses:
Authorized:
<AuthResult> <UserID>{userID}</UserID> <Success>This account is registered to {user_contact}</Success> <InboundTelNo>{inbound_tel}</InboundTelNo> <Result>Success</Result> </AuthResult>
Not Authorized:
<AuthResult> <UserID>{userID}</UserID> <Failure>UserID and Password combination invalid</Failure> <Result>Failure</Result> </AuthResult>
InstallVoice
Body:
<?xml version="1.0"?> <InstallVoice version="1.0"> <UserID>{userID}</UserID> <Password>{password}</Password> <Customer>{customer_name}</Customer> <FileTag replace="n">{audio_tag}</FileTag> <FileType>{audio_type}</FileType> <FileContents>{audio_data}</FileContents> </InstallVoice>
All campaigns must have an associated audio file to play. This command will upload audio data in MP3 or WAV format, and establish a tag name to refer to that audio () in subsequent calls.
In the above body example, the data, {audio_data}, in the <FileContents> tag must be Base64 encoded data.
Responses:
Successful installation:
<InstallResponse> <Customer>{customer_name}</Customer> <FileTag>{audio_tag}</FileTag> <Result>Success</Result> </InstallResponse>
Invalid user/password:
<AuthResult> <UserID>{userID}</UserID> <Failure>UserID and Password combination invalid</Failure> </AuthResult>
Bad audio data:
<InstallResponse> <Customer>{customer_name}</Customer> <Errors>1004: Encoded file type unknown</Errors> <Result>Failure</Result> </InstallResponse>
SendTest
Body:
<?xml version="1.0"?> <SendTest version="1.0"> <UserID>{userID}</UserID> <Password>{password}</Password> <Customer>{customer_name}</Customer> <SendCallerId>{callerID}</SendCallerId> <Transfer offer="{transfer_YN}" ext="{transfer_ext}">{transfer_number}</Transfer> <FileTag playtwice="{playtwice_YN}">{audio_tag}</FileTag> <SendTo>{test_number}</SendTo> </SendTest>
Use this command to send a test call to one phone number.
Once an audio file has been installed, it is advisable to make a test call to ensure the audio sounds acceptable, and that the transfer functionality works as expected, before you you’re your full campaign call list with SendVoice.
Important Notes:
- Telephone number validation does not apply to the telephone number to use for transfers to the operator. You must test this number to ensure it is valid and reaches the intended party. If this telephone number is remote from the calling area of the TeleFlow Dialer server, it must contain the preceding ‘1’.
Responses:
Success:
<TestSent> <Customer>{customer_name}</Customer> <FileTag>{audio_tag}</FileTag> <SentCount>1</SentCount> <FailCount>0</FailCount> <Result>Success</Result> </TestSent>
Not Authorized:
<AuthResult> <UserID>{userID}</UserID> <Failure>UserID and Password combination invalid</Failure> </AuthResult>
Invalid recording:
<VoiceSent> <Customer>{customer_name}</Customer> <Errors>2009: Recording not installed</Errors> <Result>Failure</Result> </VoiceSent>
Invalid telephone number:
<VoiceSent> <Customer>{customer_name}</Customer> <Errors>2011: No valid telephone numbers provided</Errors> <Result>Failure</Result> </VoiceSent>
Telephone number validation only applies to the <SendTo> tag.
SendVoice
Body:
<?xml version="1.0"?> <SendVoice version="1.0"> <UserID>{userID}</UserID> <Password>{password}</Password> <Customer>{customer_name}</Customer> <SendCallerId>{callerID}</SendCallerId> <Transfer offer="{transfer_YN}" ext="{transfer_ext}">{transfer_number}</Transfer> <FileTag playtwice="{playtwice_YN}">{audio_tag}</FileTag> <SendTo seq="0">{phone_number1}</SendTo> <SendTo seq="1">{phone_number2}</SendTo> . . . <SendTo seq="n">{phone_numberN}</SendTo> </SendVoice>
This command sends a list of telephone numbers to be called. Issuing this command creates a TeleFlow Dialer campaign, associating all the phone numbers to a particular audio file tag, and starting the call-out process.
The command SendVoice will also perform the same function, but is deprecated.
Important Notes:
- ALWAYS test with the SendTest command BEFORE you upload a list of numbers with SendVoice. It is your responsibility to ensure there are no problems with the audio or operator transfer functionality data you have provided. If there is a problem with the recording or the operator transfer, the problem will be heard by all callers in your list, and you will be billed for the calls made.
- Telephone number validation does not apply to the telephone number to use for transfers to the operator. You must test this number to ensure it is valid and reaches the intended party. If this telephone number is remote from the calling area of the TeleFlow Dialer server, it must contain the preceding ‘1’.
Responses:
Success:
<VoiceSent> <Customer>{customer_name}</Customer> <FileTag>{audio_tag}</FileTag> <SentCount>3</SentCount> <FailCount>0</FailCount> <Result>Success</Result> </VoiceSent>
Not Authorized:
<AuthResult> <UserID>{userID}</UserID> <Failure>UserID and Password combination invalid</Failure> </AuthResult>
Invalid recording:
<VoiceSent> <Customer>{customer_name}</Customer> <Errors>2009: Recording not installed</Errors> <Result>Failure</Result> </VoiceSent>
Invalid telephone number:
<VoiceSent> <Customer>{customer_name}</Customer> <Errors>2011: No valid telephone numbers provided</Errors> <Result>Failure</Result> </VoiceSent>
Telephone number validation only applies to <SendTo> tags.
GetVoice
Body:
<?xml version="1.0"?> <GetVoice version="1.0"> <UserID>{userID}</UserID> <Password>{password}</Password> <Customer>{customer_name}</Customer> <FileId>{message_number}</FileId> </GetVoice>
Use this command to retrieve audio data recorded via the TeleFlow Dialer Message Recorder. The Message Recorder service will give you a TeleFlow Dialer Message ID after you have saved your recording. Use this number in the <FileId> tag to refer to your recording.
Responses:
Success:
<GetVoiceResponse> <Customer>{customer_name}</Customer> <FileId>{message_number}</FileId> <FileContents>{audio_data}</FileContents> <Result>Success</Result> </GetVoiceResponse>
Note that the actual audio data in the <FileContents> tag will be Base64 encoded data.
Not Authorized:
<AuthResult> <UserID>{userID}</UserID> <Failure>UserID and Password combination invalid</Failure> </AuthResult>
Invalid File ID:
<GetVoiceResponse> <Customer>{customer_name}</Customer> <Errors Count="1"> <FileMissing>File Id {message_number} not located</FileMissing> </Errors> <Result>Failure</Result> </GetVoiceResponse>
![](http://www.socialmarker.com/bookmark.gif)