OmnioDocsAPI referenceOpen the app

Get message

GET/v1/messages/{message_id}

One message with its status and timestamps.

Scope messages:read

Path parameters

message_idstring, uuidRequired

Response

  • 200Success
Response fields
message_idstringRequired
conversation_idstringRequired
seqintegerRequired
directionstringRequired
sourcestringRequired
authorobjectRequired
May be null
typestringRequired
contentobjectRequired
reply_to_message_idstringRequired
May be null
attachmentsarray of object
Default
attachments[].idstringRequired
attachments[].kindstringRequired
attachments[].mime_typestringRequired
May be null
attachments[].file_namestringRequired
May be null
attachments[].size_bytesintegerRequired
May be null
statusstringRequired
read_inferredbooleanRequired
provider_message_idstringRequired
May be null
errorobjectRequired
May be null
error.codestringRequired
error.messagestringRequired
error.provider_codeintegerRequired
May be null
error.detailsobjectRequired
May be null
created_atstring, date-timeRequired
queued_atstring, date-timeRequired
May be null
submitted_atstring, date-timeRequired
May be null
sent_atstring, date-timeRequired
May be null
delivered_atstring, date-timeRequired
May be null
read_atstring, date-timeRequired
May be null
rejected_atstring, date-timeRequired
May be null
failed_atstring, date-timeRequired
May be null

Errors

  • 401unauthorized. The key is missing, unknown or revoked
  • 403insufficient_scope. The key lacks the scope above
  • 404not_found
  • 422validation_error. details.fields names each field at fault

Every error has the same shape. See Errors.