Queuing Multiple Outbound Calls

Queuing Multiple Outbound Calls

POST https://insight.plumvoice.com/api/surveys/{survey_id}/{instance_id}/bulk_queue

Bulk queue outbound calls for an Insight survey.

Path Parameters

Headers

Request Body

{'success':true}

Possible Response Codes

  • 200: success

  • 400: supplied data improperly formatted or invalid, uploaded CSV was invalid or not supplied

  • 401: authentication headers were invalid or the account is inactive

  • 403: the account attempting to queue the outbound call for the survey does not have appropriate permissions

  • 404: deployment, user or survey was not found

  • 405: invalid HTTP method supplied (only POST allowed)

  • 409: survey has been marked as deleted, survey deployment has expired, no TTS engine or metadatbase set for the survey, instance_id supplied did not match the current deployment, the number of survey responses has exceeded the max responses set in the survey's deployment settings

  • 415: unsupported media type (Content-Type value in request)

  • 500: database error

The return structure will contain the following item(s):

Sample Code

This sample PHP code makes a request to queue multiple outbound calls:

<?php
$ch = curl_init();
$url = 'https://insight.plumvoice.com/api/surveys/{survey_id}/{instance_id}/bulk_queue';
$params = array(
	'csv'=>'@/path/to/csv/on/your/pc.csv',
	'start_timestamp'=>strtotime('+1 minutes'),
	'end_timestamp'=>strtotime('+1 hour'),
	'attempts'=>1
	);
$username = 'you@yourdomain.com';
$password = 'your_developer_key';
curl_setopt($ch, CURLOPT_USERPWD, $username.":".$password);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Accept: application/json", "Content-type: multipart/form-data"));
$result = curl_exec($ch);
$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($result);
var_dump($http_code);

Last updated