Skip to content

RcMessage

RingCentral SMS, MMS, fax, voicemail, pager, or text record accepted for CRM logging.

Properties

Property Type Required Description
id one of: string, integer · int64 Yes RingCentral message identifier used for de-duplication.
uri string · uri No RingCentral message-store resource URI.
extensionId string No RingCentral extension that owns the message.
attachments array of MessageAttachment No RingCentral message attachment metadata.
availability string No Current RingCentral message availability. Allowed values: Alive, Deleted, Purged.
conversationId one of: string, integer · int64 No RingCentral conversation identifier.
conversation object of any No Additional RingCentral conversation metadata.
creationTime string · date-time No Message creation time.
lastModifiedTime string · date-time No Message last-modified time.
direction string No Inbound or outbound message direction. Allowed values: Inbound, Outbound.
from MessageParty No
to array of MessageParty No RingCentral message recipients.
messageStatus string No Overall RingCentral message status.
priority string No RingCentral message priority. Allowed values: Normal, High.
readStatus string No RingCentral read state. Allowed values: Read, Unread.
smsDeliveryTime string · date-time No SMS delivery timestamp when available.
smsSendingAttemptsCount integer · int32 No Number of SMS delivery attempts.
subject string No Message text or subject.
type string Yes RingCentral message type. Allowed values: Fax, SMS, MMS, VoiceMail, Pager, Text.
faxPageCount integer · int32 No Number of fax pages.
faxResolution string No Fax resolution reported by RingCentral.
deliveryErrorCode string No RingCentral delivery error code.
segmentCount integer · int32 No Number of SMS segments.
vmTranscriptionStatus string No Voicemail transcription state.
owner object of any No Additional RingCentral owner metadata.

Example

{
  "id": "string",
  "uri": "https://example.com",
  "extensionId": "string",
  "attachments": [
    {
      "id": "string",
      "uri": "https://example.com",
      "link": "https://example.com",
      "type": "AudioRecording",
      "contentType": "string",
      "vmDuration": 0,
      "fileName": "string",
      "size": 0,
      "height": 0,
      "width": 0
    }
  ],
  "availability": "Alive",
  "conversationId": "string",
  "conversation": {},
  "creationTime": "2026-01-01T00:00:00Z",
  "lastModifiedTime": "2026-01-01T00:00:00Z",
  "direction": "Inbound",
  "from": {
    "phoneNumber": "string",
    "extensionNumber": "string",
    "extensionId": "string",
    "name": "string",
    "location": "string",
    "recipientId": "string",
    "target": false,
    "messageStatus": "string"
  },
  "to": [
    {
      "phoneNumber": "string",
      "extensionNumber": "string",
      "extensionId": "string",
      "name": "string",
      "location": "string",
      "recipientId": "string",
      "target": false,
      "messageStatus": "string"
    }
  ]
}