POST/api/messages/{id}/messages/{messageId}/unsend
「メッセージ」の分類の、新しく作る、または操作を実行するために内容を送る API。ログインした本人として呼ぶ。
- 要約
送信取消(送った本人が 24 時間以内。跡が残り、本文・画像・リアクションは消える)
- 呼び方と印
ログイン
URL に付ける値(パラメータ)
経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。
idpath必須string(uuid)messageIdpath必須string(uuid)
返るもの(応答)200 · application/json
成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。
messageobjectidstringkindenum(6)"text" "stamp" "system" "image" "unsent" "location"bodystringuserIdstring | nullcreatedAtstringupdatedAt任意stringreplyTo任意object | nullidstringuserIdstring | nullsenderNamestring | nullkindenum(6)"text" "stamp" "system" "image" "unsent" "location"snippetstring
reactions任意array<object>emojistringcountintegermineboolean
attachment任意object | nullidstringurlstringmimestringbytesintegerwidthintegerheightinteger
location任意object | nullmapIdstringxnumberynumberlabelstring
hasLinks任意booleanmentions任意array<string>systemKey任意string | nullsystemParams任意record<string> | nullhidden任意booleanunsendableUntil任意string | null
失敗したとき(エラー)
失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。
- 400入力の誤り(error = invalid_input など)
- 401未ログイン(unauthorized)/ Bearer が無効(invalid_token。WWW-Authenticate 付き)
- 403権限が無い
- message_not_found
- not_sender
- already_unsent
- unsend_window_passed
呼び出しの見本
そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。
curl -X POST "https://bounty.spikes.4s.link/api/messages/{id}/messages/{messageId}/unsend" \
-H "Authorization: Bearer $BEARER_AUTH"