Document Intake: Fax Notify¶
Introduction¶
The fax notify intake endpoint accepts documents from fax systems that are capable of delivering to a REST API endpoint.
The endpoint accepts a series of named metadata values follows by a single file containing the incoming document.
Request Details¶
To submit a document to the platform via the fax notify endpoint, construct an HTTP POST request with the multipart form data content type, and the content sections described below:
| Name | Location | Sample Value & Description |
|---|---|---|
| faxMessageId | Content Section | bbe58db7-b3f3-461a-9c47-5b803586cc53 A source message identifier that is generated by the originating system. The Source message identifier will be created if one is not passed in. (Optional) |
| messageType | Content Section | Inbound Indicates the type of fax document being submitted. Must be one of: Inbound or Outbound |
| attachmentName | Content Section | bbe58db7-b3f3-461a-9c47-5b803586cc53.tif Logical file name for the document being submitted. (Optional) |
| faxSenderCSID | Content Section | Test User (123-555-1212) Fax CSID value for the sender (Optional) |
| callerNumber | Content Section | 1-123-555-1212 The fax number for the sender |
| calledNumber | Content Section | 1-123-555-6789 The fax number for the recipient |
| faxReceivedDateTime | Content Section | 10/07/2018 10:45:21 AM or 2018-10-07T10:45:21-06:00 The date/time when the fax was received by the source fax system. |
| faxRecipientTimeZone | Content Section | (GMT-06:00) Central Time (US & Canada) The timezone corresponding to the fax received date/time value, in Windows format (Optional, when fax date/time is in ISO8601 format) |
| faxPages | Content Section | 1 The number of pages contained in the fax file |
| faxResolution | Content Section | 1 A number indicating the resolution of the fax file (Optional, source system specific) |
| faxSpeed | Content Section | 2 A number indicating the transmission speed of the fax (Optional, source system specific) |
| attachmentCount | Content Section | 1 The number of attachment files processed by the fax system (Optional, source system specific) |
| account | Content Section | 12345 The NEXTSTEP user account number used for authentication This will be provided by Concord Customer Success team |
| authUser | Content Section | 12345-6789-1212-12345-0001 The API key for the provided NEXTSTEP user account This will be provided by Concord Customer Success team |
| file | Content Section | <binary file data> The bytes representing the raw file content for the fax file |
Example¶
An example HTTP POST request for the intake API (in raw text format) is provided below:
POST /api/intake/fax-notify HTTP/1.1
Host: https://nextstep.concord.net
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="FaxMessageId"
bbe58db7-b3f3-461a-9c47-5b803586cc53
Content-Disposition: form-data; name="MessageType"
Inbound
Content-Disposition: form-data; name="AttachmentName"
bbe58db7-b3f3-461a-9c47-5b803586cc53.tif
Content-Disposition: form-data; name="FaxSenderCSID"
Test User (123-555-1212)
Content-Disposition: form-data; name="CallerNumber"
1-123-555-1212
Content-Disposition: form-data; name="CalledNumber"
1-123-555-6789
Content-Disposition: form-data; name="FaxReceivedDateTime"
10/07/2018 10:45:21 AM
Content-Disposition: form-data; name="FaxRecipientTimeZone"
(GMT-06:00) Central Time (US & Canada)
Content-Disposition: form-data; name="FaxPages"
1
Content-Disposition: form-data; name="FaxResolution"
1
Content-Disposition: form-data; name="FaxSpeed"
2
Content-Disposition: form-data; name="AttachmentCount"
1
Content-Disposition: form-data; name="Account"
12345
Content-Disposition: form-data; name="AuthUser"
12345-6789-1212-12345-0001
Content-Disposition: form-data; name="File"; filename="bbe58db7-b3f3-461a-9c47-5b803586cc53.tif"
Content-Type: file
<binary file data>
------WebKitFormBoundary7MA4YWxkTrZu0gW--