API başvurusu

Sohbetler

Bu gruptaki 12 uç.

Sohbetleri son mesaja göre listeler

GET/api/v1/conversations

Kapsam
read
SDK metodu
listConversations · list_conversations
MCP aracı
listConversationssalt okunur

Sayfalı

Parametreler

AdTürZorunluAçıklama
bot_idsorguuuidhayır
statussorguenumhayıropen | handoff | closed
limitsorguintegerhayırSayfa boyutu (1–200, varsayılan 100); tam sayı değilse 400val 1–200, default 100
cursorsorgustringhayırÖnceki yanıttaki next_cursor (opak; eski date-time imleçleri de kabul edilir)

Örnek istek

curl -X GET "https://hiboty.com/api/v1/conversations?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "open",
      "unread_count": 1,
      "last_message_preview": "string",
      "last_message_at": "2026-11-06T09:00:00.000Z",
      "contact": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "external_id": "123456789",
        "name": "Hiboty",
        "channel": "telegram",
        "consent": "opted_in"
      }
    }
  ],
  "next_cursor": "string"
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Sohbet durumunu değiştirir

POST/api/v1/conversations/{id}/status

open: AI yeniden yanıtlar; handoff: temsilciye devreder, AI susar; closed: kapatır (memnuniyet anketi açıksa kişiye gider). Kapsam: write.

Kapsam
write
SDK metodu
updateConversationStatus · update_conversation_status
MCP aracı
updateConversationStatusdış etkili

Parametreler

AdTürZorunluAçıklama
idyoluuidevetSohbet kimliği

Gövde alanları

AdTürZorunluAçıklama
statusenumevetopen | handoff | closed

Örnek istek

curl -X POST "https://hiboty.com/api/v1/conversations/3fa85f64-5717-4562-b3fc-2c963f66afa6/status" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"handoff"}'

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "open",
    "previous_status": "open",
    "assigned_user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "closed_at": "2026-11-06T09:00:00.000Z"
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Sohbet ayrıntısı

GET/api/v1/conversations/{id}

Kişi özeti, bot, atanan üye, erteleme ve mesaj seli durumunu döner. Üye rolü yalnız erişebildiği botların sohbetlerini görür. Kapsam: conversations:read.

Kapsam
conversations:read
SDK metodu
getConversation · get_conversation
MCP aracı
getConversationsalt okunur

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği

Örnek istek

curl -X GET "https://hiboty.com/api/v1/conversations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "open",
    "unread_count": 1,
    "last_message_preview": "string",
    "last_message_at": "2026-11-06T09:00:00.000Z",
    "handoff_at": "2026-11-06T09:00:00.000Z",
    "closed_at": "2026-11-06T09:00:00.000Z",
    "snoozed_until": "2026-11-06T09:00:00.000Z",
    "flood_until": "2026-11-06T09:00:00.000Z",
    "created_at": "2026-11-06T09:00:00.000Z",
    "bot": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Hiboty",
      "channel": "string"
    },
    "contact": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "external_id": "123456789",
      "name": "Hiboty",
      "username": "ayse",
      "channel": "string",
      "consent": "string"
    },
    "assigned_user": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Hiboty"
    }
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Sohbeti ekip üyesine atar

POST/api/v1/conversations/{id}/assign

user_id null ise atama kalkar ve durum değişmez. Atanan varsa sohbet temsilciye geçer, AI susar ve ilk geçişte conversation.handoff olayı yayınlanır. Hedef ekipte değilse 409 not_team_member, bota erişimi yoksa 409 bot_access_denied döner. Kapsam: conversations:write.

Kapsam
conversations:write
SDK metodu
assignConversation · assign_conversation
MCP aracı
assignConversationdış etkili

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Aynı anahtar ve gövdeyle 24 saat içinde ilk yanıt aynen döner; farklı gövdede 409 idempotency_conflict.len 1–255

Gövde alanları

AdTürZorunluAçıklama
user_iduuid | nullevet

Örnek istek

curl -X POST "https://hiboty.com/api/v1/conversations/3fa85f64-5717-4562-b3fc-2c963f66afa6/assign" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482" \
  -H "Content-Type: application/json" \
  -d '{"user_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}'

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "open",
    "unread_count": 1,
    "last_message_preview": "string",
    "last_message_at": "2026-11-06T09:00:00.000Z",
    "handoff_at": "2026-11-06T09:00:00.000Z",
    "closed_at": "2026-11-06T09:00:00.000Z",
    "snoozed_until": "2026-11-06T09:00:00.000Z",
    "flood_until": "2026-11-06T09:00:00.000Z",
    "created_at": "2026-11-06T09:00:00.000Z",
    "bot": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Hiboty",
      "channel": "string"
    },
    "contact": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "external_id": "123456789",
      "name": "Hiboty",
      "username": "ayse",
      "channel": "string",
      "consent": "string"
    },
    "assigned_user": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Hiboty"
    }
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.not_team_memberbot_access_denied
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Sohbeti okundu işaretler

POST/api/v1/conversations/{id}/read

Okunmamış sayacını sıfırlar. Kapsam: conversations:write.

Kapsam
conversations:write
SDK metodu
markConversationRead · mark_conversation_read
MCP aracı
markConversationRead

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Aynı anahtar ve gövdeyle 24 saat içinde ilk yanıt aynen döner; farklı gövdede 409 idempotency_conflict.len 1–255

Örnek istek

curl -X POST "https://hiboty.com/api/v1/conversations/3fa85f64-5717-4562-b3fc-2c963f66afa6/read" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482"

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "open",
    "unread_count": 1,
    "last_message_preview": "string",
    "last_message_at": "2026-11-06T09:00:00.000Z",
    "handoff_at": "2026-11-06T09:00:00.000Z",
    "closed_at": "2026-11-06T09:00:00.000Z",
    "snoozed_until": "2026-11-06T09:00:00.000Z",
    "flood_until": "2026-11-06T09:00:00.000Z",
    "created_at": "2026-11-06T09:00:00.000Z",
    "bot": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Hiboty",
      "channel": "string"
    },
    "contact": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "external_id": "123456789",
      "name": "Hiboty",
      "username": "ayse",
      "channel": "string",
      "consent": "string"
    },
    "assigned_user": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Hiboty"
    }
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Sohbeti erteler

POST/api/v1/conversations/{id}/snooze

option: 1s (1 saat), 3s (3 saat), yarin ve pazartesi (organizasyon saatiyle 09:00), custom ya da null (ertelemeyi kaldırır). custom için until gerekir: saat farkı taşıyan ISO an ya da farksız değer (organizasyon saatiyle okunur); şimdiden sonra ve en fazla 30 gün ileride olmalıdır. Kapsam: conversations:write.

Kapsam
conversations:write
SDK metodu
snoozeConversation · snooze_conversation
MCP aracı
snoozeConversation

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Aynı anahtar ve gövdeyle 24 saat içinde ilk yanıt aynen döner; farklı gövdede 409 idempotency_conflict.len 1–255

Gövde alanları

AdTürZorunluAçıklama
optionenumevet1s | 3s | yarin | pazartesi | custom | null
untilstringhayırYalnız option custom ikenlen ≤ 40

Örnek istek

curl -X POST "https://hiboty.com/api/v1/conversations/3fa85f64-5717-4562-b3fc-2c963f66afa6/snooze" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482" \
  -H "Content-Type: application/json" \
  -d '{"option":"yarin"}'

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "open",
    "unread_count": 1,
    "last_message_preview": "string",
    "last_message_at": "2026-11-06T09:00:00.000Z",
    "handoff_at": "2026-11-06T09:00:00.000Z",
    "closed_at": "2026-11-06T09:00:00.000Z",
    "snoozed_until": "2026-11-06T09:00:00.000Z",
    "flood_until": "2026-11-06T09:00:00.000Z",
    "created_at": "2026-11-06T09:00:00.000Z",
    "bot": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Hiboty",
      "channel": "string"
    },
    "contact": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "external_id": "123456789",
      "name": "Hiboty",
      "username": "ayse",
      "channel": "string",
      "consent": "string"
    },
    "assigned_user": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Hiboty"
    }
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Mesaj seli duraklatmasını kaldırır

POST/api/v1/conversations/{id}/clear-flood

Mesaj seli nedeniyle duraklatılan AI yanıtı hemen yeniden açılır; duraklatma yoksa bir şey değişmez. Kapsam: conversations:write.

Kapsam
conversations:write
SDK metodu
clearConversationFlood · clear_conversation_flood
MCP aracı
clearConversationFlood

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Aynı anahtar ve gövdeyle 24 saat içinde ilk yanıt aynen döner; farklı gövdede 409 idempotency_conflict.len 1–255

Örnek istek

curl -X POST "https://hiboty.com/api/v1/conversations/3fa85f64-5717-4562-b3fc-2c963f66afa6/clear-flood" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482"

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "open",
    "unread_count": 1,
    "last_message_preview": "string",
    "last_message_at": "2026-11-06T09:00:00.000Z",
    "handoff_at": "2026-11-06T09:00:00.000Z",
    "closed_at": "2026-11-06T09:00:00.000Z",
    "snoozed_until": "2026-11-06T09:00:00.000Z",
    "flood_until": "2026-11-06T09:00:00.000Z",
    "created_at": "2026-11-06T09:00:00.000Z",
    "bot": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Hiboty",
      "channel": "string"
    },
    "contact": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "external_id": "123456789",
      "name": "Hiboty",
      "username": "ayse",
      "channel": "string",
      "consent": "string"
    },
    "assigned_user": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Hiboty"
    }
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Temsilci yanıtı gönderir

POST/api/v1/conversations/{id}/reply

Müşteriye gerçek mesaj gider (test modunda simüle edilir); sohbet temsilciye geçer ve AI susar. image_url bu organizasyonun yüklediği görselin /u/ adresi olmalıdır ve dış adres kabul edilmez; görselle body açıklamadır ve boş olabilir. Plan sınırını aşan bot (403 bot_plan_restricted), aylık mesaj kotası (429 message_quota_exceeded) ve kişinin iletişim reddi (403 opted_out) POST /messages ile aynı uygulanır. Kanal hatası 502 channel_error döner. Kapsam: messages:send.

Kapsam
messages:send
SDK metodu
replyToConversation · reply_to_conversation
MCP aracı
replyToConversationdış etkili

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Aynı anahtar ve gövdeyle 24 saat içinde ilk yanıt aynen döner; farklı gövdede 409 idempotency_conflict.len 1–255

Gövde alanları

AdTürZorunluAçıklama
bodystringevetlen ≤ 4000
image_urlstringhayırlen ≤ 200

Örnek istek

curl -X POST "https://hiboty.com/api/v1/conversations/3fa85f64-5717-4562-b3fc-2c963f66afa6/reply" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482" \
  -H "Content-Type: application/json" \
  -d '{"body":"Merhaba, siparişiniz bugün kargoya verildi."}'

Örnek yanıt (201)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "sent"
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.bot_plan_restrictedopted_out
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.message_quota_exceeded
  • 502Kanal ya da dış servis hatası (channel_error).channel_error

Dahili notları listeler

GET/api/v1/conversations/{id}/notes

Yalnız ekibin gördüğü notlar, en yeni önce. Kapsam: conversations:read.

Kapsam
conversations:read
SDK metodu
listConversationNotes · list_conversation_notes
MCP aracı
listConversationNotessalt okunur

Sayfalı

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği
limitsorguintegerhayırSayfa boyutu (1–200, varsayılan 50); tam sayı değilse 400val 1–200, default 50
cursorsorgustringhayırÖnceki yanıttaki next_cursor (opak)

Örnek istek

curl -X GET "https://hiboty.com/api/v1/conversations/3fa85f64-5717-4562-b3fc-2c963f66afa6/notes?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "author_name": "string",
      "body": "string",
      "mentions": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "created_at": "2026-11-06T09:00:00.000Z"
    }
  ],
  "next_cursor": "string"
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Dahili not ekler

POST/api/v1/conversations/{id}/notes

Müşteriye gitmez. Metinde @Ad ile anılan ve bu bota erişimi olan üyelere bildirim gider; API anahtarıyla yazıldığında yazan API görünür. Kapsam: conversations:write.

Kapsam
conversations:write
SDK metodu
createConversationNote · create_conversation_note
MCP aracı
createConversationNote

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Aynı anahtar ve gövdeyle 24 saat içinde ilk yanıt aynen döner; farklı gövdede 409 idempotency_conflict.len 1–255

Gövde alanları

AdTürZorunluAçıklama
bodystringevetlen 1–2000

Örnek istek

curl -X POST "https://hiboty.com/api/v1/conversations/3fa85f64-5717-4562-b3fc-2c963f66afa6/notes" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482" \
  -H "Content-Type: application/json" \
  -d '{"body":"@Zeynep iade talebini kontrol eder misin?"}'

Örnek yanıt (201)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "conversation_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "author_name": "string",
    "body": "string",
    "mentions": [
      "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ],
    "created_at": "2026-11-06T09:00:00.000Z"
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Dahili notu siler

DELETE/api/v1/conversations/{id}/notes/{note_id}

Notu yazan ya da yönetici silebilir. API anahtarının kullanıcısı olmadığından yönetici yetkisi gerekir (403 forbidden_role). Kapsam: conversations:write.

Kapsam
conversations:write
SDK metodu
deleteConversationNote · delete_conversation_note
MCP aracı
deleteConversationNotegeri alınamaz

Parametreler

AdTürZorunluAçıklama
idyoluuidevetid kimliği
note_idyoluuidevetnote_id kimliği

Örnek istek

curl -X DELETE "https://hiboty.com/api/v1/conversations/3fa85f64-5717-4562-b3fc-2c963f66afa6/notes/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Örnek yanıt (200)

JSON
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "deleted": true
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.forbidden_role
  • 404Kayıt bulunamadı ya da bu anahtar erişemiyor (not_found).
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.

Sohbetlerde toplu işlem yapar

POST/api/v1/conversations/bulk

operation: close (anket açıksa müşteriye memnuniyet sorusu gider), assign, read. En fazla 100 kimlik. user_id yalnız assign içindir ve orada zorunludur; null atamayı kaldırır. Erişilemeyen ya da bulunmayan sohbetler işlenmez; hedefin bota erişimi olmayan sohbetler skipped sayılır. Hedef ekipte değilse 409 not_team_member döner. Kapsam: conversations:write.

Kapsam
conversations:write
SDK metodu
bulkConversations · bulk_conversations
MCP aracı
bulkConversationsdış etkili

Idempotency-Key destekli

Parametreler

AdTürZorunluAçıklama
Idempotency-Keybaşlıkstringhayırİsteğe bağlı, 1-255 görünür ASCII karakter. Aynı anahtar ve gövdeyle 24 saat içinde ilk yanıt aynen döner; farklı gövdede 409 idempotency_conflict.len 1–255

Gövde alanları

AdTürZorunluAçıklama
operationenumevetclose | assign | read
idsuuid[]evetitems 1–100
user_iduuid | nullhayır

Örnek istek

curl -X POST "https://hiboty.com/api/v1/conversations/bulk" \
  -H "Authorization: Bearer $HIBOTY_API_KEY" \
  -H "Idempotency-Key: order-10482" \
  -H "Content-Type: application/json" \
  -d '{"operation":"read","ids":["3fa85f64-5717-4562-b3fc-2c963f66afa6"]}'

Örnek yanıt (200)

JSON
{
  "data": {
    "operation": "close",
    "requested": 1,
    "affected": 1,
    "skipped": 1
  }
}

Olası hatalar

  • 400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).
  • 401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).
  • 403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.
  • 409İşlem bu durumda yapılamıyor; kod nedeni söyler.not_team_member
  • 429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.