GetRequestStatus.wr

This method returns the status of an asynchronous process request like phone list uploads and detail reports. A status of "COMPLETED" means the process finished successfully. Here is a list of details provided in the response:

  • apirid: String The API request id provided by you when making this API call.
  • base_url: String The base url or prefix of where the generated files are located.
  • datastatus: String A text field that is helpful when tracking down errors in with your asynchronus request.
  • errors: String A text field that is helpful when tracking down errors in with your asynchronus request.
  • extensions: Array A list of file extensions that were generated for your report.
  • files: Array A list of relative urls containing the download path of each file available.
  • nameofset: String The unique of identifying name of your report, if it is not a report for a poll.
  • pollid: number The poll ID of your report, if it is a report for a poll.
  • requestid: String The unique identifier provided to you to track your report request.
  • status: String The current status of your report. Report generation is done when status is "COMPLETED" or contains the word "ERROR".

Parameters

  • String : requestid - The request id provided by a previous request.

Usage

Example Request

Fetch all the details of an outbound poll campaign.

GET /getRequestStatus.wr?sidtoken=000000000000000000000000000&requestid=V152596_APPEND_108399 HTTP/1.1
Host: api.voicebroadcasting.com
Content-Type: application/x-www-form-urlencoded

Example Response

{"apirid":"","datastatus":"NEWJOB","errors":"","extensions":["csv"],
"files":["/reports/V152596_1603391980000_C3E5C701A70.csv"],"pollid":8434,
"requestid":"V152596_APPEND_108399","status":"COMPLETED"}