REST SMS API v.2 за разработчици - комуникиране с портала за текстови съобщения.
Този документ предоставя справка за всички функции, достъпни за Вас чрез HTTP интерфейса за изпращане на текстови съобщения.
HTTP API-то Ви позволява да интегрирате Вашето приложение (клиент) с SMSCenter.gr (портал) чрез използване на HTTP протокола за изпращане на съобщения.
Обща информация
Клиентът изпраща HTTP GET заявка към SMSCenter.gr HTTP интерфейса, предоставяйки списък с необходими параметри. SMSCenter.gr връща обратно HTTP отговор, който показва успеваемостта на транзакцията.
Обърнете внимание, че разделителя, използван за status API заявка по-долу във върнатите данни, е символа за вертикална черта '|' (ASCII 124).
Всички подадени параметри трябва да бъдат шифровани за URL и също така да бъдат в UTF-8, както е описано в следните примери на код.
Формати на API отговори
API-то отговаря на всички заявки според параметъра type. Приемани стойности на параметъра type са: v2, което е стойността по подразбиране, json и xml.
Примерни отговори за API заявка key/get:
URL: https://static.smscenter.gr/api/key/get?username=[username]&password=[password]&type=...
...&type=v2
Отговори:
6fe2dd9c06df83
...&type=json
Отговори:
{
"status" : "1",
"key" : "6fe2dd9c06df83",
"remarks" : "Success"
}
...&type=xml
Отговори:
<response>
<status>1</status>
<key>6fe2dd9c06ff83</key>
<remarks>Success</remarks>
</response>
Изпробвайте го (key/get)
https://static.smscenter.gr/api/key/get?username=&password=&type=
Командите, достъпни в тази версия на SMSCenter.gr API-то следват по-долу.
API Key
API ключът трябва да бъде използван вместо потребителско име и парола за всички API заявки. Все пак може да използвате параметрите потребителско име и парола, но ние силно препоръчваме вместо това да използвате API ключът от съображения за сигурност.
Вие придобивате Вашия API ключ чрез key/getзаявка и го използвате за всички заявки в приложението вместо параметрите потребителско име и парола. Ако трябва да смените API ключа, можете да го направите чрез key/reset заявка.
key/get и key/reset заявките са единствените, които изискват използването на потребителско име и парола.
След като вземете Вашия API ключ, можете да го използвате за всички други заявки в приложението.
Изпробвайте го (key/get)
https://static.smscenter.gr/api/key/get?username=&password=&type=
Изпробвайте го (key/reset)
https://static.smscenter.gr/api/key/reset?username=&password=&type=
Връща
...&type=v2
Отговори:
6fe2dd9c06df83
...&type=json
Отговори:
{
"status" : "1",
"key" : "6fe2dd9c06df83",
"remarks" : "Success"
}
...&type=xml
Отговори:
<response>
<status>1</status>
<key>6fe2dd9c06ff83</key>
<remarks>Success</remarks>
</response>
Изпращане на текстово съобщение
URL: https://static.smscenter.gr/api/sms/send?key=[API Key]
Приемани параметри
| Параметър | Описание | Наличност |
|---|---|---|
text |
Съобщение за изпращане. Трябва да е шифровано за URL. | Задължително |
to |
MSIDSN на получателя, на когото съобщението ще бъде изпратено. Например: 49175123456 | Задължителен |
from |
ID на подателя (ако е буквено-числов - максимум 11 символа, ако е числов - максимум 16 символа) | Незадължителен |
flash |
Задайте като вярно, за да изпратите Флаш съобщение | Незадължителен |
ucs |
Задайте като вярно, за да изпратите текстовото съобщение с използване на UCS кодиране | Незадължителен |
timestamp |
Задайте таймстамп-а, за да изпратите текстовото съобщение с Unix таймстамп | Незадължителен |
type |
Типа на API отговорите може да бъде v2, json или xml |
Незадължителен |
Връща
...&type=v2
Отговори:
1234567890
...&type=json
Отговори:
{
"status" : "1",
"id" : "1234567890",
"balance" : "1234",
"remarks" : "Success"
}
...&type=xml
Отговори:
<response>
<status>1</status>
<id>1234567890</id>
<balance>1234</balance>
<remarks>Success</remarks>
</response>
| Описание | |
|---|---|
status |
1 за изпратено съобщение, в противен случай изпращането неуспешно |
id |
ID номера на съобщението (или 0, ако е неуспешно). Отчетите за доставка са дадени според ID-тата на съобщенията |
balance |
баланс на акаунта |
remarks |
Забележки относно заявката |
Изпробвайте го (sms/send)
https://static.smscenter.gr/api/sms/send?key=&to=&from=&text=Hello&type=