İçeriğe atla
Türkçe
  • Arama alanı boş olduğundan herhangi bir öneri bulunmamaktadır.

Pisano Harici API - Akışlar - Aktif Anket Sorgusu

Aktif Anket Sorgusu

Müşteriye özel aktif anketleri getirir.

POST /external/v1/nodes/{node_id}/active_surveys

Kimlik Doğrulama

Kimlik Doğrulama Yöntemi Token token=<TOKEN>

İstek

Yol Parametreleri

Parametre Tip Zorunlu Açıklama Örnek
node_id string Evet Pisano birim ID'si. Pisano, yapılandırılmış domainler/birimler için özel ID'ler sağlar. <node_id>

Header Bilgileri

Header Zorunlu Açıklama Örnek
Accept Hayır Beklenen yanıtın medya türünü belirtir. Önerilen değer: application/json. application/json
Content-Type Evet İstek içeriğinin türünü belirtir. application/json olmalıdır. application/json
Authorization Evet İsteğin kimlik doğrulamasını sağlamak için kullanılan entegrasyon anahtarı. Token token=<TOKEN>

İstek Gövdesi

{
  "customer": {
    "phone_number": "<phone_number>",
    "external_id": "<external_id>",
    "email": "test@example.com",
    "schema": {
      "TCKN": "<TCKN>"
    }
  },
  "response_channel_id": "<response_channel_id>"
}

İstek Gövdesi Alanları

Alan Tip Zorunlu Açıklama Örnek
customer.phone_number string Opsiyonel Müşterinin telefon numarası. <phone_number>
customer.email string Opsiyonel Müşterinin e-posta adresi. test@example.com
customer.external_id string Opsiyonel Müşterinin harici tanımlayıcısı. <external_id>
customer.schema.TCKN string Opsiyonel Müşteri şemasında kayıtlı TCKN değeri. <TCKN>
response_channel_id string Opsiyonel Cevap kanalının tanımlayıcısı. <response_channel_id>

İstek Örneği

cURL İstek Örneği
curl --location --request POST \
'<API_URL>/external/v1/nodes/<node_id>/active_surveys' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token token=<TOKEN>' \
--data '{
  "customer": {
    "phone_number": "<phone_number>",
    "external_id": "<external_id>",
    "email": "test@example.com",
    "schema": {
      "TCKN": "<TCKN>"
    }
  },
  "response_channel_id": "<response_channel_id>"
}'

Yanıtlar

200 Başarılı

Yanıt Alanları

Alan Tip Zorunlu Açıklama Örnek
count integer Döndürülen aktif anket sayısı. 0
surveys array Eşleşen müşteriyle ilişkili aktif anketlerin listesi. []
surveys[].Link string Aktif anket bağlantısı. anket1.psn.vc
surveys[].SurveyName string Aktif anketin adı. Anket 1
surveys[].LastActivationDate string Müşteriye özel bağlantının son aktiflik tarihi. 10.04.2026 12:45:05
surveys[].UnitName string İlişkili domain/birim bilgisi. Mobil

Yanıt Örneği

JSON Başarılı Yanıt Örneği
{
  "count": 0,
  "surveys": []
}

Hata Yanıtları

400 Zorunlu müşteri tanımlayıcısı eksik
JSON Hata Yanıtı Örneği
{
  "error_message": "Required field not present in params!",
  "data": "Required field not present in params!",
  "code": 13015,
  "errors": "customer.phone_number, customer.email, customer.external_id or customer.schema.TCKN is required"
}
401 Hatalı kimlik doğrulama anahtarı
JSON Hata Yanıtı Örneği
{
  "error_message": "Wrong authentication token",
  "data": "Wrong authentication token",
  "code": 13001,
  "errors": null
}
404 Birim bulunamadı
JSON Hata Yanıtı Örneği
{
  "error_message": "Requested resource not found!",
  "data": "Requested resource not found!",
  "code": 13002,
  "errors": {
    "node_id": "00000000-0000-0000-0000-000000000000"
  }
}

Ek Bilgiler

Kullanım Kısıtlamaları En az bir müşteri tanımlayıcısı sağlanmalıdır: customer.phone_number, customer.email, customer.external_id veya customer.schema.TCKN. Her tanımlayıcı tek başına kullanılabilir. Birden fazla tanımlayıcı gönderilmesi durumunda değerler AND koşuluyla birleştirilir ve eşleşen müşterinin aktif anketleri döndürülür.
Notlar API temel URL'si ortama özeldir ve Test ile PROD ortamları için ayrı olarak paylaşılır.

LastActivationDate tarih formatı: %d.%m.%Y %H:%M:%S (örnek: 10.04.2026 12:45:05).

Bu servisin çalışması ve sonuç döndürebilmesi için Kanalların gelişmiş ayarlarında bulunan "bağlantı son kullanma tarihi" özelliğinin etkinleştirilmesi gerekir. Seçilen tarih aralığında oluşturulan bağlantılar aktif kabul edilir ve servis bu bağlantılar için sonuç döndürebilir.