Interpage OutVoice Protocol and Commands
[Back to Main] |
[Site Map] |
[OutVoice Service] |
[Services Overview] |
[OutVoice Trial and Signup] |
[Contact Interpage]
The command list and examples below are used in conjuction with the OutVoice service.
I N T E R P A G E Network Services Inc. http://www.interpage.net ========================================================================== [] Voice Send and Configuration Commands for the OutVoice Service, 06/2020 This page describes the various commands and options which can be used to have Interpage's OutVoice(sm) service convert your e-mail messages into voice messages and sent to your telephone, cellphone, voicemail or other destination voice device. Note that the these commands override on a ONE TIME basis any customized settings your account may have in place. ---------------- [] Sending a message via the OutVoice service: Voice Commands (in common with OutFax(sm) and Paging/SMS Gateway Services): VOICE [options] phone recipient Options: -code [word] Mark message with code 'word' (any string w/o spaces) -conf Generate a QUEUED confirmation -noconf Do not generate a QUEUED confirmation (restricted) -confsucc a@b.com Send a success confirmation to a@b.com -conffail c@d.org Send a fail confirmation to c@d.org -queuesucc e@f.com Send a successful queue confirmation to e@f.com -queuefail g@h.net Send a failed queue confirmation g@h.net (Default confirmations may also be configured and filtered for any user account via a given Outvoice account's web-based portal or telnet to "interpage.net" and selecting option 6.) The following additional voice-specific options apply to Outvoice only: -ivr (and -noivr) : [default is -ivr] Play interactive voice response messages around your message to ensure successful receipt. Recipient is prompted to press "1" to accept, "2" to decline, or "3" to be called back. "*" aborts and returns success after acceptance. -noivr prevents the use of the IVR interface. -wait (and -nowait) : [default is -wait] Wait to hear a sound from the callee before proceeding through the message playing. Callers will typically say "Hello", which will prompt OutVoice to commence transmission of the given message. -nowait will prevent this initial wait. (Generally used with the -pause command to hard code a fixed dial/ring time.) -pause [seconds] : [default is 9 seconds] Time (in seconds) to pause before playing message. (Applicable only when using -nowait option). -voice [voice] : [options are 'female' (default) and 'male'] Use either a male or female voice during text-to-speech (TTS) synthesis. -maxplays [plays] : [default is 5 plays] Maximum number of times the system will play the message (in the event the recipient did not press "1" or the system was unable to connect; also limits the number of times the recipient may press "3" to replay the message). -wava : [defaults to ignore WAV attachments] Similar to -doca in the OutFax(sm) Service, denoting a WAV audio file attachment. No argument is taken with -wava ; -wava tells Outvoice to expect an attached WAV audio file in the body of the message. --------------------------------------------------------------------------- [] Format of the subject line: Subject: voice (Option 1) (Option 2) ... (Option n) PHONE-NUMBER (Recipient) ...where PHONE-NUMBER is any 10-digit US/Canada (NANP) destination, or 011+ International destination. [] Format of the body: The body of the message can say almost anything. Here is an example which illustrates the above, omit parentheses, eg the ( and ) : To: (Interpage-account-username)-vconfig@interpage.net Subject: voice -code TestVoice001 -ivr 3125551212 John Hello. My name is John and this is a test of the Interpage OutVoice service. Typing the above and entering in the code correctly will send that message to your telephone precisely as you typed it. This will result in an IVR-prompted call to (312) 555-1212 with the string "TestVoice001" being passed to the confirmation recipient(s) as well as appearing on the billing statement. The name John will also appear on e-mail confirmations and billing statements. (The code and string-after-number options are useful when monitoring usage and/or assigning account billing to various users.) To send a WAV file, you must MIME attach a valid WAV format file (using Outlook, for example) to an e-mail, one WAV per e-mail. In the Subject: line, use the command: Subject: voice -wava PHONE-NUMBER ...and make sure the WAV file is MIME attached. This will result in the WAV file being played the recipient at PHONE NUMBER. (Remember, the phone number MUST be 10 digits with no spaces, dashes, or other forms on punctuation.) ---------------------------------------------------------------------- Billing formats: 1. Regular (Col. Delimited) 2. Comma Delimited, with per-user/code summary at end ---------------------------------------------------------------------- Examples: #1. To: robert-vconfig@interpage.net Subject: voice 4165551212 Hi, this is my first test! ...will result is a Text-To-Speech (TTS) message consisting of the textual body of the message (eg, "Hi, this is my first test!") being sent with IVR prompting (waits for person to answer and press "1" to accept the TTS message) to (416) 555-1212. #2. To: mccall-vconfig@interpage.net Subject: voice -noivr 3125551212 Sally Hi, this is a test! ....will result in a Text-To-Speech (TTS) message consisting of the textual body of the message (eg, "Hi, this is a test!") being sent without IVR prompting to (312) 555-1212, and the name "Sally" will appear on billing summaries as well as e-mailed message confirmations. #3. To: lansing-vconfig@interpage.net Subject: voice -nowait -code 001 3125551212 ....will result in a message being sent that will play back immediately without requiring the person receiving the message to speak into the phone, thus activating the message playback to (312) 555-1212. E-mail confirmations and billing statements will also list "Code 001" for these calls which allow simple parsing by billing and accounting systems. #4. To: jason-vconfig@interpage.net Subject: voice -nowait -pause 5 3125551212 ....will result in a message being sent that will pause for five seconds before playing back the message to (312) 555-1212. #5. To: scott-vconfig@interpage.net Subject: voice -voice male 3125551212,4165551212,2135551212 ....will result in a message being played back using the male voice instead of the default female TTS voice, and the message will be sent to three destinations, namely (312) 555-1212, (416) 555-1212, and (213) 555-1212. #6. To: woodward-vconfig@interpage.net Subject: voice -wava -noivr 3055551212 Suzy ...will result in a properly attached MIME WAV file being played without the IVR when the caller says "Hello" (or answers with any discernable voice) to (305) 555-1212. The name "Suzy" will appear in confirmation e-mails and billing statements.