COcomposal
verify_messages

Send a message or attachment from the run's tester number

Needs the exact Messages Origin and the session's CSRF token. Resubmitting a client operation ID returns the original send.

post/api/v1/verify_messages/runs/{scenario_run_id}/messages

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}/messages
  • Auth
    API key in cookie __Host-verify_messages

Path parameters

scenario_run_idstring required

Headers

X-Messages-CSRF-Tokenstring required

Request body

client_operation_idstring required
contentstring required
media_upload_idsstring[]

Ordered staged upload IDs; six on Photon, one on Sendblue. Mutually exclusive with media.

retry_attachmentboolean

Retry an already recorded attachment when its file bytes are no longer on this page.

reply_tostring

Public ID of a message visible in this run

send_style'celebration' | 'shooting_star' | 'fireworks' | 'lasers' | 'love' | 'confetti' | 'balloons' | 'spotlight' | 'echo' | 'invisible' | 'gentle' | 'loud' | 'slam' | 'null' nullable

Response

The Messages page after the send was admitted

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 4 revisions of this API.