Gelişmiş SMS Gönderme
Toplu SMS gönderme işlemi
Organik API oluşturduğunuz gönderim görevlerindeki her bir numara için ayrı ayrı takip kodu oluşturur ve tüm gönderileri tek tek denetlemenize imkan sağlar. Aşağıda sıklıkla kullanabileceğiniz toplu SMS gönderme işlemlerine örnekleri bulabilirsiniz.
POST ile Toplu SMS Gönderme
POST HTTP/1.1
Örnek
İstekte Bulunma:
Organik API tek bir istek gövdesinde birden fazla ileti oluşturarak, bu iletilerde ayrı ayrı binlerce numaraya SMS göndermenize imkan verir. Yanıt gövdesinin içinde bulunan
API iletilerinize özellik atamalarını yaparken varsayılan olarak önce
Aşağıda örnek istek gövdeleri ve içindeki değişken ve nesnelerin anlamlarını anlatan tabloları bulabilirsiniz.
Örnek İstek Gövdeleri:
-
Request Headers:
Form Data:Method: POST Host: organikapi.comURL: /v2/ce136df4c9c92d1428e828aba07d3b05/sendsms/json/ Accept: application/json{ "data": { "global_options": { "track_id": "1234", "header": "ORGANIKHBR", "delivery_time": "2014-05-12 23:40", "timeout": 24, "message_format": 0, "report_url": "http://www.domain.com", "gsm_isUnique": 0, "commercial": 1, "recipient_type": "TACIR" }, "deliveries": [ { "options": { "track_id": "1235", "header": 3, "delivery_time": "2014-05-12 23:40", "timeout": 12, "message_format": 1, "report_url": "http://www.domain2.com", "commercial": 1, "recipient_type": "TACIR" }, "recipients": { "groups": [ 1, 2, 3 ], "gsms": [ 905301234567, 905301234568, 905301234569 ] }, "message": "QnUgYmlyIGRlbmVtZSBtZXNhasSxZMSxcg==" }, { "options": { "track_id": 1236, "header": "OHT3" }, "recipients": { "gsms": [ 905301234567 ] }, "message": "T3JnYW5payBIYWJlcmxlxZ9tZSBkZW5lbWUgbWV0bmlkaXIu==" } ] } }
-
Request Headers:
Form Data:Method: POST Host: organikapi.comURL: /v2/ce136df4c9c92d1428e828aba07d3b05/sendsms/xml/ Accept: application/xml<?xml version="1.0" encoding="UTF-8"?> <document> <data> <global_options> <delivery_time>2023-01-31 14:11</delivery_time> <header>ORGANIKHBR</header> <message_format>normal</message_format> <report_url>http://www.domain.com</report_url> <timeout>48</timeout> <track_id>897as6d8ygas07ad75a</track_id> <gsm_isUnique>0</gsm_isUnique> <commercial>1</commercial> <recipient_type>TACIR</recipient_type> </global_options> <deliveries> <options> <delivery_time>2023-01-31 14:11</delivery_time> <header>3</header> <message_format>1</message_format> <report_url>http://www.domain.com/report</report_url> <gsm_isUnique>0</gsm_isUnique> <timeout>24</timeout> <track_id>1235</track_id> <commercial>1</commercial> <recipient_type>TACIR</recipient_type> </options> <recipients> <gsms>905301234567</gsms> <gsms>905301234568</gsms> <gsms>905301234569</gsms> <groups>1</groups> <groups>2</groups> <groups>3</groups> </recipients> <message>QnUgYmlyIGRlbmVtZSBtZXNhasSxZMSxcg==</message> </deliveries> <deliveries> <options> <track_id>1223</track_id> </options> <recipients> <gsms>905301234569</gsms> </recipients> <message>T3JnYW5payBIYWJlcmxlxZ9tZSBkZW5lbWUgbWV0bmlkaXIu==</message> </deliveries> </data> </document>
Değişken | Gereklilik | Tip | Açıklama |
global_options |
Zorunlu | - | |
global_options.track_id |
Opsiyonel | Integer | İletinizin takibi için sizin belirleyeceğiniz ve benzersiz olması gereken parametredir. Bu takip numarası ile daha sonra kendi tarafınızda sorgulama yapabilir ya da rapor taleplerinizde görevin durumunu bu takip ID'si ile bulabilirsiniz. İletilerin |
global_options.header |
Opsiyonel | Değişken | Oluşturduğunuz gönderim görevindeki tüm iletilere atanacak "Gönderen Başlığı" parametresidir. Başlık ID'si ya da direkt başlığın adı olmalıdır. |
global_options.delivery_time |
Opsiyonel | Datetime | Gönderiminizin ileri bir tarihte yapılmasını istiyorsanız, istediğiniz tarihi bu parametreyle gönderebilirsiniz. Gönderdiğiniz tarih |
global_options.timeout |
Opsiyonel | Integer | İlgili SMS operatöre iletildikten sonra mesajın operatörden alıcıya iletilmek için en fazla ne kadar süre ile bekletileceğini belirlediğiniz değişkendir. |
global_options.message_format |
Opsiyonel | Integer | Gönderiminizin hangi karakter setleriyle yapılacağını belirler. |
global_options.report_url |
Opsiyonel | String | Gönderim görevinizin durumunda bir değişiklik olduğunda gönderim yaptığınız numarayla ilgili raporun gönderileceği |
global_options.gsm_isunique |
Zorunlu | 1 | Gönderim yaptığınız numaraların içinde tekrarlanan numaralar varsa bu numaralara da gönderim yapılıp yapılmayacağını belirleyen parametredir. 1 - olduğunda tekrarlanan numaraların sadece 1 tanesine gönderim yapılır, 0 - olduğunda ise tekrarlanan numaraların tümüne gönderim yapılır. Alacağı değer |
global_options.commercial |
Opsiyonel | Kullanıcı, İYS Üyesi: 1 İYS Üyesi Değil: 0 |
Gönderim içeriğinizin ticari olup olmadığını belirtmek amaçlı kullanılır. 0 ve 1 değeri alabilir. |
global_options.recipient_type |
Opsiyonel | BIREYSEL | Alıcı tipini gösteren bilgidir. Değerler: |
deliveries |
Zorunlu | - | İletilerinizi tanımladığınız bölümdür. |
deliveries.options |
Zorunlu | - | İçeriği yukarıda anlatılan |
deliveries.recipients |
Zorunlu | - | Gönderim yapmak istediğiniz numara ve/veya grupları belirlediğiniz bölümdür. |
deliveries.recipients.groups |
Değişken | Array | Kayıtlı gruplarınıza gönderim yapmak istiyorsanız, bir veya birden fazla grup ID değerini bu değişkene yazarak gönderim yapabilirsiniz (Örn: 1,2,3,4,...). Birden fazla grup ID'si yazdığınız durumlarda, ID değerlerinden geçersiz olanlar varsa gönderiminiz sadece geçerli ID'lere yapılır. |
deliveries.recipients.gsms |
Değişken | Array | Mesajınızın atılacağı numaraları belirlediğiniz değişkendir. , ile ayırarak birden fazla numara yazabilirsiniz (Örn: 905301234567,901234566,901234555,...). Bu değişkende belirttiğiniz virgül ile ayrılmış numaraların sınırlaması yoktur, n tane olabilir. |
deliveries.message |
Zorunlu | String | Gönderiminizin metnidir. |
Başarılı Yanıt:
-
Response Headers:
Reponse Body:Method: POST Status: 200 OKURL: /v2/ce136df4c9c92d1428e828aba07d3b05/sendsms/json/ Host: organikapi.comContent-Type: application/json{ "response": { "result": true, "data": { "deliveries": [{ "track_id": "", "transaction_id": 16502030, "valid": [ { "request_gsm": 5444444444, "gsm": 905445359675, "gsm_track_id": "16502030-4730-63032793", "tl_amount": 0, "sms_count": 1, "credit_amount": 1 }, { "request_gsm": 5444444445, "gsm": 905445359675, "gsm_track_id": "16502030-4730-70484559", "tl_amount": 0, "sms_count": 1, "credit_amount": 1 } ], "invalid": [ { "request_gsm": 5444444446, "gsm": 905444444446, "error": { "number": 110, "message": "The number is incorrect." } } ] }, { "track_id": 2525, "transaction_id": null, "error": { "number": 101, "message": "The SMS title is incorrect." }, "valid": [], "invalid": [] } ] } } }
-
Response Headers:
Method: POST Status: 200 OKURL: /v2/ce136df4c9c92d1428e828aba07d3b05/sendsms/xml/ Host: organikapi.comContent-Type: application/xml<?xml version="1.0" encoding="UTF-8"?> <response> <data> <result>1</result> <deliveries> <item> <track_id>2567</track_id> <transaction_id>16502030</transaction_id> <valid> <item> <request_gsm>5444444444</request_gsm> <gsm>905444444444</gsm> <gsm_track_id>16502030-4730-63032793</gsm_track_id> <tl_amount>0</tl_amount> <sms_count>1</sms_count> <credit_amount>1</credit_amount> </item> <item> <request_gsm>5444444445</request_gsm> <gsm>905444444445</gsm> <gsm_track_id>16587001-4730-70484559</gsm_track_id> <tl_amount>0</tl_amount> <sms_count>1</sms_count> <credit_amount>1</credit_amount> </item> <item> <track_id>2525</track_id> <error> <number>101</number> <message>The SMS title is incorrect.</message> </error> <valid /> <invalid /> </item> </valid> <invalid> <item> <request_gsm>5444444446</request_gsm> <gsm>4444</gsm> <error> <number>110</number> <message>The number is incorrect.</message> </error> </item> </invalid> </item> <item> <track_id>2526</track_id> <transaction_id /> <error> <number>101</number> <message>The SMS title is incorrect.</message> </error> <valid /> <invalid /> </item> </deliveries> </data> </response>
Node | Tip | Açıklama |
result |
Boolean / Int | Yanıt işleminin durumunu belirtir. |
data.valid |
Array | Gönderim görevinizdeki işleme alınan bütün GSM numaralarının detayları burada gönderilir. |
data.valid.gsm |
Integer | Gönderim yapılan GSM numarasıdır. |
data.valid.transaction_id |
Integer | Gönderim işleminin sistem tarafından otomatik oluşturulan benzersiz ID'sidir. Gönderim görevindeki her ileti ( |
data.valid.gsm_track_id |
String | Gönderim yapılan her numara için benzersiz olarak üretilen ID'dir. Bu veriyi raporlamalarınızda kullanabilirsiniz. |
data.valid.sms_count |
Integer | Gönderilen SMS'in kaç boy olduğu bilgisini verir. |
data.valid.sms_count |
Integer | Gönderilen SMS'in TL tutarı bilgisini verir. Yurtdışı numaralar TL bakiye ile gönderilir. |
data.invalid |
Array | Gönderim görevinizdeki işleme alınamayan bütün GSM numaralarının detayları burada gönderilir. İçeriği |