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.

Service URL :	http://sms.corvass.net/json
Test Service URL:	http://tsms.corvass.net/json

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}}"
    }
}

Node	Key	Açıklama
Authentication		Firma hesabına ait authentication bilgilerinin gönderildiği node bilgisidir.
apikey	Corvass SMS hesabında tanımlı api key bilgisini ifade etmektedir.
apisecret	SMS 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"
    ] }

Node	Key	Açıklama
Response		Yapılan talebe ait durum bilgisine ait node bilgisidir
code	0 – Başarılı işlem Diğer – Bkz hata kodları
description	İşlem açıklama alanıdır.
Company		Firma bilgilerinin yer aldığı node.
companycode	Firma adına tanımlı companycode bilgisi
vendorcode	Firmanın bağlı olduğu bayi / iş ortaklığı kanalını belirtir
name	Firmanın corvass üzerinde tanımlı olduğu firma adı bilgisidir.
Credit		Hesaptaki mevcut kredi miktarı
ExpireDate		Hesaptaki kredilerin zaman aşımına uğrama tarihidir (dd.MM.yyyy HH:mm) formatındadır.
Originators		Müş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}”
}

Node	Key	Açıklama
Authentication		Firma hesabına ait authentication bilgilerinin gönderildiği node bilgisidir.
apikey	Corvass SMS hesabında tanımlı api key bilgisini ifade etmektedir
apisecret	SMS api key'e ait api secret bilgisini ifade eder
message		Gönderilecek mesaj metni
msisdnArray		Mesajın gönderileceği GSM numaraları
originator		Gönderim yapılacak alfanumerik bilgisidir, Boş bırakıldığında hesapta tanımlı ilk alfanumerik bilgisi ile sms gönderimi gerçekleştirilir.
senddate		Mesajın gönderilme tarihidir, boş bırakılması durumunda mesaj hemen iletilecektir geçerli tarih formatı (yyyy-MM-dd HH:mm)dir
tags		Gönderilen mesaj pakete ait etiketler, raporlama amaçlı kullanılmaktadır.
description		Gönderilen mesaj metnine ait açıklama bilgisidir.

MessageType	RecipientType
Gönderilecek mesajın tipi,Bilgilendirme mesajları için B veya Bilgilendirme Reklam mesajları için R veya Reklam	Alı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
}

Node	Key	Açıklama
Response		Yapılan talebe ait durum bilgisine ait node bilgisidir
code	0 – Başarılı işlem Diğer – Bkz hata kodları
description	İşlem açıklama alanıdır.
PacketId		Gö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

Date

Mon, 27 Sep 2021 12:53:13 GMT