Ana içeriğe geç

XML 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 gruba dahil olması için, aşağıdaki yönergeleri takip edebilirsiniz.

İstek yapılacak adres

POSThttps://api.iletimerkezi.com/v1/subscribe-group

İstek İçeriği (Body)

Eğer API Anahtarı kullanılarak işlem yapıyorsanız isteğin içeriği
<request>
<authentication>
<key></key>
<hash></hash>
</authentication>
<contact>
<id></id>
</contact>
<group>
<id></id>
</group>
</request>

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:

  • key: iletimerkezi.com panelinize giriş yaptıktan sonra ayarlar bölümünden oluşturabileceğiniz API Anahtar bu alana yazılmalıdır. İstek yapılırken gönderilmesi zorunludur.

  • hash: iletimerkezi.com panelinize giriş yaptıktan sonra ayarlar bölümünden oluşturabileceğiniz API Anahtar ve Gizli Anahtar kullanılarak oluşturulmuş hash bu alana yazılmalıdır. İstek yapılırken gönderilmesi zorunludur.

contact

Gruba atanıcak, kişilerin bilgisini içerir. Alt etiketleri aşağıdaki gibidir.

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

group

Kişilerin ekleneceği 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></code>
<message></message>
</status>
</response>

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.