İzin sorgulama

GET 
/consents

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

Bir ya da birden fazla alıcının İYS'deki izin durumunu sorgular.

Tekil sorgu: recipient, recipientType ve type alanlarını gönderin.

Çoklu sorgu: Kayıtları data dizisiyle, en fazla 1000 kayıt olacak şekilde gönderin:

GET /consents?brandCode=123456&data[0][recipient]=%2B905551112233&data[0][recipientType]=BIREYSEL&data[0][type]=MESAJ&data[1][recipient]=ornek@mail.com&data[1][recipientType]=BIREYSEL&data[1][type]=EPOSTA

• data içinde tek kayıt varsa tekil sorgu yapılır; yanıt tekil sorguyla aynıdır.
• Sonuçlar gönderilen kayıtlarla aynı sırada döner. Çoklu sorguda her kaydın kendi errorCode ve message alanı vardır: 0 başarılı, 81 kayıt bulunamadı, 120 hatalı istek, 112 İYS'den geçerli yanıt alınamadı. Hatalı kayıtta sorgulanan alanlar korunur.
• İsteğin tamamını etkileyen bir hata (örneğin geçersiz brandCode) isteği 400 ile sonlandırır.
• Kayıtlar adres satırında taşındığı için çok sayıda kayıtta URL uzunluk sınırına dikkat etmelisiniz.

Request

Query Parameters

brandCode integerrequired

Possible values: >= 1 and <= 2147483647

İYS marka kodu.

path IysPath

Possible values: [SANTRAL, SMSAPI, WEBPORTAL]

Gönderilmezse SMSAPI kabul edilir.

refId string

Possible values: non-empty and <= 255 characters

İsteğe eklediğiniz referans değeri. Çoklu sorguda data[i][refId] gönderilmeyen kayıtlar için kullanılır.

recipient string

Telefon numarası (+90XXXXXXXXXX) ya da e-posta adresi. data gönderilmiyorsa zorunludur.

recipientType RecipientType

Possible values: [BIREYSEL, TACIR]

Alıcı tipi. data gönderilmiyorsa zorunludur.

type ConsentType

Possible values: [ARAMA, MESAJ, EPOSTA]

İzin tipi. data gönderilmiyorsa zorunludur.

data object[]

Possible values: >= 1, <= 1000

Çoklu sorgu kayıtları, en fazla 1000. Her kayıtta recipient, recipientType ve type zorunludur.

Responses

200

Sorgu tamamlandı.

application/json

Schema

Schema

successboolean
Example: true
errorCodeinteger
Example: 0
messagestring
Example: success
data object[]
Array [
typestringnullable
Example: MESAJ
sourcestringnullable
Example: HS_MESAJ
recipientstring
Example: +905555555555
statusstringnullable
Example: ONAY
consentDatestringnullable
Example: 2020-07-09 17:20:00
recipientTypestring
Example: BIREYSEL
creationDatestringnullable
queryStatusstringnullable
Example: failure
retailerAccessCountintegernullable
Yalnızca çoklu sorguda.
errorCodeinteger
Yalnızca çoklu sorguda: 0 başarılı, 81 kayıt bulunamadı, 120 hatalı istek, 112 İYS'den geçerli yanıt alınamadı.
Example: 0
messagestringnullable
Yalnızca çoklu sorguda, kaydın hata mesajı.
]

Example (auto)

{
  "success": true,
  "errorCode": 0,
  "message": "success",
  "data": [
    {
      "type": "MESAJ",
      "source": "HS_MESAJ",
      "recipient": "+905555555555",
      "status": "ONAY",
      "consentDate": "2020-07-09 17:20:00",
      "recipientType": "BIREYSEL",
      "creationDate": "string",
      "queryStatus": "failure",
      "retailerAccessCount": 0,
      "errorCode": 0,
      "message": "string"
    }
  ]
}

single

Tekil sorgu

{
  "success": true,
  "errorCode": 0,
  "message": "success",
  "data": [
    {
      "type": "MESAJ",
      "source": "HS_MESAJ",
      "recipient": "+905555555555",
      "status": "ONAY",
      "consentDate": "2020-07-09 17:20:00",
      "recipientType": "BIREYSEL",
      "creationDate": null,
      "queryStatus": "failure"
    }
  ]
}

bulk

Çoklu sorgu

{
  "success": true,
  "errorCode": 0,
  "message": "success",
  "data": [
    {
      "type": "MESAJ",
      "source": "HS_WEB",
      "recipient": "+905551112233",
      "status": "ONAY",
      "consentDate": "2026-01-01 10:00:00",
      "recipientType": "BIREYSEL",
      "creationDate": null,
      "queryStatus": null,
      "retailerAccessCount": null,
      "errorCode": 0,
      "message": null
    },
    {
      "type": "EPOSTA",
      "source": null,
      "recipient": "ornek@mail.com",
      "status": null,
      "consentDate": null,
      "recipientType": "BIREYSEL",
      "creationDate": null,
      "queryStatus": null,
      "retailerAccessCount": null,
      "errorCode": 81,
      "message": "Resource not found"
    }
  ]
}

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 GET 'https://ext-api.netgsm.com.tr/iys/v1/consents?brandCode=123456&path=SMSAPI&refId=40e6215d-b5c6-4896-987c-f30f3678f608&recipient=%2B905554443322&recipientType=BIREYSEL&type=MESAJ' \
  -H 'Authorization: Bearer <token>'