next

メッセージ状態変更(未読,既読,承認)

概要

  • メッセージを承認/拒否する
    • 承認するメッセージのTypeがmessageの場合
      メッセージの状態を既読/未読に変更する
    • 承認するメッセージのTypeがrequestの場合
      • RequestTypeがrelation.add/reation.removeの場合
        メッセージの値に従い、RelationとExtCellをリンク/リンク解除し、メッセージの状態を承認/拒否に変更する
      • RequestTypeがrole.add/role.removeの場合
        メッセージの値に従い、RoleとExtCellをリンク/リンク解除し、メッセージの状態を承認/拒否に変更する
      • RequestTypeがrule.add/rule.removeの場合
        メッセージの値に従い、Ruleを作成/削除し、メッセージの状態を承認/拒否に変更する

必要な権限

message

Typeがrequestの場合はRequestTypeに応じて以下の権限も必要

RequestType必要な権限
relation.add
relation.remove
role.add
role.remove		social
rule.add
rule.remove		rule

制限事項

  • リクエストヘッダのContent-Typeは全てapplication/jsonとして扱う
  • リクエストボディはJSON形式のみ受け付ける
  • レスポンスヘッダのContent-Typeはapplication/jsonのみをサポートし、レスポンスボディはJSON形式とする
  • $formatクエリオプションにatom または xmlを指定した場合、エラーとはならないが、レスポンスボディのデータの保証はない

リクエスト

リクエストURL

{CellURL}__message/received/{MessageID}

メソッド

POST

リクエストクエリ

クエリ名概要有効値必須備考
p_cookie_peerクッキー認証値認証時にサーバから返却されたクッキー認証値×Authorizationヘッダの指定が無い場合のみ有効
クッキーの認証情報を利用する場合に指定する

リクエストヘッダ

ヘッダ名概要有効値必須備考
X-HTTP-Method-Overrideメソッドオーバーライド機能任意×POSTメソッドでリクエスト時にこの値を指定すると、指定した値がメソッドとして使用されます。
X-Overrideヘッダオーバライド機能${上書きするヘッダ名}:${値}×通常のHTTPヘッダの値を上書きします。複数のヘッダを上書きする場合はX-Overrideヘッダを複数指定します。
X-Personium-RequestKeyイベントログに出力するRequestKeyフィールドの値半角英数、-(半角ハイフン)と_(半角アンダーバー)
最大128文字		×指定がない場合は、UUIDの独自短縮表現として${4桁}_${18桁}の形式のBase64url文字列を自動採番
AuthorizationOAuth2.0形式で、認証情報を指定するBearer {AccessToken}×※認証トークンは認証トークン取得APIで取得したトークン
Content-Typeリクエストボディの形式を指定するapplication/json×省略時は[application/json]として扱う
Acceptレスポンスボディの形式を指定するapplication/json×省略時は[application/json]として扱う

リクエストボディ

JSON

項目名概要有効値必須備考
CommandメッセージコマンドTypeがmessageの場合
　read: 既読
　unread: 未読
Typeがrequestの場合
　approved: 承認
　rejected: 拒否
　ただし既にapproved、rejectedに変更済みの場合は承認不可		○

リクエストサンプル

{"Command": "approved"}

レスポンス

ステータスコード

204

レスポンスヘッダ

項目名概要備考
ETagリソースのバージョン情報
DataServiceVersionODataのバージョン
Access-Control-Allow-Originクロスドメイン通信許可ヘッダ返却値は"*"固定
X-Personium-VersionAPIの実行バージョンリクエストが処理されたAPIバージョン

レスポンスボディ

なし

エラーメッセージ一覧

エラーメッセージ一覧を参照

cURLサンプル

curl "https://cell1.unit1.example/__message/received/c87b42e10df846a9bee842225d1383fe" -X POST \
-i -H 'Authorization: Bearer AA~PBDc...(省略)...FrTjA' -H 'Accept: application/json' \
-d '{"Command": "approved"}'
← メッセージ送信SentMessage取得 →