Variables for HTTPPOST

Top  Previous  Next

These variables control how PageGate implements POST and GET HTTP methods.

It is recommended to set these on a Carrier level.

NOTE: When referencing any non-printable character, such as a line feed, carriage return, horizontal tab or similar, you must use the ASCII code for that character and it must be prefixed by a backslash (\).

 

Variable

Possible Values

Example Statement

Description

ResponseRecipient

Recipient

 

Group

ResponseRecipient = A recipient or group's name as it exists in the PG Admin

When the HTTP GET or POST transaction completes, the specified recipient or group will receive any responses from the receiving API/web host. For more information, please see the Two Way Messaging section of the documentation.

InterMessageDelay

Milliseconds

InterMessageDelay = 1000

This variable forces PageGate to delay for the specified number of milliseconds (1000 = 1 second) after delivering each message.

From

Text

From = CAD

This variable overrides the value passed to PageGate by the input modules/APIs. By specifying this variable, you're telling PageGate to use a single, standardized sender's name for all traffic controlled by this template.

To

Text

To = 7818290500

This variable overrides the ID/PIN or Email values. By specifying this variable, you're telling PageGate to send all traffic processed by this template to the specified ID or Email address instead.

HttpPostType

HeadBody
or
UrlHeadBody

HttpPostType = HeadBody

 

HttpPostType = UrlHeadBody

HttpPostType = HeadBody configures an HTTP POST carrier to provide header information followed by structured data, usually JSON or XML, in the body.

 

HttpPostType = UrlHeadBody configures an HTTP POST carrier to pass parameters in the URL, more like the GET method. This is not a typical use of HTTP POST but is used/required by some APIs.

HttpSuccessResponse

Text

See Description

This variable tells PageGate to scan any responses back from a GET or POST request for the required keywords or keyphrases. If those keywords or keyphrases are found, the message is treated as successfully delivered.

 

This variable is both case and punctuation sensitive and PageGate will look for an exact match to what you enter.

 

Multiple search terms may be used and you'll need to separate each item with a pipe.

 

For example, this would only scan for the word success:

HttpSuccessResponse = success

 

This would scan for the word success in the <Reply> tag:

HttpSuccessResponse = <Reply>success</Reply>

 

This would scan for the word success in the <Reply> tag OR the word hijinks:

HttpSuccessResponse = <Reply>success</Reply>|hijinks

 

This would scan for the word success OR the word hijinks OR the word actualization:

HttpSuccessResponse = success|hijinks|actualization

 

If this variable is included, any response to a GET/POST request that doesn't include the search term(s) will be treated as a failure.

HttpErrorResponse

Text

See Description

This variable tells PageGate to scan any responses back from a GET or POST request for the specified keywords or keyphrases. If those keywords or keyphrases are found, the message is treated as failed or rejected.

 

This variable is both case and punctuation sensitive and PageGate will look for an exact match to what you enter.

 

Multiple search terms may be used and you'll need to separate each item with a pipe.

 

For example, this would only scan for the word failed:

HttpErrorResponse = failed

 

This would scan for the word success in the <Reply> tag:

HttpErrorResponse = <Reply>failed</Reply>

 

This would scan for the word failed in the <Reply> tag OR the word reject:

HttpErrorResponse = <Reply>failed</Reply>|reject

 

This would scan for the word failed OR the word reject OR the phrase object not found:

HttpErrorResponse = failed|reject|object not found

 

If this variable is included, any response to a GET/POST request that includes the search term(s) will be treated as a failure.