FaxResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| id_ | int | ❌ | Internal identifier of a message |
| uri | str | ❌ | Canonical URI of a message |
| type_ | FaxResponseType | ❌ | Message type - 'Fax' |
| from_ | MessageStoreCallerInfoResponseFrom | ❌ | Sender information |
| to | List[FaxResponseTo] | ❌ | Recipient information |
| creation_time | str | ❌ | Message creation date/time in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z |
| read_status | MessageReadStatusEnum | ❌ | Message read status |
| priority | MessagePriorityEnum | ❌ | Message priority |
| attachments | List[MessageAttachmentInfoIntId] | ❌ | List of message attachments |
| direction | MessageDirectionEnum | ❌ | Text message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound |
| availability | MessageAvailabilityEnum | ❌ | Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly |
| message_status | MessageStatusEnum | ❌ | Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned. If, for outbound message, a status for at least one recipient is 'Queued', then the 'Queued' value is returned. If a status for at least one recipient is 'SendingFailed', then the 'SendingFailed' value is returned. In other cases the 'Sent' status is returned |
| fax_resolution | FaxResolutionEnum | ❌ | Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi |
| fax_page_count | int | ❌ | Page count in a fax message |
| last_modified_time | str | ❌ | Date/time when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z |
| cover_index | int | ❌ | Cover page identifier. If coverIndex is set to '0' (zero), a cover page is not attached. For a list of available cover page identifiers (1-13) please call the Fax Cover Pages method. If not specified, the default cover page is attached (which is configured in 'Outbound Fax Settings') |
| cover_page_text | str | ❌ | Cover page text, entered by a fax sender and printed on a cover page. Maximum length is limited to 1024 symbols |
FaxResponseType
Message type - 'Fax'
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| FAX | str | ✅ | "Fax" |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs