API referenceMessages
Look up an outbound command
Read the current durable result for a previously accepted idempotency key in this organization and session. Requires send capability. Returns 200 with mode=sync for sent, failed, or unknown; 202 with mode=async for queued or sending. A missing or foreign key returns 404. The lookup has no delivery side effects.
AuthorizationBearer <token>
Send Authorization: Bearer <token>. The token can be a login JWT from the frontend or an api-key for a script. JWT access comes from the person's organization role. Api-key access comes from the permissions saved on the key.
In: header
Path Parameters
session*string
Session that owns the outbound command.
Query Parameters
key*string
Previously accepted Idempotency-Key value.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/sessions/string/outbox/by-idempotency?key=string"{ "mode": "string", "outboxId": "string", "replayed": true, "reservedMessageIds": [ "string" ], "status": "string", "timestamp": 0, "waMessageId": "string"}{ "mode": "string", "outboxId": "string", "replayed": true, "reservedMessageIds": [ "string" ], "status": "string", "timestamp": 0, "waMessageId": "string"}{ "error": { "code": "not_found", "details": { "property1": null, "property2": null }, "message": "session not found" }}