本文へ移動
Bounty Developer

POST/api/messages/{id}/members

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

要約

グループへ招待する（今のメンバーなら誰でも、自分のつながりを。招待された人は受けるまでメンバーではない）

呼び方と印

ログイン・レート制限

短い時間に呼びすぎると断られる API（レート制限）。断られたら Retry-After の秒数を待って呼び直す。

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

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

  • idpath必須string(uuid)

送るもの（本文）application/json

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

  • userIds必須array<string(uuid)>
    件数 1–20

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

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

  • invitedarray<string>
  • skippedarray<object>
    • userIdstring
    • reason"not_connected" | "blocked" | "already_member" | "already_invited"

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • 429レート制限（Retry-After 付き）
  • not_a_group
  • group_full
  • too_many
  • rate_limited

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/messages/{id}/members" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "userIds": [
      "00000000-0000-4000-8000-000000000000"
    ]
  }'
POST /api/messages/{id}/members | Bounty Developer