Ana içeriğe geç

JSON Post API

Uyarı

Bu API methodu geliştirme aşamasındadır, üstünde değişiklikler olabilir. API methoduna erişim için lütfen müşteri temsilciniz ile iletişime geçiniz.

Rehberinizde var olan kişi veya kişileri, HTTP protokolünün POST methodunu kullanarak, XML formatında belirtmiş olduğunuz gruptan çıkarmak için, aşağıdaki yönergeleri takip edebilirsiniz.

İstek yapılacak adres​

POSThttps://api.iletimerkezi.com/v1/unsubscribe-group/json

İstek İçeriği (Body)​

Eğer kullanıcı adı ve şifre kullanılarak işlem yapıyorsanız isteğin içeriği
{
  "request": {
    "authentication": {
      "username": "",
      "password": ""
    },
    "contact": [
      {"id": ""}
    ],
    "group": [
      {"id": ""}
    ]
  },
}
Eğer API Anahtarı kullanılarak işlem yapıyorsanız isteğin içeriği
{
  "request": {
    "authentication": {
      "key": "",
      "hash": ""
    },
    "contact": [
      {"id": ""}
    ],
    "group": [
      {"id": ""}
    ]
  },
}

Tanımlar​

Sunucuya yapılacak olan istek request etiketi ile sarmalanmalıdır. Bu etiketin alt etiketlerinin tanımları aşağıdaki gibidir:

authentication​

İstek yapılan işleme dair yetki alabilmek için gönderilmesi gereken kullanıcı bilgileridir. Alt etiketleri aşağıdaki gibidir:

  • username: iletimerkezi.com'a giriş yaparken kullanılan kullanıcı adıdır. Üye olurken kullanmış olduğunuz, cep telefonu numarasıdır. İstek yapılırken gönderilmesi zorunludur.
  • password: iletimerkezi.com'a giriş yaparken kullanılan şifredir. İstek yapılırken gönderilmesi zorunludur.

contact​

Gruptan çıkarılacak, kişilerin bilgisini içerir. Alt etiketleri aşağıdaki gibidir.

  • id: Kişiyi temsil benzersiz nümerik id değeri.

group​

Kişilerin çıkarılacağı grubu ifade eder. Alt etiketi aşağıdaki gibidir.

  • id: Grubu temsil eden benzersiz nümerik id değeri.

Sunucu yanıtı​

{
  "response": {
    "status": {
      "code": "",
      "message": ""
    }
  }
}

Tanımlar​

Sunucudan gelen yanıt her zaman response etiketi ile sarmalanmıştır. Bu etiketin alt etiketlerinin tanımı aşağıdaki gibidir:

status​

İşlem durumu ile ilgili bilgi içerir. Bu etiket ile döndürülen değerler aynı zamanda HTTP yanıtının başlık bilgisine bakılarak da elde edilebilir. Bu etiket, yapılan her istekte standart olarak döndürülür. Alt etiketleri aşağıdaki gibidir

  • code: İşlem durumunu belirten numerik değerdir.
  • message: İşlem durumu hakkında bilgi mesajı içerir.