Perbarui Status Percakapan

Gunakan API toggle_status untuk mengubah status percakapan yang ditentukan. Server memvalidasi apakah status target valid sesuai dengan matriks transisi status STATUS_TRANSITIONS.

Metode Permintaan

POST

Endpoint

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

Autentikasi

Untuk detail, lihat deskripsi metode autentikasi di Ikhtisar API.

Permintaan

Contoh Permintaan

              
              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
}'

            

Header Permintaan

Parameter Path

Parameter Body Permintaan

Nilai Enum status

Matriks Transisi Status (STATUS_TRANSITIONS)

Batasan Utama

• resolved adalah satu-satunya status prasyarat untuk masuk ke closed: open, pending, dan snoozed tidak dapat langsung diubah ke closed; status-status tersebut harus terlebih dahulu bertransisi ke resolved sebelum diarsipkan.
• closed hanya dapat bertransisi kembali ke open: Percakapan yang diarsipkan tidak dapat langsung bertransisi ke status aktif lainnya seperti resolved, pending, atau snoozed.
• Mengatur status yang sama bersifat idempoten: Jika status target sama dengan status saat ini, validasi akan dilewati dan keberhasilan langsung dikembalikan. Tidak ada callback yang dipicu.
• Validasi diimplementasikan pada lapisan model ActiveRecord melalui validate :status_transition_allowed, if: :will_save_change_to_status?, dan berlaku untuk semua jalur save!, update!, serta status= + save.

Respons

Respons Berhasil

HTTP 200:

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

            

Parameter Respons

Respons Kesalahan

Struktur Respons 422

Melanggar matriks transisi status (berasal dari validasi lapisan model dan dirender sebagai full_messages oleh RequestExceptionHandler):

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

            

Nilai enum status tidak dikenal (berasal dari CustomExceptions::Conversation::InvalidStatus):

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

            

snoozed_until tidak valid (berasal dari CustomExceptions::Conversation::InvalidSnoozedUntil):

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