Ask is essentially a say that requires input; it requests information from the caller and waits for a response.
Initiates an outbound call or a text conversation. Note that this verb is only valid when there is no active WebAPI call and the maximum session time with Tropo is 2 hours, so the maximum time a call can be connected is also 2 hours.
For voice calls, destinations are specified using a URL format. Supported formats include:
tel: Phone Number - must be proceeded by a + and the country code (ie - +14155551212 for a US #)
sip: SIP protocol address
When this method is called:
A new call is initiated to the destination specified by the "to" parmeter.
If "from" is specified then it will be used as the callerId when making the call. Otherwise, the callerId will be "unknown".
If answerOnMedia is true, the audio from the new call is connected immediately.
The system waits for an answer or other event from the new call up to the specified timeout.
If the call successfully completes within the timeout the call action is considered complete and Tropo will continue to the next action.
If the call fails due to the timeout or network issue the call action is considered incomplete and the state of the call will be FAILED.
Additional dial options:
postd - The DTMF digits to dial after the call has connected
pause - The amount of time to wait before issuing the digits after the call is connected; this exists to allow for large values of time to be defined
p - Defines a one second pause
Example: "+14155551212;postd=1234pp56;pause=5s". This will dial 1234 five seconds after connecting to the phone number, pause for an additional 2 seconds (pp) and then dial 56. This example will do the same thing, though looks a little more complex: "+14155551212;postd=ppppp1234pp56" 'ms' is also supported, so you could define 5000ms instead of 5s.
For SMS and IM conversations, the "to" represents the SMS enabled phone number or IM username. Make sure you supply the appropriate network so Tropo knows how to route this message. While you can define multiple SMS destinations as an array, it won't break the application, only the first destination phone number will actually receive the text message. In order to send an SMS message, you must have a U.S. or Canadian phone number attached to the application.
Note that before you can send to non-U.S. destinations, both for voice and SMS, you need to contact support first to get international dialing enabled. This can be done via an account ticket or via support@voxeo.com.
This object allows multiple lines in separate sessions to be conferenced together so that the parties on each line can talk to each other simultaneously.
This function instructs Tropo to "hang-up" or disconnect the session associated with the current session.
Creates a call, says something and then hangs up, all in one step.
This determines the events to be handled. Possible events are: "continue", "error", "incomplete" and "hangup", except when used with a transfer, in which case the possible event is 'ring', or when used with a signal, in which case the event can be the name of an assigned signal.
Plays a prompt (audio file or text to speech) then optionally waits for a response from the caller and records it.
This is used to deflect the call to a third party SIP address.
Rejects the incoming call.
Returned anytime a request is made to the Tropo Web API.
Says something to the user. Unlike "ask", this function has no ability to wait for a response from the user.
Session is the payload sent as an HTTP POST to your web application when a new session arrives.
Allows Tropo applications to begin recording the current session. The resulting recording may then be sent via FTP or an HTTP POST/Multipart Form.
This stops the recording of the current call after startCallRecording has been called.
This will transfer an already answered call to another destination / phone number. The call can be transferred to either a phone number or SIP address, which is set by the "to" parameter. This verb only applies to voice calls.
Additional dial options are:
postd - The DTMF digits to dial after the call has connected
pause - The amount of time to wait before issuing the digits after the call is connected; this exists to allow for large values of time to be defined
p - Defines a one second pause
Example: "+14155551212;postd=1234pp56;pause=5s". This will dial 1234 five seconds after connecting to the phone number, pause for an additional 2 seconds (pp) and then dial 56. This example will do the same thing, though looks a little more complex: "+14155551212;postd=ppppp1234pp56" 'ms' is also supported, so you could define 5000ms instead of 5s.
Ask is essentially a say that requires input; it requests information from the caller and waits for a response.
Initiates an outbound call or a text conversation. Note that this verb is only valid when there is no active WebAPI call and the maximum session time with Tropo is 2 hours, so the maximum time a call can be connected is also 2 hours.
For voice calls, destinations are specified using a URL format. Supported formats include:
tel: Phone Number - must be proceeded by a + and the country code (ie - +14155551212 for a US #)
sip: SIP protocol address
When this method is called:
A new call is initiated to the destination specified by the "to" parmeter.
If "from" is specified then it will be used as the callerId when making the call. Otherwise, the callerId will be "unknown".
If answerOnMedia is true, the audio from the new call is connected immediately.
The system waits for an answer or other event from the new call up to the specified timeout.
If the call successfully completes within the timeout the call action is considered complete and Tropo will continue to the next action.
If the call fails due to the timeout or network issue the call action is considered incomplete and the state of the call will be FAILED.
Additional dial options:
postd - The DTMF digits to dial after the call has connected
pause - The amount of time to wait before issuing the digits after the call is connected; this exists to allow for large values of time to be defined
p - Defines a one second pause
Example: "+14155551212;postd=1234pp56;pause=5s". This will dial 1234 five seconds after connecting to the phone number, pause for an additional 2 seconds (pp) and then dial 56. This example will do the same thing, though looks a little more complex: "+14155551212;postd=ppppp1234pp56" 'ms' is also supported, so you could define 5000ms instead of 5s.
For SMS and IM conversations, the "to" represents the SMS enabled phone number or IM username. Make sure you supply the appropriate network so Tropo knows how to route this message. While you can define multiple SMS destinations as an array, it won't break the application, only the first destination phone number will actually receive the text message. In order to send an SMS message, you must have a U.S. or Canadian phone number attached to the application.
Note that before you can send to non-U.S. destinations, both for voice and SMS, you need to contact support first to get international dialing enabled. This can be done via an account ticket or via support@voxeo.com.
This object allows multiple lines in separate sessions to be conferenced together so that the parties on each line can talk to each other simultaneously.
This function instructs Tropo to "hang-up" or disconnect the session associated with the current session.
Creates a call, says something and then hangs up, all in one step.
This determines the events to be handled. Possible events are: "continue", "error", "incomplete" and "hangup", except when used with a transfer, in which case the possible event is 'ring', or when used with a signal, in which case the event can be the name of an assigned signal.
Plays a prompt (audio file or text to speech) then optionally waits for a response from the caller and records it.
This is used to deflect the call to a third party SIP address.
Rejects the incoming call.
Returned anytime a request is made to the Tropo Web API.
Says something to the user. Unlike "ask", this function has no ability to wait for a response from the user.
Session is the payload sent as an HTTP POST to your web application when a new session arrives.
Allows Tropo applications to begin recording the current session. The resulting recording may then be sent via FTP or an HTTP POST/Multipart Form.
This stops the recording of the current call after startCallRecording has been called.
This will transfer an already answered call to another destination / phone number. The call can be transferred to either a phone number or SIP address, which is set by the "to" parameter. This verb only applies to voice calls.
Additional dial options are:
postd - The DTMF digits to dial after the call has connected
pause - The amount of time to wait before issuing the digits after the call is connected; this exists to allow for large values of time to be defined
p - Defines a one second pause
Example: "+14155551212;postd=1234pp56;pause=5s". This will dial 1234 five seconds after connecting to the phone number, pause for an additional 2 seconds (pp) and then dial 56. This example will do the same thing, though looks a little more complex: "+14155551212;postd=ppppp1234pp56" 'ms' is also supported, so you could define 5000ms instead of 5s.
Development Guides
