Version: 3.0

Netgsm SMS API

Bu API ile SMS gönderebilir, iletim raporlarını takip edebilir ve size gelen SMS'leri okuyabilirsiniz.

Kimlik doğrulama

Her isteğe Authorization: Bearer <token> başlığını eklemelisiniz. Token'ı Netgsm Authorization API'nin POST https://ext-api.netgsm.com.tr/auth/v3/token ucundan, kullanıcı adınız ve şifrenizle alırsınız. SMS API için token alırken scope olarak sms göndermelisiniz:

{
  "username": "312XXXXXXX",
  "password": "XXXXXXX",
  "scope": "sms"
}

Token her şeyden önce kontrol edilir; token yoksa ya da geçersizse istek ne olursa olsun 401 döner.

İstek ve yanıt biçimi

• Gövdeler JSON'dur: Content-Type: application/json.
• Gövdeyi sıkıştırmadan göndermelisiniz (Content-Encoding yalnızca identity olabilir).
• Bir istek gövdesi en fazla 500 MB olabilir.
• Yanıtlarda tüm alanlar her zaman bulunur; değeri olmayan bir alan null olarak gönderilir. Tek istisna hata yanıtındaki rejectedItems ve rejectedItemsTruncated alanlarıdır; bunlar yalnızca NO_DELIVERABLE_MESSAGES hatasında bulunur.
• Tarih ve saatler saat dilimiyle birlikte ISO-8601 biçimindedir, örneğin 2026-09-10T09:00:00+03:00.

Hatalar

Hatalar her zaman aynı ApiError yapısıyla döner. Destek ekibine yazarken yanıttaki requestId değerini paylaşmanız, isteğinizi kayıtlarda hızlıca bulmamızı sağlar.

Her uç noktada karşılaşabileceğiniz genel hatalar:

Durum	Kod	Ne zaman
401	UNAUTHENTICATED	Token yok veya geçersiz.
404	NOT_FOUND	Adres yok.
405	INVALID_REQUEST	Adres bu metodu desteklemiyor. Desteklenen metotlar Allow başlığındadır.
406	—	Accept başlığı JSON'u kabul etmiyor. Bu yanıtın gövdesi yoktur.
413	INVALID_REQUEST	Gövde 500 MB'ı aşıyor.
415	INVALID_REQUEST	Gövde JSON değil ya da sıkıştırılmış.
503	SERVICE_UNAVAILABLE	Servis isteği şu anda kabul edemiyor; isteği biraz sonra tekrar gönderebilirsiniz.

Sunucu adresleri

Ortam	Adres
Canlı ortam	https://ext-api.netgsm.com.tr/sms/v3

Authentication

HTTP: Bearer Auth

Bearer erişim token'ı. Herhangi bir gövde okunmadan önce kontrol edilir.

Security Scheme Type:	http
HTTP Authorization Scheme:	bearer