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.
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.
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
Ad
Tür
Zorunlu
Açıklama
idyol
uuid
evet
id kimliği
Örnek istek
curl -X GET "https://hiboty.com/api/v1/conversations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
-H "Authorization: Bearer $HIBOTY_API_KEY"
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.
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.
İ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
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.
İ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
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.
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.
İ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
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.
İ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
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.
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.
İ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
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
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.
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.
İ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ı
Ad
Tür
Zorunlu
Açıklama
body
string
evet
len 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?"}'
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.
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.
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.
İ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
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.