Genel Bakış

Vatansms.Net SMS API, kullanıcıların sms ile çeşitli işlemleri gerçekleştirmelerini sağlayan kapsamlı bir araçtır. Bu API, işletmelerin ve geliştiricilerin sms entegrasyonlarını kolaylaştırarak, müşteri iletişimini ve operasyonel verimliliği artırmalarına olanak tanır.

API, kullanıcılara aşağıdaki başlıca özellikleri sunar:

Mesaj Gönderme: SMS API ile bireysel veya ticari sms gönderimi yapabilirsiniz.
Gönderici Bilgileri:VatanSMS.Net üzerinde tanımlı gönderici başlıklarınızın bilgilerini alabilirsiniz.
Rapor Yönetimi: Her sms sonucunun iletilip iletilmediği hakkında veri alabilirsiniz.

Bu dokümantasyon, API'nin nasıl kullanılacağını ve her bir uç noktanın işlevselliğini detaylandırmaktadır. Tüm API istekleri, güvenli bir şekilde kimlik doğrulama bilgileri ile yapılmalıdır.

Kimlik Doğrulama

Vatansms.Net SMS API'ye erişim sağlamak için her bir istekte aşağıdaki bilgiler istek içeriğinde kullanılmalıdır:

api_id: API erişim numaranızdır. Bu numara, size özel olarak sağlanır ve API'ye yapılan isteklerde kimliğinizi doğrulamak için kullanılır.
api_key: API erişim gizli anahtarınız. Bu anahtar, API'ye yapılan isteklerin güvenliğini sağlamak için kullanılır ve gizli tutulmalıdır.

Hesabım - API Bilgilerimi Görüntüle kısmından api_id ve api_key bilgilerinize ulaşabilirsiniz.

Bu kimlik doğrulama bilgileri, API'nin güvenliğini ve yetkilendirilmiş erişimini sağlamak için kritik öneme sahiptir. Bu nedenle, bu bilgileri güvenli bir şekilde saklamalı ve yetkisiz kişilerle paylaşmamalısınız.

Eğer api_id veya api_key bilgileriniz kaybolursa veya yetkisiz erişimden şüpheleniyorsanız, derhal Vatansms.Net destek ekibi ile iletişime geçmelisiniz.

1 - N SMS Gönder

1 - N SMS gönderiminde, bir gönderici adı ve mesaj metni kullanarak birden fazla telefona SMS gönderilir. Türkçe SMS gönderimi için message_type parametresi 'turkce' olarak belirlenmelidir. İleri tarihli SMS göndermek için send_time parametresi eklenebilir.

URL:

POST /1toN

İstek Gövdesi (JSON):

Parametre	Tür	Örnek Değer	Açıklama
api_id	string	'API_ID'	API kimlik bilgisi
api_key	string	'API_KEY'	API anahtar bilgisi
sender	string	'SMSBASLIGINIZ'	Hesabınıza tanımlanmış gönderici adı
message_type	string	'normal'	Mesaj türü ('normal' veya 'turkce')
message	string	'Bu bir test mesajıdır.'	Gönderilecek mesaj metni
message_content_type	string	'bilgi'	Mesaj içerik türü ('bilgi' veya 'ticari')
phones	array of strings	['5xxxxxxxxx', '5xxxxxxxxx']	Mesajın gönderileceği telefon numaraları
send_time (opsiyonel)	string	'2021-05-25 12:00:00'	İleri tarihli SMS gönderim zamanı (Y-m-d H:i formatında)

Örnek Gövde (JSON):

                                                                                    

{
  "api_id": "API_ID",
  "api_key": "API_KEY",
  "sender": "SMSBASLIGINIZ",
  "message_type": "normal",
  "message": "Bu bir test mesajıdır.",
  "message_content_type": "bilgi",
  "phones": [
    "5xxxxxxxxx",
    "5xxxxxxxxx"
  ]
}

N - N SMS Gönderimi

N - N SMS gönderiminde, her telefona özel mesajlar gönderilebilir. send_time parametresi eklenerek ileri tarihli SMS gönderimi yapılabilir.

URL:

POST /NtoN

İstek Gövdesi (JSON):

Parametre	Tür	Örnek Değer	Açıklama
api_id	string	'API_ID'	API kimlik bilgisi
api_key	string	'API_KEY'	API anahtar bilgisi
sender	string	'SMSBASLIGINIZ'	Hesabınıza tanımlanmış gönderici adı
message_type	string	'normal'	Mesaj türü ('normal' veya 'turkce')
message_content_type	string	'bilgi'	Mesaj içerik türü ('bilgi' veya 'ticari')
phones	array of objects	[{'phone': '5xxxxxxxxx', 'message': 'Bu bir test mesajıdır.'}, {'phone': '5xxxxxxxxx', 'message': 'Bu bir test mesajıdır.'}]	Mesajın gönderileceği telefon numaraları ve özel mesaj metinleri
send_time (opsiyonel)	string	'2021-05-19 15:33:00'	İleri tarihli SMS gönderim zamanı (Y-m-d H:i formatında)

Örnek Gövde (JSON):

                                                                                    

{
  "api_id": "API_ID",
  "api_key": "API_KEY",
  "sender": "SMSBASLIGINIZ",
  "message_type": "normal",
  "message_content_type": "bilgi",
  "phones": [
    {
      "phone": "5xxxxxxxxx",
      "message": "Bu bir test mesajıdır."
    },
    {
      "phone": "5xxxxxxxxx",
      "message": "Bu bir test mesajıdır."
    }
  ],
  "send_time": "2021-05-19 15:33:00"
}

Gönderici Adı Sorgulama

Bu endpoint, hesabınıza tanımlanmış gönderici adlarını sorgulamak için kullanılır.

URL:

POST /senders

İstek Gövdesi (JSON):

Parametre	Tür	Örnek Değer	Açıklama
api_id	string	'API_ID'	API kimlik bilgisi
api_key	string	'API_KEY'	API anahtar bilgisi

Örnek Body (JSON):

                                                                                    

{
  "api_id": "API_ID",
  "api_key": "API_KEY"
}

Kullanıcı Bilgilerini Alma

Bu endpoint, API kullanıcı bilgilerini almak için kullanılır.

URL:

POST /user/information

İstek Gövdesi (JSON):

Parametre	Tür	Örnek Değer	Açıklama
api_id	string	'API_ID'	API kimlik bilgisi
api_key	string	'API_KEY'	API anahtar bilgisi

Örnek Gövde (JSON):

                                                                                    

{
  "api_id": "API_ID",
  "api_key": "API_KEY"
}

Rapor Sorgulama - Rapor Detayı

Bu endpoint, belirli bir rapor ID'sine ait detaylı SMS gönderim raporunu almak için kullanılır. Sayfalama desteklidir ve sayfa boyutu özelleştirilebilir.

URL:

POST /report/detail?page=1&pageSize=20

İstek Gövdesi (JSON):

Parametre	Tür	Örnek Değer	Açıklama
api_id	string	'API_ID'	API kimlik bilgisi
api_key	string	'API_KEY'	API anahtar bilgisi
report_id	integer	926410	Rapor ID'si

Örnek Gövde (JSON):

                                                                                    

{
  "api_id": "API_ID",
  "api_key": "API_KEY",
  "report_id": 926410
}

Rapor Sorgulama - Tarih Bazlı

Bu endpoint, belirli bir tarih aralığına ait SMS gönderim raporunu almak için kullanılır.

URL:

POST /report/between

İstek Gövdesi (JSON):

Parametre	Tür	Örnek Değer	Açıklama
api_id	string	'API_ID'	API kimlik bilgisi
api_key	string	'API_KEY'	API anahtar bilgisi
start_date	string	'2021-05-17 11:22:00'	Başlangıç tarihi (Y-m-d H:i formatında)
end_date	string	'2021-05-18 11:31:00'	Bitiş tarihi (Y-m-d H:i formatında)

Örnek Gövde (JSON):

                                                                                    

{
  "api_id": "API_ID",
  "api_key": "API_KEY",
  "start_date": "2021-05-17 11:22:00",
  "end_date": "2021-05-18 11:31:00"
}

Rapor Sorgulama - Sonuç Sorgusu

Bu endpoint, belirli bir rapor ID'sine ait SMS gönderim sonuçlarını almak için kullanılır.

URL:

POST /report/single

İstek Gövdesi (JSON):

Parametre	Tür	Örnek Değer	Açıklama
api_id	string	'API_ID'	API kimlik bilgisi
api_key	string	'API_KEY'	API anahtar bilgisi
report_id	integer	926382	Rapor ID'si

Örnek Gövde (JSON):

                                                                                    

{
  "api_id": "API_ID",
  "api_key": "API_KEY",
  "report_id": 926382
}

İleri Tarihli SMS İptal

Bu endpoint, ileri tarihli SMS gönderimlerini iptal etmek için kullanılır.

URL:

POST /cancel/future-sms

İstek Gövdesi (JSON):

Parametre	Tür	Örnek Değer	Açıklama
api_id	string	'API_ID'	API kimlik bilgisi
api_key	string	'API_KEY'	API anahtar bilgisi
id	integer	xxx	İptal edilecek SMS'in rapor ID'si

Örnek Gövde (JSON):

                                                                                    

{
  "api_id": "API_ID",
  "api_key": "API_KEY",
  "id": xxx
}