документация за API

Получаване на съобщения

За проекта, който е свързан с услугата, е в състояние да получава съобщения, е необходимо да се организира специален потребителски интерфейс за програмиране (API), и го поставете върху уеб сървър.

идентификатор на сесия - уникален променлива стойност се използва за идентифициране на искането. Стойността на този параметър се променя във всяка заявка.

префикс - Представката (ключова дума), за които е направено признание на съобщението. Представката е нищожен, в случай, че съобщението е получено проект, с помощта на специален брой на услуги.

текст - текстът в UTF-8. съдържа полученото съобщение, с изключение на префикса. Ако съобщението е получено проект, с помощта на специален номер услуга, стойността на този параметър е идентичен с пълен текст на параметъра.

пълен текст - текст, кодиран в UTF-8. съдържа полученото съобщение, включително префикса.

След получаване и обработка на заявки, обичай API услуга е длъжен да информира за успеха на операцията, връщайки се в текста, съдържащ специален маркер:

Освен това, възможно е да се изпрати съобщение за отговор на подателя, без допълнително искане за услугата. За да направите това, обичай API трябва да се върне съобщението затворени в специални тагове:

Текстът на съобщението за отговор

отговаряте съобщение дължина текст е ограничен до 765 знака, ако съобщение съдържа само букви и символи 335, ако съобщението съдържа кирилица.

В случай, че задоволителен отговор не е получен от потребител на API, услугата ще се опита да изпрати искане отново още 150 пъти на интервали от 10 минути, след което съобщението се изтриват от опашката.

Имайте предвид, че ако проектът се проверява с помощта на префикс, въведете го в текста на съобщението е необходимо. се добавя Представката на текстови съобщения автоматично.

По-долу е извадка от изпълнението API на потребителя с помощта на PHP език за програмиране.

Един пример за потребителското API с PHP

/ *
projectmd5 - искане md5 хеш
идентификатор на сесия - сесия ID
projectid - Проект ID
приемник - номер за обслужване
подател - номера на изпращача
префикс - Представката на проекта
текст - Текстови съобщения (без префикс)
пълен текст - Пълен текст на съобщението
* /

// Hash ключ тайна API
$ Apikeymd5 = '53f28c002c7e258540a2038300045804 "; // md5 ( "MyApiKey)

// проверка на данни
ако (! Isset ($ _POST [ 'projectmd5'])
OR! Isset ($ _POST [ 'идентификатор на сесия "])
OR! Isset ($ _POST [ 'projectid'])
ИЛИ! Isset ($ _POST [ 'приемник'])
ИЛИ! Isset ($ _POST [ 'подател'])
OR! Isset ($ _POST [ 'префикс "])
OR! Isset ($ _POST [ 'пълен текст "])
ИЛИ! Isset ($ _POST [ 'текст']))
// Изпращане на грешка за валидиране
изход ( "Validation грешка ');
>

// Hash Check
ако (md5 ($ apikeymd5
. $ _POST [ 'идентификатор на сесия "]
. $ _POST [ 'projectid']
. $ _POST [ 'приемник']
. $ _POST [ 'подател']
. $ _POST [ 'пълен текст "])! = $ _POST [' projectmd5 '])
// Изпрати грешка хеш
изход ( "Hash грешка ');
>

// обработка на ЛС
$ Response = процес ($ _POST [ 'подател "], $ _POST [' префикс"], $ _POST [ 'текст']);

// Изпращане отговорът на съобщението
изход ($ отговор);

// функция обработка съобщение
процес функция ($ подател. $ префикс. $ текст)
// съобщението отговор
връщане "Текстът на съобщението за отговор";
>

изпращане на съобщение

вход - потребителско име, регистрирано на услугата.

passwordhash - md5 хеш на паролата на регистрирания потребител.

текст - текстовото съобщение да бъде изпратено. Дължината на текст е ограничен до 765 знака, ако съобщение съдържа само букви и символи 335, ако съобщението съдържа кирилица.

Текстови съобщения, трябва да бъдат предадени в UTF-8. в противен случай се намесвам с код за грешка 21 се връща.

След изпращане на заявката е неговата проверка, след което интерфейса на софтуер услуга се връща на работа статус код. Ако кодът е бил върнат на работа 20. изпращане се счита съобщение да бъдат успешни. В други случаи, интерфейсът се връща кода, съответстващ на грешките, описани по-долу:

Брой изходящи искания не трябва да надвишава 10 за 1 минута. В случай на превишаване на допустимия брой изпратени съобщения, интерфейсът се връща код за грешка 22.

По-долу е пример изпълнение на изпращането на молба за интерфейс софтуерна услуга, с помощта на езика за програмиране PHP.

Пример за изпращане на съобщения чрез приложния програмен интерфейс на услуга с PHP

$ POSTDATA = масив
(
// Вход
"Вход '=>' myusername"

// Hash парола
"Passwordhash '=>' 48503dfd58720bd5ff35c102065a52d7. // md5 ( "MyPassword)

// номер за обслужване
"Приемник '=>' +70000000000 ',

// номер на получателя
"Получател '=>' +79012345678 ',

// Съобщение
"Текст" => предварително е кодирал ( "SMS съобщение")
);

// Initialize прегъвката
$ СН = curl_init ();

// опции Set Curl
curl_setopt ($ гл CURLOPT_URL $ apiaddress ..);
curl_setopt ($ гл CURLOPT_POST TRUE ..);
curl_setopt ($ гл CURLOPT_POSTFIELDS $ POSTDATA ..);
curl_setopt ($ гл CURLOPT_RETURNTRANSFER TRUE ..);

// запитване
$ Положение = curl_exec ($ СН);

// Close CURL
curl_close ($ СН);

// Проверка за изпращане на резултатите
ако (статус $! = 20)
// Грешка при изпращане
изход ( "Изпрати грешка:" Състояние на $.);
>

// Изпращане успешно
изход ( "Изпрати OK ');