Skip to content
Olivares AI docs

Opens one authorized user Message after its exact carrier checks.

GET
/v1/m/sessions/messages/{id}
 
curl --request GET \
  --url https://example.com/v1/m/sessions/messages/example \
  --header 'Authorization: Bearer <token>'

Opens one authorized user Message after its exact carrier checks.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
string

Path parameter id.

Header Parameters

Section titled “ Header Parameters ”
X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Authorized opened Delivery

Media type application/json
object
delivery
required
object
ack_due_at
Any of:
string format: date-time
acknowledged_at
Any of:
string format: date-time
available_at
required
string format: date-time
delivery_seq
required
integer format: int64
expires_at
Any of:
string format: date-time
first_seen_at
Any of:
string format: date-time
id
required
string format: uuid
message_id
required
string format: uuid
recipient
required
object
kind
required
string
Allowed values: user agent session
ref
required
string
>= 1 characters <= 1024 characters
required
required
boolean
state
required
string
version
required
integer format: int64
fulfillment
required
object
acknowledged
required
integer format: int64
quorum
integer format: int64
required
required
integer format: int64
state
required
string
unmet
required
integer format: int64
viable
required
integer format: int64
message
required
object
ack_due_at
Any of:
string format: date-time
ack_policy
required
string
ack_quorum
integer format: int64
available_at
required
string format: date-time
channel_id
required
string format: uuid
content
required
object
blocks
required
Array<object>
>= 1 items <= 64 items
object
code
string
format
string
Allowed values: "" plain markdown
reference
Any of:
object
hash
string
kind
required
string
>= 1 characters
ref
required
string
>= 1 characters
text
string
type
required
string
Allowed values: text reference status action_ref
subject
required
string
expires_at
Any of:
string format: date-time
id
required
string format: uuid
published_at
Any of:
string format: date-time
sender
required
object
kind
required
string
Allowed values: user agent session system
ref
required
string
>= 1 characters <= 1024 characters
state
required
string
terminal_at
Any of:
string format: date-time
terminal_code
string
thread_id
required
string format: uuid
urgency
required
string
version
required
integer format: int64
Example 
{
  "delivery": {
    "recipient": {
      "kind": "user"
    }
  },
  "message": {
    "content": {
      "blocks": [
        {
          "format": "",
          "type": "text"
        }
      ]
    },
    "sender": {
      "kind": "user"
    }
  }
}

401

Section titled “ 401 ”

Unauthenticated

Media type application/json
object
Example generated 
{}

403

Section titled “ 403 ”

Forbidden

Media type application/json
object
Example generated 
{}

404

Section titled “ 404 ”

Not found

Media type application/json
object
Example generated 
{}

429

Section titled “ 429 ”

Rate limited

Media type application/json
object
Example generated 
{}

503

Section titled “ 503 ”

Current authority, custody or store evidence is unavailable; or, with code commit_outcome_unknown, the write was issued and its outcome was never learned, so it may be durable and must not be retried automatically

Media type application/json
object
Example generated 
{}