Public
Documentation Settings

CORVASS SMS API

SMS JSON API

Bu API, JSON belgeleriyle çalışan yazılım geliştiricilerin, uygulamalarına SMS gönderimini JSON üzerinden entegre etmelerini sağlamak amacıyla geliştirilmiştir.

Firma Bilgileri

Aşağıda yer alana ifadeler API ve Gizli Anahtar koduna göre firmanın bilgilerini verir. Kullanıcı bilgilerini müşteri hesabınız ile http://client.corvass.net ‘e giriş yaparak tanımlar menüsü altından API Key menüsünü kullanarak oluşturacağınız API key, ve API Secret bilgilerini kullanmanız gerekmektedir.

POSTFirma Bilgileri Sorgulama

http://sms.corvass.net/json

Request JSON

Plain Text
{
    "Authentication": {
        "apikey": "{{apikey}}",
        "apisecret": "{{apisecret}}"
    }
}
NodeKeyAçıklama
AuthenticationFirma hesabına ait authentication bilgilerinin gönderildiği node bilgisidir.
apikeyCorvass SMS hesabında tanımlı api key bilgisini ifade etmektedir.
apisecretSMS api key'e ait api secret bilgisini ifade eder.

Response JSON

Plain Text
{
    "Response": {
        "code": 0,
        "description": ""
    },
    "Company": {
        "companycode": "corvassnet",
        "vendorcode": "34001",
        "name": "Corvass.NET "
    },
    "Credit": 5286,
    "ExpireDate": "10.09.2021 16:08",
    "Originators": [
        "CORVASS.NET",
        "Corvass.NET",
        "Corvass"
    ] }
NodeKeyAçıklama
ResponseYapılan talebe ait durum bilgisine ait node bilgisidir
code0 – Başarılı işlem Diğer – Bkz hata kodları
descriptionİşlem açıklama alanıdır.
CompanyFirma bilgilerinin yer aldığı node.
companycodeFirma adına tanımlı companycode bilgisi
vendorcodeFirmanın bağlı olduğu bayi / iş ortaklığı kanalını belirtir
nameFirmanın corvass üzerinde tanımlı olduğu firma adı bilgisidir.
CreditHesaptaki mevcut kredi miktarı
ExpireDateHesaptaki kredilerin zaman aşımına uğrama tarihidir (dd.MM.yyyy HH:mm) formatındadır.
OriginatorsMüşteri hesabına tanımlı SMS originator bilgileridir.
Bodyraw
{
  "Authentication": {
    "apikey": "",
    "apisecret": ""
  }
}
Example Request
curl
curl --location 'http://sms.corvass.net/json' \
--data '{
  "Authentication": {
    "apikey": "",
    "apisecret": ""
  }
}'
200 OK
Example Response
json
{
  "Response": {
    "code": 0,
    "description": "Başarılı İşlem"
  },
  "Company": {
    "companycode": "corvasstest",
    "vendorcode": "34004",
    "name": "Test Corvass Son Kullanıcı"
  },
  "Credit": 98,
  "ExpireDate": "05.10.2022 09:15",
  "Originators": [
    "CORVASSTEST"
  ]
}
Content-Type

application/json;charset=UTF-8

Content-Length

232

Date

Tue, 28 Sep 2021 06:25:12 GMT

Mesaj Gönderimi

POSTSMS To Many

http://sms.corvass.net/json

SMS To Many ifadesi, aynı mesajı birden çok GSM numarasına gönderebilmek için kullanılır. Burada önerilen SMS paketi boyutu 100.000 adettir. Örnekler;

Request JSON

Plain Text
{
    "Authentication": {
        "apikey": "{{apikey}}",
        "apisecret": "{{apisecret}}"
    }
    "message": "Mesaj metni",
    "msisdnArray": ["53xxxxxxxx", "05xxxxxxxxx", "905xxxxxxxxx"],

    "originator": "Corvass.NET",
    "senddate": "2021-10-01 00:00:00",
    "tags": ["kirtasiye", "indirim", "gönderim", "sms"],
    "description": "",
    “messageType”:{B veya R},
    “recipientType”:{TACIR veya BIREYSEL}}
NodeKeyAçıklama
AuthenticationFirma hesabına ait authentication bilgilerinin gönderildiği node bilgisidir.
apikeyCorvass SMS hesabında tanımlı api key bilgisini ifade etmektedir
apisecretSMS api key'e ait api secret bilgisini ifade eder
messageGönderilecek mesaj metni
msisdnArrayMesajın gönderileceği GSM numaraları
originatorGönderim yapılacak alfanumerik bilgisidir, Boş bırakıldığında hesapta tanımlı ilk alfanumerik bilgisi ile sms gönderimi gerçekleştirilir.
senddateMesajın gönderilme tarihidir, boş bırakılması durumunda mesaj hemen iletilecektir geçerli tarih formatı (yyyy-MM-dd HH:mm)dir
tagsGönderilen mesaj pakete ait etiketler, raporlama amaçlı kullanılmaktadır.
descriptionGönderilen mesaj metnine ait açıklama bilgisidir.
MessageTypeRecipientType
Gönderilecek mesajın tipi,Bilgilendirme mesajları için B veya Bilgilendirme Reklam mesajları için R veya ReklamAlıcı tipi, kampanya mesajı gönderildiğinde zorunlu alan, TACIR / BIREYSEL değerleri alır.

Response JSON

Plain Text
{
    "Response": {
        "code": 0,
        "description": ""
    },
    "PacketId": 104
}
NodeKeyAçıklama
ResponseYapılan talebe ait durum bilgisine ait node bilgisidir
code0 – Başarılı işlem Diğer – Bkz hata kodları
descriptionİşlem açıklama alanıdır.
PacketIdGönderime ait talep Id bilgisidir.
Bodyraw (json)
json
   {
    "Authentication": {
        "apikey": "",
        "apisecret": ""
    },
    "message": "Mesaj metni",
    "msisdnArray": ["5xxxxxxxxx", "5xxxxxxxxxx"],
 
    "originator": "Corvass.NET",
    "senddate": "",
    "tags": ["kirtasiye", "indirim", "gönderim", "sms"],
    "description": "",
    "messageType": "B",
    "recipientType": ""
   }
Example Request
curl
curl --location 'http://sms.corvass.net/json' \
--data '   {
    "Authentication": {
        "apikey": "",
        "apisecret": ""
    },
    "message": "Mesaj metni",
    "msisdnArray": ["5xxxxxxxxx", "5xxxxxxxxxx"],
 
    "originator": "Corvass.NET",
    "senddate": "",
    "tags": ["kirtasiye", "indirim", "gönderim", "sms"],
    "description": "",
    "messageType": "B",
    "recipientType": ""
   }'
200 OK
Example Response
json
{
  "Response": {
    "code": 0,
    "description": "Başarılı İşlem"
  },
  "PacketId": 71865894
}
Content-Type

application/json;charset=UTF-8

Content-Length

79

Date

Mon, 27 Sep 2021 12:53:13 GMT