Get received Fax file

Home » DOCOON APIs » REST API » Basic functionnalities » Get received Fax file

If you have fax numbers configured on the Docoon platform, please follow the workflow “Manage Received Fax”.

This workflow allow you to manage your received faxes in 3 steps, first get received Faxes list, get received Fax file and delete receied Fax file from our system. This basic functionnality illustrate the second step.

To download a specific received Fax file you must have the folder name and the the received Fax file name, you cand find these informations in the response illustrate in the first step.

Request Informations

Name: /InboundFolders/{folderName}/HostedInboundFiles/{FileName.pdf}
Type: GET

Headers:

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

 

Parameters list:

Parameter Type Description
folderName int Folder name, usually the inbound phone number is used as a name (Find the folderName)
fileName int Name of the file + extension (Find the fileName)
Get received Fax file
GET /api/V1/InboundFolders/13429XXXX/HostedInboundFiles/0-20170711-0714-1126279.PDF HTTP/1.1
Host: api.odyssey-services.fr
Content-Type: application/json
Authorization: Basic NjAzMDAuYX

 

Successful Response

Parameter Type Description
Content
 String File content encoded in Base64.
Name
 String File name with extension.
CreationDateTime
 DateTime File creation date.
LastModificationDateTime
 DateTime Date of the last modification of the file.
Size int Size in byte of the file.
Successful Response
{
    "Content": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago  .../... VFMzU0NTY4NjhBPiBdCj4+CnN0YXJ0eHJlZgo0Mzc2CiUlRU9GCg==",
    "Name": "0-20170711-0714-1126279.PDF",
    "CreationDateTime": "2017-07-11T07:14:39.1651178+02:00",
    "LastModificationDateTime": "2017-07-11T07:14:39.1560543+02:00",
    "Size": 4690
}