Dynamic Variables for DLRURL

The DLRURL is the callback URL using which one can receive the delivery reports. To receive the Delivery report, pass the URL with replaceable parameters/dynamic variables in the API.

The DLRURL has a set of dynamic variables used in the API to receive additional data.

Sample DLRURL with dynamic variables:

(https://webhook.site/55XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX0fe?var=id&var1=ivrid&var2=ringtime&var3=status&var4=credits)

Dynamic Variables

The Table lists dynamic variables compatible with DLRURL along with the description.

Dynamic Variable

Description

{status}

Specifies the status of the call.

{credits}

Specifies the credits utilized when the call is completed.

{id}

Specifies the unique identification of a call, also known as call id.

{flow_id}

Specifies the unique identification of a flow.

{ringtime}

Specifies the system ring-time where the service is trying to dial a number.

{billsec}

Specifies the billable call duration in seconds.

{keypress}

Specifies the last entered keypress value in the flow execution path.

{call_type}

Specifies whether the call is Incoming or outgoing.

{callee}

Specifies the number to which the call is received, also known as call recipient.

{caller}

Specifies the number from which the call is originated, also known as call originator.

{bridge}

Specifies the DID number used for making the call and triggering the flow.

{keypress:WIDGETID}

Specifies the entered keypress value of the given widget id in the flow execution path.

Note: The WIDGETID needs to be replaced by the actual value.

{api:VARIABLE}

Specifies the variable value from the last API response.

Note: The VARIABLE needs to be replaced by the actual value.

{api:VARIABLE.CHILD}

Specifies the variable value from the last API response, specially to access the child element.

Note: The VARIABLE, and CHILD needs to be replaced by the actual values.

{api:WIDGETID:VARIABLE}

Specifies the variable value from the last API response of the given widget id.

Note: The WIDGETID*, and VARIABLE** needs to be replaced by the actual values.

{api:WIDGETID:VARIABLE.CHILD}

Specifies the variable value from the last API response of the given widget id, especially to access the child element.

Note: The WIDGETID, CHILD, and VARIABLE needs to be replaced by the actual values.

{bridge}

Specifies the DID number used for making the call and triggering the flow.

{starttime}

Specifies the call start time in EPOCH format.

{flow_start_time}

Specifies the flow start time in EPOCH format.

{trigger}

Specifies whether the flow trigger type is Voice call or Webhook.

{endtime}

Specifies the call end time in EPOCH format.

{caller.isdcode},{bridge.isdcode},{callee.isdcode}

Specifies the ISD code of a caller, bridge, and callee numbers.

{caller.isocode},{bridge.isocode},{callee.isocode}

Specifies the ISO code of a caller, bridge, and callee numbers.

{caller.country},{bridge.country},{callee.country}

Specifies the Country code of a caller, bridge, and callee numbers.

{duration}

Specifies the call duration in seconds [end_time - start_time], available only on call completion.


Did this page help you?