本文へ移動

Bounty Developer

POST`/api/sessions/{id}/live/host-prompt`

「セッション」の分類の、新しく作る、または操作を実行するために内容を送る API。ログインした本人として呼ぶ。

要約: 投票を始める・終える（主催）
呼び方と印: ログイン

URL に付ける値（パラメータ）

経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。

idpath必須string(uuid)

送るもの（本文）application/json

送る本文の欄。「必須」の印がある欄は省けない。

|1必須object
action必須"stop"
|2必須object
action必須"start"
question必須string
長さ ≤140
options任意array<object>
件数 ≤4
id任意string
長さ ≤8
label任意string
長さ ≤60

返るもの（応答）200 · application/json

成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。

revinteger
promptobject | null
- idstring
- questionstring
- optionsarray<object>
  - idstring
  - labelstring
- startedAtstring
resultsobject | null
- revinteger
- totalinteger
- countsrecord<number>
myVotestring | null
oktrue
promptRevinteger

失敗したとき（エラー）

失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。

400入力の誤り（error = invalid_input など）
401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
403権限が無い
404HTTP 404（x-bounty-error-codes を参照）

not_found
forbidden
content_feature_disabled
no_question
need_options

呼び出しの見本

そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。

curl -X POST "https://bounty.spikes.4s.link/api/sessions/{id}/live/host-prompt" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "stop"
  }'

POST /api/sessions/{id}/live/host-prompt | Bounty Developer