会話ステータスを更新

toggle_status API を使用して、指定した会話のステータスを変更します。サーバーは、対象ステータスへの遷移が STATUS_TRANSITIONS ステータス遷移マトリクス に従って有効かどうかを検証します。

リクエストメソッド

POST

リクエスト URL

https://livedesk-api.engagelab.com/api/v2/accounts/conversations/{conversation_id}/toggle_status

認証

詳細は、API Overview の認証に関する説明を参照してください。

リクエスト

リクエスト例

              
              curl -X POST 'https://livedesk-api.engagelab.com/api/v2/accounts/conversations/{conversation_id}/toggle_status' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
-d '{
    "status": "resolved",
    "snoozed_until": 1715000000
}'

            

リクエストヘッダー

パスパラメータ

リクエストボディパラメータ

status の列挙値

ステータス遷移マトリクス（STATUS_TRANSITIONS）

主な制約

• closed に遷移するための前提ステータスは resolved のみです：open、pending、snoozed から closed に直接変更することはできません。アーカイブする前に、まず resolved へ遷移する必要があります。
• closed から戻せるのは open のみです：アーカイブ済みの会話は、resolved、pending、snoozed など、他のアクティブなステータスへ直接遷移できません。
• 同一ステータスへの書き込みは冪等です：対象ステータスが現在のステータスと同じ場合、検証はスキップされ、リクエストは直接成功します。コールバックはトリガーされません。
• バリデーションは ActiveRecord モデルレイヤーで validate :status_transition_allowed, if: :will_save_change_to_status? によって実装されており、すべての save!、update!、および status= の後に save を行う経路に適用されます。

レスポンス

成功レスポンス

HTTP 200：

              
              {
  "meta": {},
  "payload": {
    "success": true,
    "conversation_id": 45,
    "current_status": "resolved",
    "snoozed_until": null
  }
}

            

レスポンスパラメータ

エラーレスポンス

422 レスポンス構造

ステータス遷移マトリクス違反（モデルレイヤーのバリデーションに由来し、RequestExceptionHandler により full_messages としてレンダリングされます）：

              
              {
  "message": "Status can't transition from open to closed",
  "attributes": ["status"]
}

            

不明なステータス列挙値（CustomExceptions::Conversation::InvalidStatus に由来）：

              
              {
  "message": "Invalid conversation status: \"foo\" ('foo' is not a valid status)"
}

            

無効な snoozed_until（CustomExceptions::Conversation::InvalidSnoozedUntil に由来）：

              
              {
  "message": "Invalid snoozed_until: \"not-a-timestamp\" (invalid date)"
}