Giden arama istekleri
/api/v1/aramalar — POST
Bölüm başlığı “/api/v1/aramalar — POST”Giden arama iste
Firmanın tanımlı bir amacı için müşteriyi asistana aratır. Idempotency-Key zorunludur (yoksa 422 idempotency_key_required): aynı anahtarla tekrar gönderim müşteriyi ikinci kez aratmaz. Gönderimde ön kontroller yapılır (arama yasağı, İYS sağlayıcısı, kota, açık istek, tekrar, arama saati); İYS izni aramadan hemen önce sorulur. Ret 201 ile döner: durum: "reddedildi" ve sebep. Amaç yoksa ya da kapalıysa 422 unknown_purpose, telefon geçersizse 422 invalid_phone, paket limiti aşılırsa 422 ve okunur mesaj.
- Kimlik doğrulama:
Authorization: Bearer rz_live_… - Kapsam:
calls:write - Paket özelliği: Veri API + Giden arama — kapalıysa uç 404
not_founddöner - Idempotency-Key: zorunlu
İstek gövdesi (application/json)
Bölüm başlığı “İstek gövdesi (application/json)”- ile işaretli alanlar zorunludur. Bilinmeyen alan 422 ile reddedilir.
OutboundRequestIn
| Alan | Tür | Sınır | Anlamı |
|---|---|---|---|
amac * | string | min 2, max 40 | Amaç anahtarı (Konsol → Giden aramalar → Amaçlar). |
konu * | string | min 10, max 1000 | Asistanın bilmesi gereken mesele, 10–1000 karakter. |
musteri * | zitena_core__outbound__requests__CustomerIn | Aranacak müşteri. | |
siparis_no | string | null | max 64 | İlgili sipariş. |
sepet_id | string | null | max 200 | İlgili sepet. |
tetikleyen * | TriggererIn | İsteği yapan kişi (günlük kota kişi başınadır). | |
en_erken | string (date-time) | null | En erken arama zamanı; randevu olarak da saklanır. Dilimsizse İstanbul saati. |
zitena_core__outbound__requests__CustomerIn
| Alan | Tür | Sınır | Anlamı |
|---|---|---|---|
ad * | string | min 1, max 120 | |
telefon * | string | min 10, max 32 | |
eposta | string | null | max 200 |
TriggererIn
| Alan | Tür | Sınır | Anlamı |
|---|---|---|---|
ad * | string | min 1, max 120 | Ad. |
eposta | string | null | max 200 | E-posta. |
curl -s -X POST "$RZ_API/api/v1/aramalar" \ -H "Authorization: Bearer $RZ_KEY" -H "Content-Type: application/json" \ -H "Idempotency-Key: sikayet-560991-1" \ -d '{"amac": "sikayet", "konu": "Kargo hasarlı teslim edildi; müşteri iade mi değişim mi istediğini söyleyecek.", "musteri": {"ad": "Ayşe Yılmaz", "telefon": "05321234567", "eposta": "[email protected]"}, "siparis_no": "560991", "tetikleyen": {"ad": "Can Demir", "eposta": "[email protected]"}, "en_erken": "2026-09-28T10:00:00+03:00"}'Yanıt 201
Bölüm başlığı “Yanıt 201”Şema: AramaYaniti
| Alan | Tür | Sınır | Anlamı |
|---|---|---|---|
arama_id * | string (uuid) | ||
durum * | string | ||
sebep | string | null | ||
planlanan_zaman | string (date-time) | null |
{ "arama_id": "0199…", "durum": "planlandi", "sebep": "en_erken", "planlanan_zaman": "2026-09-28T07:00:00Z"}Hata durumları: 401, 403, 404, 413, 422, 429 — bkz. Hatalar ve sınırlar.
/api/v1/aramalar/{arama_id} — GET
Bölüm başlığı “/api/v1/aramalar/{arama_id} — GET”Giden arama durumu ve sonucu
İsteğin durumu ve sonucu. Kapsam: calls:read ya da calls:write. Yanıtta tam telefon yoktur.
- Kimlik doğrulama:
Authorization: Bearer rz_live_… - Kapsam:
calls:readya dacalls:write - Paket özelliği: Veri API + Giden arama — kapalıysa uç 404
not_founddöner
Parametreler
Bölüm başlığı “Parametreler”| Ad | Yer | Tür | Sınır | Anlamı |
|---|---|---|---|---|
arama_id * | path | string (uuid) | Giden arama isteği kimliği. |
curl -s "$RZ_API/api/v1/aramalar/0199…" -H "Authorization: Bearer $RZ_KEY"Yanıt 200
Bölüm başlığı “Yanıt 200”{ "arama_id": "0199…", "amac": "sikayet", "durum": "tamamlandi", "sebep": null, "planlanan_zaman": null, "deneme": 1, "call_id": "0199…", "sonuc_kodu": "memnun", "sonuc": { "kaynak": "asistan", "memnuniyet": 5, "not": "…" }, "randevu": "2026-09-28T07:00:00Z", "randevu_kaynak": "tetikleyen", "created_at": "2026-09-27T12:00:00Z", "updated_at": "2026-09-28T07:04:10Z"}Hata durumları: 401, 403, 404, 413, 422, 429 — bkz. Hatalar ve sınırlar.
/api/v1/amaclar — GET
Bölüm başlığı “/api/v1/amaclar — GET”Aktif arama amaçları
Aktif arama amaçları (entegrasyonlarınızın amaç seçimi için) ve firmanın arama saatleri: saatler pazartesiden pazara 7 öğedir, İstanbul saatiyle; null o gün kapalı demektir.
- Kimlik doğrulama:
Authorization: Bearer rz_live_… - Kapsam:
calls:write - Paket özelliği: Veri API + Giden arama — kapalıysa uç 404
not_founddöner
curl -s "$RZ_API/api/v1/amaclar" -H "Authorization: Bearer $RZ_KEY"Yanıt 200
Bölüm başlığı “Yanıt 200”{ "items": [ { "anahtar": "sikayet", "ad": "Şikâyet takibi", "tur": "hizmet", "hedef": "Müşterinin memnuniyetini ölç" } ], "saatler": [ { "bas": "09:00", "bit": "20:00" }, { "bas": "09:00", "bit": "20:00" }, { "bas": "09:00", "bit": "20:00" }, { "bas": "09:00", "bit": "20:00" }, { "bas": "09:00", "bit": "20:00" }, { "bas": "10:00", "bit": "18:00" }, null ]}Hata durumları: 401, 403, 404, 413, 422, 429 — bkz. Hatalar ve sınırlar.
© 2026 Erusoft