MakeCallDetails.wr

This method starts the generation of a downloadable report and returns a url of where the report can be downloaded from when it is complete. The request ID returned can be used with GetRequestStatus.wr to get the current status of a MakeCallDetails request. Also do not rely on the filename provided in the response as it is depreciated. Use GetRequestStatus.wr to get the final filename and url.

Parameters

  • String : archivetype - none, zip, or tgz.
  • Number : callsetid - The ID of the calloutset the details are for. Can be supplimented with poll ID.
  • Number : pollid - The ID of the poll the details are for. Can be supplimented with poll ID.
  • String : completedfield - (only used when filter=completed) Valid value is the question number eg: "q2".
  • String : enddate - (optional) Date format MM-DD-YYYY.
  • Boolean : filenameonly - (optional) Set to true if you only want the name of the file and not the entire url.
  • Boolean : filter - For polls
  • all: give back all poll detail records.
  • respondants: ONLY give back the records that answered at least one of the questions.
  • completed: ONLY give back the records that answered the specific question defined in completedfield.
  • goalcompleted: ONLY give back the number of completed calls per cluster goal.
  • String : format - csv, html, sav, or sdf.
  • String : ivrpluslive - (only used to combine a live poll with its matching IVR poll.) Valid value is yes eg: "yes".
  • String : phone_number_type - all or mobile.
  • String : startdate - (optional) Date format MM-DD-YYYY.

Usage

Example Request

Fetch all the details of an outbound poll campaign.

POST /makeCallDetails.wr HTTP/1.1
Host: api.voicebroadcasting.com
Content-Type: application/x-www-form-urlencoded

&apirid=12345&sidtoken=000000000000000000000000000&callsetid=55881&filter=all&filenameonly=false&archivetype=none

Example Response

{"apirid":"12345","filename":"V55881_14241157897267851300.csv","requestid":"V55881_CALLDETAILS_73244","response":"confirmed"}