Result URL
Insight allows users to configure their outbound calls to automatically send the status of each outbound call to a REST service upon completion. To do so, it is necessary to provide a result_url when queuing the outbound calls.
Insight provides three different ways to accomplish this: queuing through the Outbound UI, queuing a single outbound call through the Queue Call API , and queuing multiple outbound calls via the Bulk Queue API.
The result_url callback will be POSTed to when the outbound call completes, when all outbound attempts are exhausted, or when the outbound call is canceled. The body of this request will be identical to the call_details
element in the Outbound Call Status API method.
Request Parameters
The following parameters will be POSTed to your result_url:
Parameter | Type | Description |
status | string | Call outcome: 'completed', 'canceled', 'failed', 'rejected' |
attempts | int | Number of outbound attempts that were made |
max_attempts | int | Total number of call attempts to be made |
queued_timestamp | int | Timestamp of when the call was queued |
last_attempt_timestamp | int | Timestamp of the last time the call was attempted |
start_timestamp | int | Timestamp of when the calls were scheduled to begin. If not supplied when queuing, this will be an empty value |
end_timestamp | int | Timestamp of when the calls were scheduled to no longer make attempts. If not supplied when queuing, this will be an empty value |
reattempt_wait | int | Time (in seconds) to wait between call re-try attempts |
events | array | Array of call events, including the timestamp of the event |
Last updated