verify_messages

Read one Verify run's Messages page

Authenticated only by the run's host-only Messages session cookie. A foreign Origin is refused.

get/api/v1/verify_messages/runs/{scenario_run_id}

Request

  • Base URL
    https://composal.com (the document declares no server; this is the origin it was published from)
  • URL
    https://composal.com/api/v1/verify_messages/runs/{scenario_run_id}
  • Auth
    API key in cookie __Host-verify_messages

Path parameters

scenario_run_idstring required

Response

The conversation as this run sees it

scenario_run_idstring required
assistant_namestring required
assistant_numberstring required
typingboolean required
send_blocked_reasonstring nullable required

Why the run cannot send now; null when it can.

retry_blocked_reasonstring nullable required

Why an admitted pending operation cannot retry now; null when it can.

sends_remaininginteger required
expires_atstring date-time required
attachment_limitinteger required
attachment_max_bytesinteger required
csrf_tokenstring required

Sent back as X-Messages-CSRF-Token; useless without the session cookie.

Changes

No recorded changes to this operation across all 3 revisions of this API.