API Destek Dökümanı

  • API ile SMS göndermeye başlamadan önce sisteme üye olmalı ve authenticationToken değerini profil sayfanızdan öğrenmelisiniz.

  • Daha sonra:

    • Mesaj başlığı tanımlamalı ve mesaj başlığının onaylanmasını beklemelisiniz.
    • SMS göndermeden önce kredi yüklemeli ve en az gerçekleştireceğiniz gönderim için gerekli kredi miktarına sahip olmalısınız.

  • 1 mesajı N kişiye ve N mesajı N kişiye göndermek için farklı gereksinimler olduğuna dikkat ediniz.

  • SMS göndermek istediğiniz numaraların her birinin "05123456789" formatında 11 karakter uzunluğunda olduğundan emin olunuz.

  • Her 155 karakter bir mesaj boyu olarak değerlendirilir. Türkçe karakterler 2 karakter olarak hesaplanır.

    • SMS gönderimlerinde "ğ", "Ğ", "ş", "Ş", "ı", "İ", "ç" karakterleri Türkçe karakterlerdir ve çift karakter sayılırlar. Bunların dışındakiler tek karakter sayılır.

    • Mesela "ÖzTürkçe" kelimesini inceleyelim.
      Her bir SMS 155 karakter uzunluğundadır.
      Ö yazdık. --> Ö --> Türkçe değil -->Kalan karakter (155-1) 154
      Öz yazdık. --> z --> Türkçe değil -->Kalan karakter (154-1) 153
      ÖzT yazdık. --> T --> Türkçe değil -->Kalan karakter (153-1) 152
      ÖzTü yazdık.--> ü --> Türkçe değil -->Kalan karakter (152-1) 151
      ÖzTür yazdık. --> r --> Türkçe değil -->Kalan karakter (151-1) 150
      ÖzTürk yazdık. --> k --> Türkçe değil -->Kalan karakter (150-1) 149
      ÖzTürkç yazdık. --> ç --> Türkçe -->Kalan karakter (149-2) 147
      ÖzTürkçe yazdık. --> e --> Türkçe değil -->Kalan karakter (147-1) 146
      Yukarıda görüldüğü gibi eğer kelimede türkçe karakter içeren bir harf yer alıyorsa hesaplamada 2 karakter harcar.
      77 tane "ç" harfinin olduğu bir mesaj için her bir ç harfi 2 karakter harcar 2x77=154 [ boy=1 ] yani bundan sonra yazılan herhangi bir türkçe karakter 154+2=156 [ boy=2 ]
      Şeklinde hesaplanır.

1 veya 1den çok kullanıcıya aynı SMS metnini göndermek için bu servisi kullanmalısınız. Örneğin: bir kampanya hakkında bilgilendirme yapmak amacıyla gönderilen SMS'ler geneldir. Her kullanıcıya aynı SMS metni iletilmelidir.

URL:

https://gustosms.com/apiservice/sendSms1xN

Tip:

POST

Parametreler:

Parametre Adı Parametre Tipi Açıklama Örnek Değer
authenticationToken String

Profil sayfanızdan ulaşabileceğiniz üyelik bilgilerinizi içeren parametredir.

Profil sayfanıza gitmek için tıklayın.

Profil sayfanızdan görüntüleyebilirsiniz.
messageHeader String (Max: 11 karakter)

Bu gönderim için kullanmak istediğiniz mesaj başlığınızın ismi. Mesaj Başlıkları menüsünde tanımlı ve onaylı olmalıdır.

Mesaj başlıklarınızı görmek için tıklayın.

"GUSTOSMS"
message String (Max: 917 karakter) Kişilerinize göndermek istediğiniz mesajın içeriği. "Merhaba, GustoSMS olarak mobil dünyadaki bilgi ve deneyimlerimizle sizlere kusursuz bir hizmet sunmak için çalışıyoruz..."
receivers Json Object

Mesajı göndermek istediğiniz telefon numaralarını içeren String tipinde Dizi.

Her bir numara 11 karakter uzunluğunda "05123456789" formatında olmalıdır. Bunun dışında ki numaralara gönderim gerçekleşmeyecektir.

05123456789,05234567890
sendDateType String("Hemen" yada "Sonra" olabilir. Diğer tüm durumlarda hata mesajı döner.)

Mesajın gönderileceği zaman tipidir. Bir mesaj hemen veya daha sonra gönderilebilir.

"Hemen" ise mesajlar istek alındığı anda gönderilmeye başlanır, "Sonra" ise sendStartDate tarihinde gönderilir.

"Hemen"
sendStartDate String

"Sonra" tipinde gönderimlerde gereklidir. Mesajın gönderilmeye başlanacağı tarihi içerir. year, month, day, hour, minute değerlerini içermelidir. Değerlerin her biri integer tipinde olmalıdır.

Örnek kısmında 17.08.2018 tarihi 11:50 saati için örnek verilmiştir.

2017-03-20 15:03:17
sendStopDate String

Mesajın geçerliliğinin biteceği saat ve dakikayı içerir. hour, minute değerlerini içermelidir. Değerlerin her biri integer tipinde olmalıdır.

Örneğin, akşam 19:00'da gerçekleşecek bir etkinlik hakkında bilgilendirme yapılan SMS'lerin saat 19:00'dan sonra gönderilmesi istenmez.

2017-03-20 23:00:10

Örnek Gönderim Şablonu (PHP CURL ile post örneği aşağıda verilmiştir...):

Örnek Sonuç Objesi:

"Hemen" tipinde gönderimler için:

"Sonra" tipinde gönderimler için:

Hata Durumları:

Eğer dönen sonuçta "error" parametresi varsa gönderilen veri hatalıdır. Hatalı sonuç objesi örneği:



Hata Mesajı Hangi Durumlarda Alınacağı
{ error : 'invalidData' } Gönderilen obje hatalı veya obje yok.
{ error : 'invalidData_authenticationToken' } authenticationToken bilgisi yok, authenticationToken hatalı girilmiş veya belirtilen kullanıcı bulunamadı.
{ error : 'invalidData_blockedUser' } Kullanıcı hesabı onaylı değil. Engelli kullanıcı.
{ error : 'invalidData_messageHeader' } Mesaj başlığı bilgisi eksik-hatalı, Mesaj başlığı sistemde kayıtlı değil, Mesaj başlığı onaylı değil.
{ error : 'invalidData_message' } Mesaj metni bilgisi eksik-hatalı, Girilen mesaj metni uzunluğu 917 karakterden uzun.
{ error : 'invalidData_receivers' } Receivers array'i eksik-hatalı veya doğru girilmiş hiçbir telefon numarası yok.
{ error : 'invalidData_sendDateType' } Gönderim zamanı tipi bilgisi eksik-hatalı veya "Hemen" ve "Sonra" değerlerinden farklı bir değer girilmiş.
{ error : 'invalidData_sendStartDate' } Gönderim tipi "Sonra" iken; Gönderim başlangıç zamanı bilgisi eksik-hatalı veya year, month, day, hour, minute değerlerinden en az biri hatalı girilmiş.
{ error : 'invalidData_sendStopDate' } Gönderim bitiş zamanı bilgisi eksik-hatalı veya hour, minute değerlerinden en az biri hatalı girilmiş.
{ error : 'creditNotEnough' } Bu gönderimi gerçekleştirmek için yeterli krediniz yok. Sistem üzerinden kredi yüklemeniz gerekmektedir.

N tane kullanıcının her birine farklı bir SMS metni göndermek için bu servisi kullanmalısınız. Örneğin: kullanıcıların isimlerini içeren mesajlar özeldir. Ve her kullanıcıya farklı bir metin gönderilmelidir.

URL:

http://gustosms.com/apiservice/sendSmsNxN

Tip:

POST

Parametreler:

Parametre Adı Parametre Tipi Açıklama Örnek Değer
authenticationToken String

Profil sayfanızdan ulaşabileceğiniz üyelik bilgilerinizi içeren parametredir.

Profil sayfanıza gitmek için tıklayın.

Profil sayfanızdan görüntüleyebilirsiniz.
messageHeader String (Max: 11 karakter)

Bu gönderim için kullanmak istediğiniz mesaj başlığınızın ismi. Mesaj Başlıkları menüsünde tanımlı ve onaylı olmalıdır.

Mesaj başlıklarınızı görmek için tıklayın.

"GUSTOSMS"
receivers Object Array

Mesajı göndermek istediğiniz kullanıcı objelerini içeren Object tipinde Dizi.

Her obje sağda ki örnekte gösterildiği yapıda cellPhone ve message parametrelerini içermelidir.

Her bir numara 11 karakter uzunluğunda "05123456789" formatında olmalıdır. Bunun dışında ki numaralara gönderim gerçekleşmeyecektir.

Her bir mesaj maksimum 917 karakter uzunluğunda olabilir. Bunun dışında ki mesajlar errorReceiverCount'a eklenerek hatalı olarak dönecektir.

[{"cellPhone": "05001234567","message": "Bu kişiye özel mesaj1."},{"cellPhone": "05001234568","message": "Bu kişiye özel başka bir mesaj2."}]
sendDateType String("Hemen" yada "Sonra" olabilir. Diğer tüm durumlarda hata mesajı döner.)

Mesajın gönderileceği zaman tipidir. Bir mesaj hemen veya daha sonra gönderilebilir.

"Hemen" ise mesajlar istek alındığı anda gönderilmeye başlanır, "Sonra" ise sendStartDate tarihinde gönderilir.

"Hemen"
sendStartDate String

"Sonra" tipinde gönderimlerde gereklidir. Mesajın gönderilmeye başlanacağı tarihi içerir. year, month, day, hour, minute değerlerini içermelidir. Değerlerin her biri integer tipinde olmalıdır.

Örnek kısmında 17.08.2014 tarihi 11:50 saati için örnek verilmiştir.

2017-03-20 09:00:10
sendStopDate String

Mesajın geçerliliğinin biteceği saat ve dakikayı içerir. hour, minute değerlerini içermelidir.

Örneğin, akşam 19:00'da gerçekleşecek bir etkinlik hakkında bilgilendirme yapılan SMS'lerin saat 19:00'dan sonra gönderilmesi istenmez.

2017-03-20 23:00:10

Örnek Gönderim Şablonu:

Örnek Sonuç Objesi:

"Hemen" tipinde gönderimler için:

"sonra" tipinde gönderimler için:

Hata Durumları:

Eğer dönen sonuçta "error" parametresi varsa gönderilen veri hatalıdır. Hatalı sonuç objesi örneği:



Hata Mesajı Hangi Durumlarda Alınacağı
{ error : 'invalidData' } Gönderilen obje hatalı veya obje yok.
{ error : 'invalidData_authenticationToken' } authenticationToken bilgisi yok, authenticationToken hatalı girilmiş veya belirtilen kullanıcı bulunamadı.
{ error : 'invalidData_blockedUser' } Kullanıcı hesabı onaylı değil. Engelli kullanıcı.
{ error : 'invalidData_messageHeader' } Mesaj başlığı bilgisi eksik-hatalı, Mesaj başlığı sistemde kayıtlı değil, Mesaj başlığı onaylı değil.
{ error : 'invalidData_receivers' } Receivers array'i eksik-hatalı veya bilgileri doğru girilmiş hiçbir receiver objesi bulunamadı.
{ error : 'invalidData_sendDateType' } Gönderim zamanı tipi bilgisi eksik-hatalı veya "now" ve "later" değerlerinden farklı bir değer girilmiş.
{ error : 'invalidData_sendStartDate' } Gönderim tipi "later" iken; Gönderim başlangıç zamanı bilgisi eksik-hatalı veya year, month, day, hour, minute değerlerinden en az biri hatalı girilmiş.
{ error : 'invalidData_sendStopDate' } Gönderim bitiş zamanı bilgisi eksik-hatalı veya hour, minute değerlerinden en az biri hatalı girilmiş.
{ error : 'creditNotEnough' } Bu gönderimi gerçekleştirmek için yeterli krediniz yok. Sistem üzerinden kredi yüklemeniz gerekmektedir.

İleri tarihli smslerin iptali için bu servisi kullanmalısınız.

URL:

http://gustosms.com/apiservice/cancelSms

Tip:

POST

Parametreler:

Parametre Adı Parametre Tipi Açıklama Örnek Değer
authenticationToken String

Profil sayfanızdan ulaşabileceğiniz üyelik bilgilerinizi içeren parametredir.

Profil sayfanıza gitmek için tıklayın.

Profil sayfanızdan görüntüleyebilirsiniz.
smsID String

İptal etmek istediğiniz sms'e ait id.(Geri Dönüşlerde Sms Id si verilmektedir...)

"595a484bf62f5578a6000006"

Örnek Gönderim Şablonu:

Örnek Sonuç Objesi:

"Sonra" tipinde gönderimler için:

Hata Durumları:

Eğer dönen sonuçta "error" parametresi varsa gönderilen veri hatalıdır. Hatalı sonuç objesi örneği:
Hata Mesajı Hangi Durumlarda Alınacağı
{ error : 'invalidData' } Gönderilen obje hatalı veya obje yok.
{ error : 'invalidData_authenticationToken' } authenticationToken bilgisi yok, authenticationToken hatalı girilmiş veya belirtilen kullanıcı bulunamadı.
{ error : 'invalidData_smsId' } Sms Id'si hatalı.
{ error : 'invalidData_smsIDNotFound' } Sms Id'si bulunamadı.