Run a PHLO
Run a PHLO by triggering it via an API request to the PHLO URL. PHLO URLs are listed on the PHLO page of the console.
API Endpoint
Arguments
URL Params
Param | Type | Description/Allowed Values |
---|---|---|
auth_id (Required) | string | You can find your Plivo Auth ID on the overview page of the console. |
phlo_id (Required) | string | Unique identifier for the PHLO. You can find a PHLO ID on the PHLO page of the console. |
Payload
If a dynamic payload is not defined in the Start
node of the PHLO (as shown in the screenshot) then no arguments need to be passed. In this example, the payload will be defined in the Send SMS node.
Payload_undefined
If a dynamic payload is defined in the Start
node of the PHLO (as shown in the next screenshot) then values for keys defined in the Start
node of PHLO will be passed. In this example, the values are
Param | Description |
from | Value of the |
to | Value of the |
Payload_defined
Payload defined in the Start node will be accessed in the Send SMS node using liquid tags like the one shown in the image below.
Payload_defined
Returns
Returns an api_id
to uniquely identify the PHLO run, referred to as phlo_run_id
. The message
attribute in the response provides more information about the PHLO run.
Message
will differ depending on the node defined for the PHLO trigger