Get transmission report file

Home » DOCOON APIs » REST API » Basic functionnalities » Get transmission report file

After sending messages, you might want to save in your system the transmission result of each recipient.

We created a workflow “Get transmission reports (Pull way)” that allows you to simply get those transmission results in 3 steps, get the transmission reports listget transmission report file and delete transmission report file. This basic functionnality illustrate the second step.

This Webservice return only one transmission report generated at the end of the job as long as it is not deleted.

Request Informations

Name: /HostedReportFiles/{jobid}
Type: GET


Name Value
Authorization Value : Authorization token check : Connect to REST API
Content-Type Value : application/json


Parameters list:

Parameter Type Description
jobId String Either name of the file (jobId.xls), the job id or the document name.
HTTP Sample
GET /api/V1/HostedReportFiles/27472157 HTTP/1.1
Host: {URL}
Content-Type: application/json
Authorization: Basic EncodedLogin

Successful Response

Status : 200

Response is a list of File object.

File object

Parameter Type Description
Name String File name and extension (JobId.xls).
CreationDateTime String First creation time of the report.

Example : 2016-12-06T07:20:38.7870548+01:00.

LastModificationDateTime String

Last modification time of the report.

Example : 2016-12-06T07:20:37.583+01:00.

Content String File encoded in base64.
Size Integer Size in byte of the report.
Successful Response
  "Content": "0M8R4KGxGuEAAA...../.....",
  "Name": "27472157.xls",
  "CreationDateTime": "2016-12-06T07:20:38.7870548+01:00",
  "LastModificationDateTime": "2016-12-06T07:20:37.583+01:00",
  "Size": 56832