GetMessageInfoResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| id_ | int | ❌ | Internal identifier of a message |
| uri | str | ❌ | Canonical URI of a message |
| extension_id | str | ❌ | Internal identifier of an extension |
| attachments | List[MessageAttachmentInfo] | ❌ | List of message attachments |
| 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 |
| conversation_id | int | ❌ | SMS and Pager only. Identifier of a conversation the message belongs to |
| conversation | ConversationInfo | ❌ | SMS and Pager only. Information about a conversation the message belongs to |
| creation_time | str | ❌ | Message creation date/time in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z |
| delivery_error_code | str | ❌ | SMS only. Delivery error code returned by gateway |
| direction | MessageDirectionEnum | ❌ | Text message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound |
| fax_page_count | int | ❌ | Fax only. Page count in a fax message |
| 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 |
| from_ | MessageStoreCallerInfoResponseFrom | ❌ | Sender information |
| last_modified_time | str | ❌ | The date/time when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z |
| 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 |
| pg_to_department | bool | ❌ | Pager only. true if at least one of the message recipients is 'Department' extension |
| priority | MessagePriorityEnum | ❌ | Message priority |
| read_status | MessageReadStatusEnum | ❌ | Message read status |
| sms_delivery_time | str | ❌ | SMS only. Date/time when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if a carrier sends a delivery receipt to RingCentral |
| sms_sending_attempts_count | int | ❌ | SMS only. Number of attempts made to send an outbound SMS to the Gateway (if Gateway is temporary unavailable) |
| subject | str | ❌ | Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment |
| to | List[MessageStoreCallerInfoResponseTo] | ❌ | Recipient information |
| type_ | GetMessageInfoResponseType | ❌ | Message type |
| vm_transcription_status | VmTranscriptionStatus | ❌ | Voicemail only. Status of a voicemail to text transcription. If 'VoicemailToText' feature is not activated for account, the 'NotAvailable' value is returned |
| cover_index | int | ❌ | Cover page identifier. If coverIndex is set to '0' (zero) cover page is not attached. For the 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 the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols |
GetMessageInfoResponseType
Message type
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| FAX | str | ✅ | "Fax" |
| SMS | str | ✅ | "SMS" |
| VOICEMAIL | str | ✅ | "VoiceMail" |
| PAGER | str | ✅ | "Pager" |
| TEXT | str | ✅ | "Text" |
VmTranscriptionStatus
Voicemail only. Status of a voicemail to text transcription. If 'VoicemailToText' feature is not activated for account, the 'NotAvailable' value is returned
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| NOTAVAILABLE | str | ✅ | "NotAvailable" |
| INPROGRESS | str | ✅ | "InProgress" |
| TIMEDOUT | str | ✅ | "TimedOut" |
| COMPLETED | str | ✅ | "Completed" |
| COMPLETEDPARTIALLY | str | ✅ | "CompletedPartially" |
| FAILED | str | ✅ | "Failed" |
| UNKNOWN | str | ✅ | "Unknown" |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs