LiveTipsDeliveryResult live.tips-delivery-result@1
Generated at from
openvibe-contracts v0.53.0 and
openvibe-sdk v0.11.0.
- Version
- 1.0.0
- Owner
- live
- Visibility
- first-party
- Status
- active
- Compatibility
- backward
- Schema
https://openvibe.network/contracts/live/tips-delivery-result.v1.json
live.tips-delivery-result@1: the answer of POST /internal/tips/deliveries on OpenVibe.Live: 200 { ok: true, ref } naming what was made (the saved chat message for chat_line/paid_message, the stream spoken on for tts, the queued media request); the same answer again for a repeated Idempotency-Key. Refusals are { error }: 400 without an Idempotency-Key, 404 creator without a Live channel (permanent), 409 the same delivery is still running (retry), 422 unknown effect, no text, or a media request that failed.
Fields
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
ok | const | yes |
| |
ref | object | yes | ||
ref.chat_message_id | integer | null | |||
ref.stream_id | integer | null | |||
ref.media_request_id | integer |
Examples
From the contract's own test fixtures: valid ones validate, rejected ones must fail.
Valid: chat-line
{
"ok": true,
"ref": {
"chat_message_id": 81290
}
}Rejected: not-ok
{
"ok": false,
"ref": {}
}Validate
const contracts = require('openvibe-contracts');
contracts.validate('live.tips-delivery-result@1', value); // { valid, errors: [{ path, message }] }