İzin kaydetme

POST 
/consents

İstek: POST https://ext-api.netgsm.com.tr/iys/v1/consents
Canlı ortam: https://ext-api.netgsm.com.tr/iys/v1

İzinleri İYS'ye kaydeder. Bir istekte en fazla 500 izin gönderebilirsiniz.

İYS bazı kayıtları reddederse işlem yine başarılı sayılır: kabul edilen kayıtlar işlenir, reddedilenler yanıttaki data.erroritem altında, istekteki sıralarıyla (index) döner.

Request

application/json

Bodyrequired

brandCodeintegerrequired
İYS marka kodu.
Possible values: >= 1 and <= 2147483647
Example: 123456
pathIysPath (string)nullable
Gönderilmezse SMSAPI kabul edilir.
Possible values: [SANTRAL, SMSAPI, WEBPORTAL]
Example: SMSAPI
refIdstringnullable
Possible values: non-empty and <= 255 characters
Example: 40e6215d-b5c6-4896-987c-f30f3678f608
permissions object[]required
Possible values: >= 1, <= 500
Array [
recipientstringrequired
Telefon numarası (+90XXXXXXXXXX) ya da e-posta adresi.
Possible values: <= 255 characters
Example: +905554443322
recipientTypeRecipientType (string)required
BIREYSEL bireysel, TACIR tacir alıcı.
Possible values: [BIREYSEL, TACIR]
Example: BIREYSEL
typeConsentType (string)required
ARAMA sesli arama, MESAJ SMS, EPOSTA e-posta izni.
Possible values: [ARAMA, MESAJ, EPOSTA]
Example: MESAJ
sourceConsentSource (string)required
İznin alındığı kaynak.
Possible values: [HS_FIZIKSEL_ORTAM, HS_ISLAK_IMZA, HS_WEB, HS_CAGRI_MERKEZI, HS_SOSYAL_MEDYA, HS_EPOSTA, HS_MESAJ, HS_MOBIL, HS_EORTAM, HS_ETKINLIK, HS_2015, HS_ATM, HS_KARAR]
Example: HS_WEB
statusConsentStatus (string)required
ONAY izin verildi, RET izin reddedildi.
Possible values: [ONAY, RET]
Example: ONAY
consentDatestringrequired
İznin alındığı tarih, YYYY-MM-DD HH:mm:ss.
Example: 2026-02-20 16:46:00
retailerCodeintegernullable
Possible values: >= 0
Example: 0
retailerAccessinteger[]nullable
Possible values: >= 0
Example: [0,1]
]

Responses

200

İzinler kaydedildi.

application/json

Schema

Schema

successboolean
Example: true
errorCodeinteger
Example: 0
messagestring
Example: success
data object
uidstring
Example: ee5c7e61-3940-432a-af30-13b0c9944371
erroritem object[]
İYS'nin reddettiği kayıtlar. Yalnızca reddedilen kayıt varsa bulunur.
Array [
indexinteger
Kaydın permissions içindeki sırası (0'dan başlar).
Example: 1
fieldstring
Example: recipient
messagestring
Example: Geçersiz telefon numarası formatı
]

Example (auto)

{
  "success": true,
  "errorCode": 0,
  "message": "success",
  "data": {
    "uid": "ee5c7e61-3940-432a-af30-13b0c9944371",
    "erroritem": [
      {
        "index": 1,
        "field": "recipient",
        "message": "Geçersiz telefon numarası formatı"
      }
    ]
  }
}

success

Tüm kayıtlar kabul edildi

{
  "success": true,
  "errorCode": 0,
  "message": "success",
  "data": {
    "uid": "ee5c7e61-3940-432a-af30-13b0c9944371"
  }
}

partial

Bazı kayıtlar İYS tarafından reddedildi

{
  "success": true,
  "errorCode": 0,
  "message": "success",
  "data": {
    "uid": "ee5c7e61-3940-432a-af30-13b0c9944371",
    "erroritem": [
      {
        "index": 1,
        "field": "recipient",
        "message": "Geçersiz telefon numarası formatı"
      }
    ]
  }
}

400

Hatalı istek.

application/json

Schema

Schema

successboolean
Example: false
errorCodeinteger
Hata kodu (bkz. Hata kodları).
Example: 120
messagestring
Example: Bad request
data object
Hata ayrıntıları. Çoğu hatada boş dizidir; doğrulama hatasında errors nesnesini taşır.
oneOf
MOD1
Array [
]
MOD2
object

Example (auto)

{
  "success": false,
  "errorCode": 120,
  "message": "Bad request",
  "data": [
    null
  ]
}

Example

{
  "success": false,
  "errorCode": 120,
  "message": "Bad request",
  "data": []
}

401

Token yok, geçersiz ya da süresi dolmuş.

application/json

Schema

Schema

successboolean
Example: false
errorCodeinteger
Hata kodu (bkz. Hata kodları).
Example: 120
messagestring
Example: Bad request
data object
Hata ayrıntıları. Çoğu hatada boş dizidir; doğrulama hatasında errors nesnesini taşır.
oneOf
MOD1
Array [
]
MOD2
object

Example (auto)

{
  "success": false,
  "errorCode": 120,
  "message": "Bad request",
  "data": [
    null
  ]
}

expired

Token'ın süresi dolmuş

{
  "success": false,
  "errorCode": 53,
  "message": "Token has expired",
  "data": []
}

notFound

Token bulunamadı

{
  "success": false,
  "errorCode": 51,
  "message": "Token not found",
  "data": []
}

403

Yetkisiz erişim ya da hesapta İYS hizmeti aktif değil.

application/json

Schema

Schema

successboolean
Example: false
errorCodeinteger
Hata kodu (bkz. Hata kodları).
Example: 120
messagestring
Example: Bad request
data object
Hata ayrıntıları. Çoğu hatada boş dizidir; doğrulama hatasında errors nesnesini taşır.
oneOf
MOD1
Array [
]
MOD2
object

Example (auto)

{
  "success": false,
  "errorCode": 120,
  "message": "Bad request",
  "data": [
    null
  ]
}

Example

{
  "success": false,
  "errorCode": 60,
  "message": "Unauthorized access",
  "data": []
}

422

İstekteki bir alan kurallara uymuyor.

application/json

Schema

Schema

successboolean
Example: false
errorCodeinteger
Hata kodu (bkz. Hata kodları).
Example: 120
messagestring
Example: Bad request
data object
Hata ayrıntıları. Çoğu hatada boş dizidir; doğrulama hatasında errors nesnesini taşır.
oneOf
MOD1
Array [
]
MOD2
object

Example (auto)

{
  "success": false,
  "errorCode": 120,
  "message": "Bad request",
  "data": [
    null
  ]
}

Example

{
  "success": false,
  "errorCode": 70,
  "message": "Validation failed",
  "data": {
    "errors": {
      "brandCode": "The brand code field is required."
    }
  }
}

424

İYS'den geçerli bir yanıt alınamadı.

application/json

Schema

Schema

successboolean
Example: false
errorCodeinteger
Hata kodu (bkz. Hata kodları).
Example: 120
messagestring
Example: Bad request
data object
Hata ayrıntıları. Çoğu hatada boş dizidir; doğrulama hatasında errors nesnesini taşır.
oneOf
MOD1
Array [
]
MOD2
object

Example (auto)

{
  "success": false,
  "errorCode": 120,
  "message": "Bad request",
  "data": [
    null
  ]
}

Example

{
  "success": false,
  "errorCode": 112,
  "message": "Api Error",
  "data": []
}

429

Çok fazla istek gönderildi.

application/json

Schema

Schema

successboolean
Example: false
errorCodeinteger
Hata kodu (bkz. Hata kodları).
Example: 120
messagestring
Example: Bad request
data object
Hata ayrıntıları. Çoğu hatada boş dizidir; doğrulama hatasında errors nesnesini taşır.
oneOf
MOD1
Array [
]
MOD2
object

Example (auto)

{
  "success": false,
  "errorCode": 120,
  "message": "Bad request",
  "data": [
    null
  ]
}

Example

{
  "success": false,
  "errorCode": 150,
  "message": "Too many requests.",
  "data": []
}

500

Beklenmeyen bir hata oluştu.

application/json

Schema

Schema

successboolean
Example: false
errorCodeinteger
Hata kodu (bkz. Hata kodları).
Example: 120
messagestring
Example: Bad request
data object
Hata ayrıntıları. Çoğu hatada boş dizidir; doğrulama hatasında errors nesnesini taşır.
oneOf
MOD1
Array [
]
MOD2
object

Example (auto)

{
  "success": false,
  "errorCode": 120,
  "message": "Bad request",
  "data": [
    null
  ]
}

Example

{
  "success": false,
  "errorCode": 110,
  "message": "Server Error",
  "data": []
}

Örnek istek

curl -X POST 'https://ext-api.netgsm.com.tr/iys/v1/consents' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "brandCode": 123456,
  "path": "SMSAPI",
  "refId": "40e6215d-b5c6-4896-987c-f30f3678f608",
  "permissions": [
    {
      "recipient": "+905554443322",
      "recipientType": "BIREYSEL",
      "type": "ARAMA",
      "source": "HS_FIZIKSEL_ORTAM",
      "status": "ONAY",
      "consentDate": "2026-02-20 16:46:00",
      "retailerCode": 0,
      "retailerAccess": [
        0,
        1
      ]
    }
  ]
}'