İçeriğe geç

Uç referansı

Dış sistem uçlarının alan alan istek ve yanıt tabloları, örnekleri, durum kodları ve idempotency bilgisi.

Son güncelleme:

OpenAPI şemasını indir (JSON)

Tüm uçlar POST ile çağrılır ve Kimlik doğrulama bölümünde anlatılan başlıklar ile imza gerektirir. Aşağıdaki yollar, taban adresten sonra {clientKey} önekiyle birlikte yazılmıştır; doğrudan bağlantıda clientKey değeri direct'tir. Örneklerdeki tüm değerler uydurmadır.

Yanıtlar { success, statusCode, status, message, data } zarfında döner; veri data içindedir. Hata kodu varsa data.code alanındadır.

Tek olay: dış sistemde alınan KVKK/ETK kararlarını bildir

POST/integrations/external-consent/{clientKey}/consents

Bir olay (externalEventId) 1–50 karar içerir. Aynı Idempotency-Key (yoksa externalEventId) + aynı gövde güvenle yeniden gönderilebilir (saklı sonuç döner); aynı anahtar + farklı gövde 409'dur. Her karar için sonuç APPLIED / DUPLICATE / REJECTED(code) olarak döner. ETK kararları commit sonrası İYS kuyruğuna alınır; KVKK gitmez. İmza: X-Rizaal-Signature: v1=<hex HMAC-SHA256(secret, timestamp + "." + rawBody)>.

Parametreler

Tek olay: dış sistemde alınan KVKK/ETK kararlarını bildir — parametreler
AdYeriZorunluAçıklama
Idempotency-KeyBaşlıkHayırOpsiyonel; yoksa externalEventId kullanılır. 191 karakterden uzun anahtarlar reddedilmez, SHA-256 ile kısaltılır.
X-Rizaal-SignatureBaşlıkEvetv1=<hex> HMAC-SHA256 imzası (ham gövde üzerinde).
X-Rizaal-TimestampBaşlıkEvetUnix saniye; ±300 sn tolerans.
X-Rizaal-Api-KeyBaşlıkHayır—
AuthorizationBaşlıkHayırBearer <API anahtarı> (alternatif: X-Rizaal-Api-Key).
clientKeyYolEvetİstemci anahtarı; doğrudan bağlantıda direct.

İstek alanları

Tek olay: dış sistemde alınan KVKK/ETK kararlarını bildir — istek alanları
AlanTipZorunluAçıklama
externalEventIdstringEvetDış sistemin olay kimliği (≤191). Aynı kimlik + aynı gövde güvenle yeniden gönderilebilir. Örnek: evt-2026-10-13-0001.
customernesneEvet—
customer.externalCustomerIdstringEvetDış sistemdeki müşteri kimliği. Anahtarın bağlı olduğu müşteriyle AYNI olmalı; aksi halde 422 CUSTOMER_MISMATCH. Örnek: cust-1042.
contactnesneEvet—
contact.externalContactIdstringHayırDış sistemdeki kişi kimliği (opak; makbuza yazılır). Örnek: lead-77.
contact.externalContactTypestringHayırDış sistemdeki kişi türü (opak; makbuza yazılır). Örnek: LEAD.
contact.phonestringHayırTelefon. phone veya email'den en az biri zorunlu. Türkiye numaraları +90 / 0 / çıplak biçimlerde kabul edilir. Örnek: +905321234567.
contact.emailstringHayırÖrnek: ayse@example.com.
contact.fullNamestringHayırYalnız kişi Rıza AL'da yoksa yeni kayıt için kullanılır. Örnek: Ayşe Yılmaz.
decisionsdizi (nesne)Evet1..50 karar.
decisions[].kindETK | KVKKEvet—
decisions[].channelMESAJ | ARAMA | EPOSTAHayırETK için ZORUNLU (MESAJ=SMS, ARAMA, EPOSTA); KVKK'da yok sayılır.
decisions[].consentTypeSlugstringHayırKVKK kararında Rıza AL consent type kodu (varsayılan: KVKK). Bilinmeyen kod REJECTED/UNKNOWN_CONSENT_TYPE. Örnek: KVKK.
decisions[].decisionONAY | RETEvet—
decisions[].decidedAtstringEvetKararın alındığı an (ISO-8601). Saat dilimi offset'i ZORUNLU (Z veya +03:00); offset ayrıca saklanır. Örnek: 2026-10-13T14:05:30+03:00.
decisions[].evidencenesneEvet—
decisions[].evidence.methodVOICE_CALL | SMS_REPLY | WHATSAPP | WEB_FORM | AGENT_MANUALEvetOnayın alındığı yöntem (zorunlu; kanıt zincirinde EXT:VOICE|SMS|WA|WEB|AGENT olarak hash'e girer).
decisions[].evidence.ipstringHayırÖrnek: 203.0.113.10.
decisions[].evidence.userAgentstringHayırÖrnek: Mozilla/5.0.
decisions[].evidence.sourceUrlstringHayırÖrnek: https://form.example.com/consent.
decisions[].evidence.cdrIdstringHayırÇağrı kaydı kimliği (OPSİYONEL; çağrı kaydı zorunlu değil). Örnek: cdr-8841.
decisions[].evidence.recordingRefstringHayırÖrnek: rec/2026/10/13/abc.wav.
decisions[].evidence.agentIdstringHayırÖrnek: agent-17.
decisions[].evidence.recordingSha256stringHayırÇağrı ses kaydı dosyasının SHA-256 özeti (64 hex). Kayıt Rıza AL'a gönderilmez; özeti mühürlenir, kaydın sonradan değiştirilmediği bu özetle ispatlanır. Örnek: 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08.
decisions[].evidence.transcriptSha256stringHayırGörüşme dökümünün (transcript) SHA-256 özeti (64 hex). Örnek: 60303ae22b998861bce3b28f33eec1be758a213c86c93c076dbe9f558c11c752.
decisions[].evidence.scriptRefstringHayırKişiye okunan/gösterilen onay senaryosunun kimliği ve sürümü. Örnek: kvkk-etk-onay-senaryosu/v12.
decisions[].evidence.scriptSha256stringHayırOkunan/gösterilen senaryo metninin SHA-256 özeti (64 hex). Örnek: 2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae.
decisions[].evidence.aiDisclosurebooleanHayırKişiye yapay zekâ ile konuştuğu bildirildi mi (AB Yapay Zekâ Yasası Md. 50).
decisions[].evidence.recordingNoticebooleanHayırGörüşmenin kaydedildiği kişiye bildirildi mi (kayıt anonsu).
Tek olay: dış sistemde alınan KVKK/ETK kararlarını bildir — istek örneğijson
{
  "externalEventId": "evt-ornek-0001",
  "customer": { "externalCustomerId": "musteri-ornek-1" },
  "contact": {
    "externalContactId": "kisi-ornek-1",
    "phone": "+90 555 000 00 00",
    "email": "ayse.yilmaz@ornek.com",
    "fullName": "Ayşe Yılmaz"
  },
  "decisions": [
    {
      "kind": "ETK",
      "channel": "MESAJ",
      "decision": "ONAY",
      "decidedAt": "2026-10-13T14:05:41+03:00",
      "evidence": { "method": "VOICE_CALL" }
    }
  ]
}

Yanıt alanları

Tek olay: dış sistemde alınan KVKK/ETK kararlarını bildir — yanıt alanları (data içinde)
AlanTipZorunluAçıklama
externalEventIdstringEvetÖrnek: evt-2026-10-13-0001.
duplicatebooleanEvettrue: olay daha önce işlenmişti; results ilk işlemin saklı (PII'siz) sonucudur.
resultsdizi (nesne)Evet—
results[].indexnumberEvetOlaydaki karar sırası (0 tabanlı). Örnek: 0.
results[].statusAPPLIED | DUPLICATE | REJECTEDEvet—
results[].codeAMBIGUOUS_CONTACT | INVALID_CONTACT | INVALID_DECIDED_AT | DECIDED_AT_IN_FUTURE | DECISION_TOO_OLD | CONSENT_TOO_OLD_REAPPROVAL_REQUIRED | CHANNEL_NOT_AVAILABLE | UNKNOWN_CONSENT_TYPE | STALE_DECISIONHayırREJECTED nedeni.
results[].reapprovalRequiredbooleanHayırtrue: ETK ONAY kararı 3 iş gününden eski olduğu için (İYS H467) geçerli onay olarak işlenmedi; son kullanıcıdan YENİDEN ONAY alınmalı. code=CONSENT_TOO_OLD_REAPPROVAL_REQUIRED ile birlikte gelir; bağlantıya consent.reapproval_required webhook'u da gönderilir.
results[].kindstringHayırÖrnek: ETK.
results[].channelstringHayırÖrnek: MESAJ.
Tek olay: dış sistemde alınan KVKK/ETK kararlarını bildir — yanıt örneğijson
{
  "success": true,
  "statusCode": 200,
  "status": "OK",
  "message": "Success",
  "data": {
    "externalEventId": "evt-ornek-0001",
    "duplicate": false,
    "results": [
      { "index": 0, "status": "APPLIED", "kind": "ETK", "channel": "MESAJ" }
    ]
  }
}

Olası durum kodları

Tek olay: dış sistemde alınan KVKK/ETK kararlarını bildir — durum kodları
HTTPAnlamı
200Başarılı.
400Geçersiz gövde (örn. method geçersiz/eksik, offset'siz decidedAt).
401Kimlik doğrulama başarısız.
402MODULE_NOT_IN_PLAN: doğrudan (direct) bağlantıda şirketin paketinde API Erişimi modülü yok.
409IDEMPOTENCY_CONFLICT: aynı anahtar farklı gövdeyle.
413Gövde 256 KB'ı aşıyor.
422CUSTOMER_MISMATCH: müşteri kimliği bağlantıyla eşleşmiyor.
429İstek limiti aşıldı.
503Rıza kanıt altyapısı hazır değil (kanıtsız kabul yok).

Toplu: en çok 100 olay, sonuçlar olay bazlı

POST/integrations/external-consent/{clientKey}/consents/batch

Her olay kendi externalEventId'siyle ayrı idempotent işlenir; bir olayın hatası (CUSTOMER_MISMATCH, IDEMPOTENCY_CONFLICT) yalnız o olayın error alanında döner. Idempotency-Key verilirse her olayın anahtarı <key>:<externalEventId> olur.

Parametreler

Toplu: en çok 100 olay, sonuçlar olay bazlı — parametreler
AdYeriZorunluAçıklama
Idempotency-KeyBaşlıkHayır—
X-Rizaal-SignatureBaşlıkEvet—
X-Rizaal-TimestampBaşlıkEvet—
X-Rizaal-Api-KeyBaşlıkHayır—
AuthorizationBaşlıkHayır—
clientKeyYolEvetİstemci anahtarı; doğrudan bağlantıda direct.

İstek alanları

Toplu: en çok 100 olay, sonuçlar olay bazlı — istek alanları
AlanTipZorunluAçıklama
eventsdizi (nesne)Evet1..100 olay; her olay kendi idempotency kimliğiyle ayrı işlenir.
events[].externalEventIdstringEvetDış sistemin olay kimliği (≤191). Aynı kimlik + aynı gövde güvenle yeniden gönderilebilir. Örnek: evt-2026-10-13-0001.
events[].customernesneEvet—
events[].customer.externalCustomerIdstringEvetDış sistemdeki müşteri kimliği. Anahtarın bağlı olduğu müşteriyle AYNI olmalı; aksi halde 422 CUSTOMER_MISMATCH. Örnek: cust-1042.
events[].contactnesneEvet—
events[].contact.externalContactIdstringHayırDış sistemdeki kişi kimliği (opak; makbuza yazılır). Örnek: lead-77.
events[].contact.externalContactTypestringHayırDış sistemdeki kişi türü (opak; makbuza yazılır). Örnek: LEAD.
events[].contact.phonestringHayırTelefon. phone veya email'den en az biri zorunlu. Türkiye numaraları +90 / 0 / çıplak biçimlerde kabul edilir. Örnek: +905321234567.
events[].contact.emailstringHayırÖrnek: ayse@example.com.
events[].contact.fullNamestringHayırYalnız kişi Rıza AL'da yoksa yeni kayıt için kullanılır. Örnek: Ayşe Yılmaz.
events[].decisionsdizi (nesne)Evet1..50 karar.
events[].decisions[].kindETK | KVKKEvet—
events[].decisions[].channelMESAJ | ARAMA | EPOSTAHayırETK için ZORUNLU (MESAJ=SMS, ARAMA, EPOSTA); KVKK'da yok sayılır.
events[].decisions[].consentTypeSlugstringHayırKVKK kararında Rıza AL consent type kodu (varsayılan: KVKK). Bilinmeyen kod REJECTED/UNKNOWN_CONSENT_TYPE. Örnek: KVKK.
events[].decisions[].decisionONAY | RETEvet—
events[].decisions[].decidedAtstringEvetKararın alındığı an (ISO-8601). Saat dilimi offset'i ZORUNLU (Z veya +03:00); offset ayrıca saklanır. Örnek: 2026-10-13T14:05:30+03:00.
events[].decisions[].evidencenesneEvet—
events[].decisions[].evidence.methodVOICE_CALL | SMS_REPLY | WHATSAPP | WEB_FORM | AGENT_MANUALEvetOnayın alındığı yöntem (zorunlu; kanıt zincirinde EXT:VOICE|SMS|WA|WEB|AGENT olarak hash'e girer).
events[].decisions[].evidence.ipstringHayırÖrnek: 203.0.113.10.
events[].decisions[].evidence.userAgentstringHayırÖrnek: Mozilla/5.0.
events[].decisions[].evidence.sourceUrlstringHayırÖrnek: https://form.example.com/consent.
events[].decisions[].evidence.cdrIdstringHayırÇağrı kaydı kimliği (OPSİYONEL; çağrı kaydı zorunlu değil). Örnek: cdr-8841.
events[].decisions[].evidence.recordingRefstringHayırÖrnek: rec/2026/10/13/abc.wav.
events[].decisions[].evidence.agentIdstringHayırÖrnek: agent-17.
events[].decisions[].evidence.recordingSha256stringHayırÇağrı ses kaydı dosyasının SHA-256 özeti (64 hex). Kayıt Rıza AL'a gönderilmez; özeti mühürlenir, kaydın sonradan değiştirilmediği bu özetle ispatlanır. Örnek: 9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08.
events[].decisions[].evidence.transcriptSha256stringHayırGörüşme dökümünün (transcript) SHA-256 özeti (64 hex). Örnek: 60303ae22b998861bce3b28f33eec1be758a213c86c93c076dbe9f558c11c752.
events[].decisions[].evidence.scriptRefstringHayırKişiye okunan/gösterilen onay senaryosunun kimliği ve sürümü. Örnek: kvkk-etk-onay-senaryosu/v12.
events[].decisions[].evidence.scriptSha256stringHayırOkunan/gösterilen senaryo metninin SHA-256 özeti (64 hex). Örnek: 2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae.
events[].decisions[].evidence.aiDisclosurebooleanHayırKişiye yapay zekâ ile konuştuğu bildirildi mi (AB Yapay Zekâ Yasası Md. 50).
events[].decisions[].evidence.recordingNoticebooleanHayırGörüşmenin kaydedildiği kişiye bildirildi mi (kayıt anonsu).
Toplu: en çok 100 olay, sonuçlar olay bazlı — istek örneğijson
{
  "events": [
    {
      "externalEventId": "evt-ornek-0001",
      "customer": { "externalCustomerId": "musteri-ornek-1" },
      "contact": { "phone": "+90 555 000 00 00" },
      "decisions": [
        { "kind": "KVKK", "decision": "ONAY", "decidedAt": "2026-10-13T14:05:30+03:00", "evidence": { "method": "VOICE_CALL" } }
      ]
    },
    {
      "externalEventId": "evt-ornek-0002",
      "customer": { "externalCustomerId": "musteri-ornek-1" },
      "contact": { "email": "ayse.yilmaz@ornek.com" },
      "decisions": [
        { "kind": "ETK", "channel": "EPOSTA", "decision": "RET", "decidedAt": "2026-10-13T14:06:10+03:00", "evidence": { "method": "WEB_FORM" } }
      ]
    }
  ]
}

Yanıt alanları

Toplu: en çok 100 olay, sonuçlar olay bazlı — yanıt alanları (data içinde)
AlanTipZorunluAçıklama
eventsdizi (nesne)Evet—
events[].externalEventIdstringEvetÖrnek: evt-2026-10-13-0001.
events[].duplicatebooleanEvettrue: olay daha önce işlenmişti; results ilk işlemin saklı (PII'siz) sonucudur.
events[].resultsdizi (nesne)Evet—
events[].results[].indexnumberEvetOlaydaki karar sırası (0 tabanlı). Örnek: 0.
events[].results[].statusAPPLIED | DUPLICATE | REJECTEDEvet—
events[].results[].codeAMBIGUOUS_CONTACT | INVALID_CONTACT | INVALID_DECIDED_AT | DECIDED_AT_IN_FUTURE | DECISION_TOO_OLD | CONSENT_TOO_OLD_REAPPROVAL_REQUIRED | CHANNEL_NOT_AVAILABLE | UNKNOWN_CONSENT_TYPE | STALE_DECISIONHayırREJECTED nedeni.
events[].results[].reapprovalRequiredbooleanHayırtrue: ETK ONAY kararı 3 iş gününden eski olduğu için (İYS H467) geçerli onay olarak işlenmedi; son kullanıcıdan YENİDEN ONAY alınmalı. code=CONSENT_TOO_OLD_REAPPROVAL_REQUIRED ile birlikte gelir; bağlantıya consent.reapproval_required webhook'u da gönderilir.
events[].results[].kindstringHayırÖrnek: ETK.
events[].results[].channelstringHayırÖrnek: MESAJ.
events[].indexnumberEvetİstekteki olay sırası (0 tabanlı). Örnek: 0.
events[].errornesneHayırOlay düzeyinde hata (olay hiç işlenmedi; results boş). Diğer olaylar etkilenmez.
events[].error.codeCUSTOMER_MISMATCH | IDEMPOTENCY_CONFLICTEvet—
events[].error.messagestringEvetÖrnek: Müşteri kimliği bağlantıyla eşleşmiyor..
Toplu: en çok 100 olay, sonuçlar olay bazlı — yanıt örneğijson
{
  "success": true,
  "statusCode": 200,
  "status": "OK",
  "message": "Success",
  "data": {
    "events": [
      {
        "index": 0,
        "externalEventId": "evt-ornek-0001",
        "duplicate": false,
        "results": [ { "index": 0, "status": "APPLIED", "kind": "KVKK" } ]
      },
      {
        "index": 1,
        "externalEventId": "evt-ornek-0002",
        "duplicate": false,
        "results": [],
        "error": { "code": "CUSTOMER_MISMATCH", "message": "Müşteri kimliği bağlantıyla eşleşmiyor." }
      }
    ]
  }
}

Olası durum kodları

Toplu: en çok 100 olay, sonuçlar olay bazlı — durum kodları
HTTPAnlamı
200Başarılı.
400Geçersiz gövde / 100'den fazla olay.
401Kimlik doğrulama başarısız.
402MODULE_NOT_IN_PLAN: doğrudan (direct) bağlantıda şirketin paketinde API Erişimi modülü yok.
409IDEMPOTENCY_CONFLICT (olay düzeyinde).
413Gövde 256 KB'ı aşıyor.
422CUSTOMER_MISMATCH (olay düzeyinde).
429İstek limiti aşıldı.
503Rıza kanıt altyapısı hazır değil.

Kişinin dış kanal rıza kararlarını sorgula

POST/integrations/external-consent/{clientKey}/consents/query

Gövdedeki phone veya email ile şirket kapsamında kişi bulunur (PII URL'de dolaşmaz); telefon/e-posta yanıtta DÖNMEZ. İmza diğer POST uçlarıyla aynıdır (ham gövde). Birden çok kişi eşleşirse 422 AMBIGUOUS_CONTACT.

Parametreler

Kişinin dış kanal rıza kararlarını sorgula — parametreler
AdYeriZorunluAçıklama
X-Rizaal-SignatureBaşlıkEvet—
X-Rizaal-TimestampBaşlıkEvet—
X-Rizaal-Api-KeyBaşlıkHayır—
AuthorizationBaşlıkHayır—
clientKeyYolEvetİstemci anahtarı; doğrudan bağlantıda direct.

İstek alanları

Kişinin dış kanal rıza kararlarını sorgula — istek alanları
AlanTipZorunluAçıklama
phonestringHayırÖrnek: +905321234567.
emailstringHayırÖrnek: ayse@example.com.
Kişinin dış kanal rıza kararlarını sorgula — istek örneğijson
{ "phone": "+90 555 000 00 00" }

Yanıt alanları

Kişinin dış kanal rıza kararlarını sorgula — yanıt alanları (data içinde)
AlanTipZorunluAçıklama
foundbooleanEvet—
decisionsdizi (nesne)EvetYeniden eskiye sıralı dış kanal kararları (en çok 200). Telefon/e-posta DÖNMEZ.
decisions[].kindstringEvetÖrnek: ETK.
decisions[].channelstring | nullEvetÖrnek: MESAJ.
decisions[].consentTypeCodestring | nullEvetÖrnek: KVKK.
decisions[].decisionstringEvetÖrnek: ONAY.
decisions[].methodstringEvetÖrnek: VOICE_CALL.
decisions[].decidedAtstringEvetÖrnek: 2026-10-13T11:05:30.000Z.
decisions[].decidedAtOffsetstringEvetÖrnek: +03:00.
decisions[].receivedAtstringEvetÖrnek: 2026-10-13T11:06:00.000Z.
decisions[].receiptIdstringEvetMakbuz kimliği (kaynak). Örnek: 12.
decisions[].externalEventIdstringEvetÖrnek: evt-2026-10-13-0001.
Kişinin dış kanal rıza kararlarını sorgula — yanıt örneğijson
{
  "success": true,
  "statusCode": 200,
  "status": "OK",
  "message": "Success",
  "data": {
    "found": true,
    "decisions": [
      {
        "kind": "ETK",
        "channel": "MESAJ",
        "consentTypeCode": "ETK",
        "decision": "ONAY",
        "method": "VOICE_CALL",
        "decidedAt": "2026-10-13T11:05:41.000Z",
        "decidedAtOffset": "+03:00",
        "receivedAt": "2026-10-13T11:06:00.000Z",
        "receiptId": "12",
        "externalEventId": "evt-ornek-0001"
      }
    ]
  }
}

Olası durum kodları

Kişinin dış kanal rıza kararlarını sorgula — durum kodları
HTTPAnlamı
200Başarılı.
400phone/email eksik veya geçersiz.
401Kimlik doğrulama başarısız.
402MODULE_NOT_IN_PLAN: doğrudan (direct) bağlantıda şirketin paketinde API Erişimi modülü yok.
422AMBIGUOUS_CONTACT.
429İstek limiti aşıldı (Retry-After başlığıyla).
503Rıza kanıt altyapısı hazır değil.

Toplu güncel izin durumu: kişilerin ARAMA/MESAJ/EPOSTA kanallarındaki geçerli ETK durumu

POST/integrations/external-consent/{clientKey}/consents/status

Tek istekte en çok 500 kişi (phone veya email; isteğe bağlı externalContactId). Durum, kaynağı ne olursa olsun (dış sistem, İYS, web onay/geri çekme sayfası) kişinin Rıza AL'daki GEÇERLİ ETK kanal değeridir; RET kazanır. Yalnız ALLOWED ileti/arama için yeterlidir; bekleyen yeniden onay DENIED + reapprovalRequired:true döner. Bulunan kişiler bağlantı için takibe alınır: sonraki değişiklikleri consent.changed webhook'uyla (sorguda verilen externalContactId ile) bildirilir. Her kişi bağlantının dakikalık bütçesinden 1 birim harcar. Belirsiz/geçersiz girdi yalnız kendi satırında error döner. Telefon/e-posta yanıtta DÖNMEZ. İmza diğer POST uçlarıyla aynıdır.

Parametreler

Toplu güncel izin durumu: kişilerin ARAMA/MESAJ/EPOSTA kanallarındaki geçerli ETK durumu — parametreler
AdYeriZorunluAçıklama
X-Rizaal-SignatureBaşlıkEvet—
X-Rizaal-TimestampBaşlıkEvet—
X-Rizaal-Api-KeyBaşlıkHayır—
AuthorizationBaşlıkHayır—
clientKeyYolEvetİstemci anahtarı; doğrudan bağlantıda direct.

İstek alanları

Toplu güncel izin durumu: kişilerin ARAMA/MESAJ/EPOSTA kanallarındaki geçerli ETK durumu — istek alanları
AlanTipZorunluAçıklama
contactsdizi (nesne)Evet1..500 kişi. Her kişi bağlantının dakikalık bütçesinden 1 birim harcar.
contacts[].phonestringHayırTelefon (+905…, 905…, 05…, 5…; boşluk/tire toleranslı). phone veya email zorunlu; ikisi birlikte verilirse önce telefon aranır. Örnek: +905321234567.
contacts[].emailstringHayırÖrnek: ayse@example.com.
contacts[].externalContactIdstringHayırDış sistemdeki kişi kimliği (opak, PII olmamalı). Yanıtta aynen döner ve kişinin sonraki consent.changed webhook'larında externalContactId olarak gelir. Örnek: lead-88231.
Toplu güncel izin durumu: kişilerin ARAMA/MESAJ/EPOSTA kanallarındaki geçerli ETK durumu — istek örneğijson
{
  "contacts": [
    { "phone": "+90 555 000 00 00", "externalContactId": "kisi-ornek-1" },
    { "email": "ayse.yilmaz@ornek.com" }
  ]
}

Yanıt alanları

Toplu güncel izin durumu: kişilerin ARAMA/MESAJ/EPOSTA kanallarındaki geçerli ETK durumu — yanıt alanları (data içinde)
AlanTipZorunluAçıklama
checkedAtstringEvetYanıtın üretildiği an; önbellek tazeliği için. Örnek: 2026-11-03T08:00:00.000Z.
contactsdizi (nesne)Evetİstek sırasıyla; telefon/e-posta DÖNMEZ.
contacts[].indexnumberEvetİstekteki kişi sırası (0 tabanlı). Örnek: 0.
contacts[].externalContactIdstring | nullEvetÖrnek: lead-88231.
contacts[].foundbooleanEvet—
contacts[].errorAMBIGUOUS_CONTACT | INVALID_CONTACTHayırAMBIGUOUS_CONTACT: birden çok kişi eşleşti. INVALID_CONTACT: telefon geçersiz ve e-posta yok. Diğer kişiler etkilenmez.
contacts[].channelsnesneEvetKişi bulunamazsa tüm kanallar NONE.
contacts[].channels.ARAMAnesneEvet—
contacts[].channels.ARAMA.statusALLOWED | DENIED | NONEEvetALLOWED: geçerli onay var. DENIED: izin yok — ret, geri çekme, izin talebinde verilmemiş kanal ya da bekleyen yeniden onay. NONE: bu kanal için hiç karar yok (sorulmamış ya da yanıt bekleyen yeni bir izin talebi var). Yalnız ALLOWED ileti/arama için yeterlidir.
contacts[].channels.ARAMA.decidedAtstring | nullEvetBu kanaldaki geçerli kararın Rıza AL'a işlendiği an (UTC). Örnek: 2026-10-13T11:05:30.000Z.
contacts[].channels.ARAMA.sourceEXTERNAL | WEB | IYS | ADMIN_PANEL | IMPORT | OTHER | nullEvetGeçerli kararın kaynağı: EXTERNAL (dış sistem), WEB (onay/geri çekme sayfası), IYS (İYS), ADMIN_PANEL, IMPORT, OTHER.
contacts[].channels.ARAMA.methodVOICE_CALL | SMS_REPLY | WHATSAPP | WEB_FORM | AGENT_MANUAL | nullEvetYalnız source=EXTERNAL iken: dış sistemin bildirdiği onay yöntemi.
contacts[].channels.ARAMA.reapprovalRequiredbooleanEvettrue: bu kanalda bekleyen yeniden onay var (ETK ONAY 3 iş gününden eski geldi); durum DENIED döner.
contacts[].channels.ARAMA.iysnesneEvetİYS'teki ARAMA durumu, Rıza AL status'undan AYRI ve bağımsızdır. Arama kararı için nasıl kullanılacağı istemciye/hukuk görüşüne aittir.
contacts[].channels.ARAMA.iys.statusONAY | RET | NONE | UNKNOWNEvetNumaranın İYS'teki ARAMA izni (şirketin İYS hesabı üzerinden; Rıza AL kaydı/kanıtı DEĞİLDİR). ONAY: İYS'te geçerli ARAMA onayı var. RET: ret/geri çekme. NONE: İYS'te ARAMA kaydı yok. UNKNOWN: değer şu an verilemiyor (reason).
contacts[].channels.ARAMA.iys.checkedAtstring | nullEvetDeğerin İYS'den alındığı an (UTC). Değer en fazla 24 saat eskidir; daha eskiyse UNKNOWN/PENDING döner ve yenilenir. UNKNOWN'da null. Örnek: 2026-11-03T09:12:00.000Z.
contacts[].channels.ARAMA.iys.reasonPENDING | LOOKUP_FAILED | SKIPPED | NO_PHONE | NOT_CONFIGURED | MODULE_LOCKEDHayırYalnız UNKNOWN'da. PENDING: arka planda sorgulanıyor, sonraki sorguda gelir. LOOKUP_FAILED: İYS sorgusu tekrar tekrar başarısız oldu (yeniden kuyruğa alındı). SKIPPED: Rıza AL'da bu numara için ARAMA kararı var (ALLOWED/DENIED), İYS sorgusu yapılmadı. NO_PHONE: geçerli bir TR cep numarası yok. NOT_CONFIGURED: şirketin İYS'i bağlı değil. MODULE_LOCKED: şirketin paketinde İYS modülü yok.
contacts[].channels.MESAJnesneEvet—
contacts[].channels.MESAJ.statusALLOWED | DENIED | NONEEvetALLOWED: geçerli onay var. DENIED: izin yok — ret, geri çekme, izin talebinde verilmemiş kanal ya da bekleyen yeniden onay. NONE: bu kanal için hiç karar yok (sorulmamış ya da yanıt bekleyen yeni bir izin talebi var). Yalnız ALLOWED ileti/arama için yeterlidir.
contacts[].channels.MESAJ.decidedAtstring | nullEvetBu kanaldaki geçerli kararın Rıza AL'a işlendiği an (UTC). Örnek: 2026-10-13T11:05:30.000Z.
contacts[].channels.MESAJ.sourceEXTERNAL | WEB | IYS | ADMIN_PANEL | IMPORT | OTHER | nullEvetGeçerli kararın kaynağı: EXTERNAL (dış sistem), WEB (onay/geri çekme sayfası), IYS (İYS), ADMIN_PANEL, IMPORT, OTHER.
contacts[].channels.MESAJ.methodVOICE_CALL | SMS_REPLY | WHATSAPP | WEB_FORM | AGENT_MANUAL | nullEvetYalnız source=EXTERNAL iken: dış sistemin bildirdiği onay yöntemi.
contacts[].channels.MESAJ.reapprovalRequiredbooleanEvettrue: bu kanalda bekleyen yeniden onay var (ETK ONAY 3 iş gününden eski geldi); durum DENIED döner.
contacts[].channels.EPOSTAnesneEvet—
contacts[].channels.EPOSTA.statusALLOWED | DENIED | NONEEvetALLOWED: geçerli onay var. DENIED: izin yok — ret, geri çekme, izin talebinde verilmemiş kanal ya da bekleyen yeniden onay. NONE: bu kanal için hiç karar yok (sorulmamış ya da yanıt bekleyen yeni bir izin talebi var). Yalnız ALLOWED ileti/arama için yeterlidir.
contacts[].channels.EPOSTA.decidedAtstring | nullEvetBu kanaldaki geçerli kararın Rıza AL'a işlendiği an (UTC). Örnek: 2026-10-13T11:05:30.000Z.
contacts[].channels.EPOSTA.sourceEXTERNAL | WEB | IYS | ADMIN_PANEL | IMPORT | OTHER | nullEvetGeçerli kararın kaynağı: EXTERNAL (dış sistem), WEB (onay/geri çekme sayfası), IYS (İYS), ADMIN_PANEL, IMPORT, OTHER.
contacts[].channels.EPOSTA.methodVOICE_CALL | SMS_REPLY | WHATSAPP | WEB_FORM | AGENT_MANUAL | nullEvetYalnız source=EXTERNAL iken: dış sistemin bildirdiği onay yöntemi.
contacts[].channels.EPOSTA.reapprovalRequiredbooleanEvettrue: bu kanalda bekleyen yeniden onay var (ETK ONAY 3 iş gününden eski geldi); durum DENIED döner.
Toplu güncel izin durumu: kişilerin ARAMA/MESAJ/EPOSTA kanallarındaki geçerli ETK durumu — yanıt örneğijson
{
  "success": true,
  "statusCode": 200,
  "status": "OK",
  "message": "Success",
  "data": {
    "checkedAt": "2026-11-03T08:00:00.000Z",
    "contacts": [
      {
        "index": 0,
        "externalContactId": "kisi-ornek-1",
        "found": true,
        "channels": {
          "ARAMA": {
            "status": "ALLOWED",
            "decidedAt": "2026-10-13T11:05:41.000Z",
            "source": "EXTERNAL",
            "method": "VOICE_CALL",
            "reapprovalRequired": false,
            "iys": { "status": "UNKNOWN", "checkedAt": null, "reason": "SKIPPED" }
          },
          "MESAJ": { "status": "DENIED", "decidedAt": "2026-10-20T08:30:00.000Z", "source": "IYS", "method": null, "reapprovalRequired": false },
          "EPOSTA": { "status": "NONE", "decidedAt": null, "source": null, "method": null, "reapprovalRequired": false }
        }
      },
      {
        "index": 1,
        "externalContactId": null,
        "found": false,
        "channels": { "ARAMA": { "status": "NONE" }, "MESAJ": { "status": "NONE" }, "EPOSTA": { "status": "NONE" } }
      }
    ]
  }
}

Olası durum kodları

Toplu güncel izin durumu: kişilerin ARAMA/MESAJ/EPOSTA kanallarındaki geçerli ETK durumu — durum kodları
HTTPAnlamı
200Başarılı.
400Geçersiz gövde / 500'den fazla kişi / phone ve email eksik.
401Kimlik doğrulama başarısız.
402MODULE_NOT_IN_PLAN: doğrudan (direct) bağlantıda şirketin paketinde API Erişimi modülü yok.
413Gövde 256 KB'ı aşıyor.
429İstek limiti aşıldı (Retry-After başlığıyla).

API anahtarınızı ve bağlantınızı yönetmek için panelde Hesabım → Şirket Ayarları → API Erişimi sekmesini kullanın. Hesabım sayfasını aç (giriş yapmanız gerekir).