TeleFlow Step 0390

From TeleFlow

HTTP Step
This step opens a TCP/IP connection to an HTTP server, issues an HTTP 1.0 command, receives the response from the HTTP server, and then closes the TCP/IP connection, during all of which an audio file may optionally be played. This step supports 7 different HTTP commands: GET, POST, PUT, DELETE, OPTIONS, HEAD, and TRACE.

HTTPS: HTTPS connections are assumed when the URL contains "https".

Properties

URL: The URL of HTTP command. The http:// prefix is not required but may be used. The host name or IP address may include a port specifier, otherwise the default HTTP port, 80, is used.

HTTP Request Type: Sets the HTTP request type to use. The default is GET, to load an HTTP document. Understanding what the various types of HTTP requests are for requires a solid understanding of HTTP.

HTTP Request Message Body: Body text (to send) for HTTP commands that require additional information not expressed in the URL.

Variable to load HTTP Response Header into: TeleFlow variable to load with the header of the HTTP command response, or any socket error messages.

Variable to load HTTP Response Body into: TeleFlow variable to load with the body of the HTTP command response. In the case of an HTTP GET, this would be the document retrieved from the HTTP server. (Simply put: This could be the html contents of a web page)

HTTP Initial Connection TIMEOUT: When connecting to an HTTP server, this is longest time to wait, in ms, before giving up/timing out on the connection attempt. This field defaults to 500 ms. A FATAL error is generated if this field evaluates to less than 1 ms.

HTTP Initial Connection Retries: This is the number of times a connection will be retried before following the TIMEOUT path. If this field is left blank, then a default of 2 retries is used.

Silence Timeout (ms): An overall timeout for the step. This is the maximum time to wait, in ms, before following the TIMEOUT path. This is called a "Silence Timeout", because while the step is retrieving a result, the caller is likely not hearing any audio.

Play Voice Script (optional): Optional audio to play while a caller is waiting for the HTTP command response. This feature is not available on the Dialogic platform.

Action Steps

Fail: The fail path is followed when the URL HTTP server cannot be resolved or there is a socket error. Any response that has been received so far will be loaded into the HTTP Response Body variable.

Time Out: The TIMEOUT path is followed when the HTTP server does not connect within the connection retries and timeout specified, or the HTTP server does not send the complete HTTP command response within the silence timeout specified. Any response that has been received so far will be loaded into the HTTP Response Body variable.

Related Steps

Load Text
Send E-Mail
TCP Connect