LogoLogo
  • Go to Docs Center
  • Welcome to Plum Insight
  • How to...
    • Use Plum's Transcription
  • Account Manager
    • Managing Phone Numbers
    • Managing User Settings
    • Managing Users
    • Managing Metadata
  • Creating A Survey
    • Survey Basics
    • Using Pages
    • Question Types
      • Multiple Choice
      • Multiselect
      • Scale
      • Yes/No
      • Comment
      • Date
      • Time
      • Currency
      • Number
      • Digits
      • Name
      • Address
      • Transfer
      • SOAP
      • Prompt
      • Subdialog
      • Metadata Filter
      • Metadata Store
      • Multilingual
  • Prompt Manager
    • Bulk Uploading for Audio Prompts
  • Survey Settings
    • Phone
    • Web
    • Mobile
  • Metadata Manager
    • Layout
    • Creating a Metadatabase
    • Viewing/Editing a Metadatabase
    • Managing a Metadatabase
    • Formatting Metadatabase CSV
  • Survey Manager
    • Locking Surveys
    • Sharing Surveys
    • Cloning Surveys
    • Clearing Survey Data
    • Deleting Surveys
    • Importing Surveys and Data
  • Deployment
    • Deployment Management
    • Outbound Queue
    • Queueing Calls
  • Reporting
    • Viewing a Report
    • Available Charts
    • Edit Filters
    • Survey Visits
    • Printer Friendly View
    • Single vs Multi-Survey Reports
    • Merging Questions
    • Translating Unix timestamps
  • API
    • Checking Total Responses for a Survey
    • Queuing an Outbound Call
    • Queuing Multiple Outbound Calls
    • Checking Status for an Outbound Call
    • Cancelling All Pending Outbound Calls
    • Adding Metadatabase Records
    • Survey Response Reporting
  • Data Integration
    • Automatic Web Services
    • Plum Insight Webservice Question Type
    • SOAP Integration
    • REST Integration
    • Subdialog Integration
    • Result URL
    • Associating Metadata with a Caller
Powered by GitBook
On this page
  1. Data Integration

Result URL

PreviousSubdialog IntegrationNextAssociating Metadata with a Caller

Last updated 5 years ago

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 , queuing a single outbound call through the , and queuing multiple outbound calls via the .

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 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

Outbound UI
Queue Call API
Bulk Queue API
Outbound Call Status API