OmnioDocsAPI referenceOpen the app

List messages

GET/v1/conversations/{conversation_id}/messages

A conversation's messages in seq order.

Scope messages:read

Path parameters

conversation_idstring, uuidRequired

Query parameters

after_seqinteger
before_seqinteger
limitinteger
1 to 200. Default 50

Response

  • 200Success
Response fields
dataarray of objectRequired
data[].message_idstringRequired
data[].conversation_idstringRequired
data[].seqintegerRequired
data[].directionstringRequired
data[].sourcestringRequired
data[].authorobjectRequired
May be null
data[].typestringRequired
data[].contentobjectRequired
data[].reply_to_message_idstringRequired
May be null
data[].attachmentsarray of object
Default
data[].statusstringRequired
data[].read_inferredbooleanRequired
data[].provider_message_idstringRequired
May be null
data[].errorobjectRequired
May be null
data[].created_atstring, date-timeRequired
data[].queued_atstring, date-timeRequired
May be null
data[].submitted_atstring, date-timeRequired
May be null
data[].sent_atstring, date-timeRequired
May be null
data[].delivered_atstring, date-timeRequired
May be null
data[].read_atstring, date-timeRequired
May be null
data[].rejected_atstring, date-timeRequired
May be null
data[].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.