Yanıt Yapısı
Organik API, verdiği yanıtların tipini belirlemenize olanak sağlar. İstek Yapısı bölümünde anlatılan bilgiler doğrultusunda API'nin verdiği yanıt bloğu ve içeriği, tip bazlı olarak aşağıda anlatılmıştır.
-
Response Headers:
Form Data:Method: POST Status: 200 OKHost: organikapi.comContent-Type: application/json{ "response": { "result": Boolean, "data": {
... }, "error": { "message": String, "number": String, "time": Date, "code": Int } } } -
Response Headers:
Form Data:Method: POST Status: 200 OKHost: organikapi.comContent-Type: application/xml<?xml version="1.0" encoding="UTF-8"?> <response> <result>Int</result> <data>
... </data> <error> <message>String</message> <number>String</number> <time>Date</time> <code>Int</code> </error> </response>
Node | Tip | Açıklama |
response |
Node | Yanıt gövdesinin ilk elemanıdır. |
result |
Boolean / Int | Yanıt işleminin durumunu belirtir. |
data |
Node | Yanıt işleminin içeriğini barındırır. API'den talep edilen işleme göre içeriği değişir. Ancak API'den dönen tüm reel veriler bu bölüm içinde sunulur. Başarısız işlemlerin yanıt gövdesinde yer almaz. |
error |
Node | Bu bölüm sadece başarısız işlemlerde gönderilir. Hata mesajı, numarası, kodu ve zamanı bilgilerini içerir. Hata kodları ve anlamlarını Hata Kodları bölümünde bulabilirsiniz. |
Organik API'yi kullanarak SMS gönderimi yapabilmeniz için aboneliğinizin olması gerekmektedir. Eğer aboneliğiniz yoksa buraya tıklayarak ücretsiz aboneliğinizi hızlı bir şekilde başlatabilirsiniz.