Жасау, жіберу және жалғыз хабарламалармен (тарату емес) жұмыс істеуге арналған басқа функциялар.
SMS хабарламасының жеткізілу мәртебесі туралы есеп алу
https://api.mobizon.kz/service/Message/GetSMSStatus
SMS хабарламаларының тізімін алу
https://api.mobizon.kz/service/Message/List
Жалғыз SMS хабарламасын жіберу
https://api.mobizon.kz/service/Message/SendSmsMessage
https://api.mobizon.kz/service/Message/GetSMSStatus
Бұл әдіс бір немесе бірнеше SMS-хабарламалардың ағымдағы жеткізілу мәртебесі туралы деректерді алуға мүмкіндік береді.
Кіріс параметрінің түріне қарамастан, қайтарылатын нәтиже әрқашан массив түрінде ұсынылады.
Егер пайдаланушыға тиесілі емес немесе жоқ хабарлама идентификаторларын берсеңіз, нәтиже бұл хабарламалар туралы ақпаратты қамтымайды.
Параметр | Түрі | Сипаттамасы |
---|---|---|
ids | array string | Хабарлама(лар) идентификаторы(ры). Идентификаторлар массиві немесе үтірмен бөлінген жол. Бір сұраудағы максималды идентификаторлар саны – 100. |
Өріс | Түрі | Сипаттамасы |
---|---|---|
id | integer | Хабарлама идентификаторы. |
status | string | Хабарлама мәртебесі. Қараңыз: Хабарламалар мәртебесінің мүмкін тізімі. |
segNum | integer | Бұл хабарламадағы сегменттер саны. |
startSendTs | string | Хабарламаны жіберу уақыты. Формат: ЖЖЖЖ-АА-КК СС-ММ-СС .Егер хабарлама әлі жіберілмесе, өріс мәні NULL болады. |
statusUpdateTs | string | Хабарлама мәртебесінің соңғы жаңартылу уақыты. Формат: ЖЖЖЖ-АА-КК СС-ММ-СС .Егер хабарлама әлі жіберілмесе, өріс мәні NULL болады. |
Код | Сипаттамасы |
---|---|
0 | Жеткізілу мәртебесі туралы есеп сәтті алынды. |
2 | Ешқандай хабарлама идентификаторлары көрсетілмеген болса. |
12 | 100-ден астам хабарлама идентификаторлары көрсетілсе. |
curl -X POST \
'https://api.mobizon.kz/service/message/getSMSStatus?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
-H 'cache-control: no-cache' \
-H 'content-type: application/x-www-form-urlencoded' \
-d 'ids%5B0%5D=123&ids%5B1%5D=556&ids%5B2%5D=988'
var data = "ids%5B0%5D=123&ids%5B1%5D=556&ids%5B2%5D=988";
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://api.mobizon.kz/service/message/getSMSStatus?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");
xhr.send(data);
<?php
use Mobizon\MobizonApi;
$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.kz');
// АПИ әдісін шақыру
if ($api->call(
'message',
'getSMSStatus',
array(
//хабарламалар идентификаторлары
'ids' => array(
'123',
'556',
'988'
)
)
)
) {
// Әдістің орындалу нәтижесін алу
$result = $api->getData();
} else {
// Орындалу кезінде қате болды, қате коды мен хабарлама мәтінін шығару
echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}
https://api.mobizon.kz/service/Message/List
Бұл әдіс жасалған SMS хабарламаларының тізімін алуға мүмкіндік береді.
Іздеу ID және кампания өрістерінің деректері бойынша жүргізілуі мүмкін.
Параметр | Түрі | Сипаттамасы |
---|---|---|
criteria | array | Іздеу критерийлері (қараңыз Іздеу критерийлері кестесі). |
pagination | array | Бет бойынша шығару параметрлері (қараңыз Бет бойынша шығару параметрлері кестесі). |
sort | array | Сұрыптау параметрлері (қараңыз Сұрыптау параметрлері кестесі). |
withNumberInfo | integer | Бұл параметр қабылдаушының нөмірі туралы қосымша ақпарат алуға мүмкіндік береді, мысалы, «ел» және «оператор». Мүмкін мәндер: 0 – алмаған (әдепкі бойынша орнатылған); 1 – алу. |
SMS хабарламаларының іздеу жүргізілетін өрістері туралы ақпарат. Іздеу үшін бір өрісті де, бірнеше өрісті де бір мезгілде пайдалануға болады.
Параметр | Түрі | Сипаттамасы |
---|---|---|
criteria[campaignIds] | array \ string | Кампания идентификаторлары бойынша іздеу. Параметр массив немесе үтірлермен бөлінген идентификаторлар жолы түрінде берілуі керек. Идентификаторлардың максималды саны – 100, бұл лимиттен асқанда іздеу тізімдегі алғашқы 100 ID бойынша жүргізіледі. |
criteria[from] | string | Жіберушінің қолтаңбасы бойынша іздеу. Іздеу кампанияда жасалған жіберушінің қолтаңбасы бойынша жүргізіледі. |
criteria[to] | string | Қабылдаушының телефон нөмірі бойынша іздеу. Толық нөмір бойынша немесе оның бөлігі бойынша іздеуге рұқсат етіледі. Мысалы: 77273573423 – бұл нөмір қатысқан барлық кампаниялар табылатын болады;38097 – көрсетілген цифрлар комбинациясын қамтитын нөмірлері бар барлық кампаниялар табылатын болады.Іздеуде тек бір нөмір қатыса алады. |
criteria[text] | string | Кампания хабарламасының мәтіні бойынша іздеу. Іздеу мәнінің толық сәйкестігі принципі бойынша жүргізіледі. |
criteria[status] | integer | Хабарлама статусы бойынша іздеу. |
criteria[groups] | string | Кампанияда пайдаланылған байланыс топтарының идентификаторлары бойынша іздеу. Параметр массив немесе үтірлермен бөлінген идентификаторлар жолы түрінде берілуі керек. |
criteria[campaignStatus] | string | SMS хабарламасының кампания статусы бойынша іздеу. |
criteria[campaignCreateTsFrom] | string | Кампанияларды жасалған күні мен уақыты бойынша көрсетілген күн мен уақыттан бастап іздеу. Формат: ЖЖЖЖ-АА-КК СС:ММ:СС . |
criteria[campaignCreateTsTo] | string | Кампанияларды жасалған күні мен уақыты бойынша көрсетілген күн мен уақытқа дейін іздеу. Формат: ЖЖЖЖ-АА-КК СС:ММ:СС . |
criteria[campaignSentTsFrom] | string | Жіберілген кампанияларды жіберілген күні мен уақыты бойынша көрсетілген күн мен уақыттан бастап іздеу. Формат: ЖЖЖЖ-АА-КК СС:ММ:СС . |
criteria[campaignSentTsTo] | string | Жіберілген кампанияларды жіберілген күні мен уақыты бойынша көрсетілген күн мен уақытқа дейін іздеу. Формат: ЖЖЖ-АА-КК СС:ММ:СС . |
criteria[startSendTsFrom] | string | Хабарламаларды жіберілген күні мен уақыты бойынша көрсетілген күн мен уақыттан бастап іздеу. Формат: ЖЖЖ-АА-КК СС:ММ:СС . |
criteria[startSendTsTo] | string | Хабарламаларды жіберілген күні мен уақыты бойынша көрсетілген күн мен уақытқа дейін іздеу. Формат: ЖЖЖ-АА-КК СС:ММ:СС . |
criteria[statusUpdateTsFrom] | string | Статусы өзгертілген хабарламаларды көрсетілген күн мен уақыттан бастап іздеу. Формат: ЖЖЖ-АА-КК СС:ММ:СС . |
criteria[statusUpdateTsTo] | string | Статусы өзгертілген хабарламаларды көрсетілген күн мен уақытқа дейін іздеу. Формат: ЖЖЖ-АА-КК СС:ММ:СС . |
Бұл параметрлер сұратылған ақпаратты құрылымдық (жартылай) шығару үшін жасалған.
Параметр | Түрі | Сипаттамасы |
---|---|---|
pagination[pageSize] | integer | Бетте көрсетілетін элементтер саны (25, 50, 100). |
pagination[currentPage] | integer | Ағымдағы бет Беттер нөмірі 0-ден басталады. |
Бұл параметрлерді пайдалана отырып, іздеу нәтижелерін өрістердің бірі бойынша өсу ретімен (ASC) немесе кему ретімен (DESC) сұрыптауға болады.
Мысалы:
Қабылдаушы нөмірі бойынша өсу ретімен сұрыптау – sort[to]
: ASC.
Хабарлама статусы бойынша кему ретімен сұрыптау – sort[status]
: DESC.
Параметр | Сипаттамасы |
---|---|
sort[campaignId] | Кампания идентификаторы бойынша сұрыптау. |
sort[from] | Жіберуші қолтаңбасы бойынша сұрыптау. |
sort[to] | Алушы нөмірі бойынша сұрыптау. |
sort[text] | Мәтін бойынша сұрыптау. |
sort[status] | Хабарлама мәртебесі бойынша сұрыптау. |
sort[startSendTs] | Жіберу уақыты бойынша сұрыптау. |
sort[statusUpdateTs] | Мәртебені жаңарту уақыты бойынша сұрыптау. |
sort[segNum] | Сегменттер саны бойынша сұрыптау. |
Деректер массиві:
Өріс | Түрі | Сипаттамасы |
---|---|---|
items | array | Табылған хабарламалар тізімі (қараңыз: Хабарламалар тізімі кестесі). |
totalItemCount | integer | Табылған элементтердің жалпы саны. |
Әр хабарламада келесі өрістер бар:
Өріс | Түрі | Сипаттамасы |
---|---|---|
id | integer | Хабарлама идентификаторы. |
campaignId | integer | Хабарлама кампаниясының идентификаторы. |
segNum | integer | Сегменттер саны. |
segUserBuy | float | Пайдаланушыға хабарлама сегментінің құны Пайдаланушы валютасында көрсетіледі. |
from | string | Жіберуші қолтаңбасы. |
to | string | Алушының нөмірі. |
text | string | Хабарлама мәтіні. |
status | string | Хабарлама мәртебесі (қараңыз: Хабарлама мәртебесінің мүмкін тізімі). |
groups | string | Нөмірдің кампания жасалған кездегі байланыс топтарының идентификаторлары. |
uuid | string | Хабарламаның ішкі идентификаторы. |
countryA2 | string | Алушының елінің коды ISO-3166 alpha2 форматында. |
operatorName | string | Алушы операторының атауы. |
startSendTs | date | Хабарламаны жіберу күні мен уақыты. Формат: ЖЖЖЖ-АА-КК СС-ММ-СС . |
statusUpdateTs | date | Хабарлама мәртебесінің соңғы жаңартылу күні мен уақыты. Формат: ЖЖЖЖ-АА-КК СС-ММ-СС . |
curl -X POST \
'https://api.mobizon.kz/service/message/list?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
-H 'cache-control: no-cache' \
-H 'content-type: application/x-www-form-urlencoded' \
-d 'criteria%5Bfrom%5D=Alpha&pagination%5BcurrentPage%5D=2&pagination%5BpageSize%5D=50&sort%5BcampaignId%5D=ASC'
var data = "criteria%5Bfrom%5D=Alpha&pagination%5BcurrentPage%5D=2&pagination%5BpageSize%5D=50&sort%5BcampaignId%5D=ASC";
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://api.mobizon.kz/service/message/list?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");
xhr.send(data);
<?php
use Mobizon\MobizonApi;
$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.kz');
// АПИ әдісін шақыру
if ($api->call(
'message',
'list',
array(
//іздеу критерийлері
'criteria' => array(
//жіберуші қолтаңбасы
'from' => 'Alpha'
),
//беттік шығару параметрлері
'pagination' => array(
//ағымдағы бет
'currentPage' => '2',
//беттегі көрсетілетін элементтер саны
'pageSize' => '50'
),
//сұрыптау параметрлері
'sort' => array(
//кампания идентификаторы бойынша сұрыптау
'campaignId' => 'ASC'
)
)
)
) {
// Әдістің орындалу нәтижесін алу
$result = $api->getData();
} else {
// Орындалу кезінде қате болды, қате коды мен хабарлама мәтінін шығару
echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}
https://api.mobizon.kz/service/Message/SendSmsMessage
Бұл әдіс көрсетілген мобильді телефон нөміріне жалғыз SMS хабарламасын жіберуге мүмкіндік береді.
Параметр | Түрі | Сипаттамасы |
---|---|---|
recipient | string | SMS-хабарлама алушысының телефон нөмірі. Нөмір халықаралық форматта болуы керек және тек цифрлардан тұруы тиіс. Мысалы: 77273573423. Егер нөмірдің басында “+” болса, оны URL-сущность %2B деп кодтау немесе жою керек, тек цифрларды қалдыру қажет. |
text | string | SMS-хабарламасының мәтіні, URL-сущность бойынша кодталған. Егер GET сұрауы арқылы хабарлама жіберу әрекеті кезінде жүйе хабарлама деректерін қайтармаса, ең алдымен сұрау мәтінінде арнайы символдардың бар-жоғын тексеру керек: ? / \ & + және [бос орын] .Мұндай символдардың болуы мәтіннің кодталмағанын білдіреді. |
from | string | Жіберуші қолтаңбасы. Өз жіберуші қолтаңбаңызды пайдалану үшін оны алдын ала тіркеу қажет. Егер қолтаңба көрсетілмесе, сіздің аккаунтыңызда әдепкі бойынша таңдалған қолтаңба пайдаланылады. Егер сізде тіркелген қолтаңбалар болмаса немесе көрсетілген қолтаңбамен жіберу мүмкіндігі болмаса, мүмкіндігінше қызметтің жалпы қолтаңбаларының бірі пайдаланылады. Жіберуші қолтаңбалары туралы толығырақ “Жіберуші қолтаңбалары” бөлімінен оқыңыз. |
params | array | Қосымша параметрлер (қараңыз: Қосымша параметрлер кестесі). |
Параметр | Түрі | Сипаттамасы |
---|---|---|
params[name] | string | Кампанияның атауы. |
params[deferredToTs] | string | SMS хабарламасын кейінге қалдырылған жіберу күні мен уақыты. Жіберудің басталуын кемінде бір сағаттан кейін және ең көп дегенде 14 күннен кейін белгілеуге болады. Формат: ЖЖЖЖ-АА-КК СС:ММ:СС . |
params[mclass] | integer | Жіберілетін хабарламаның класы: 0 – хабарламалар қалқымалы терезе түрінде көрсетіледі және еш жерде сақталмайды (flashSMS); 1 – хабарламалар телефонның Кіріс хабарламалар қалтасында сақталады (әдепкі бойынша орнатылған). |
params[validity] | integer | Хабарлама жеткізілмеген жағдайда максималды күту уақыты, егер алушы оны бірден қабылдай алмаса. Мысалы, абоненттің телефоны өшірулі немесе желіден тыс болса. Жіберу сәтінен бастап минутпен көрсетіледі: 60 минуттан (1 сағат) 1440 минутқа (24 сағат) дейін. |
Хабарлама сәтті жіберілген жағдайда жауапта келесі өрістер бар массив қамтылады:
Өріс | Түрі | Сипаттамасы |
---|---|---|
campaignId | integer | Жасалған SMS кампаниясының идентификаторы. |
messageId | integer | Жасалған SMS хабарламасының идентификаторы. |
status | integer | SMS кампаниясының жіберу мәртебесі. 1 – кампания модерацияны күтуде; 2 – кампания модерациясыз жіберілді. |
Код | Сипаттамасы |
---|---|
0 | SMS хабарламасы сәтті жіберілді. |
1 | Егер параметрлердің кем дегенде бірі дұрыс көрсетілмеген болса. |
curl -X POST \
'https://api.mobizon.kz/service/message/sendSmsMessage?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
-H 'cache-control: no-cache' \
-H 'content-type: application/x-www-form-urlencoded' \
-d 'recipient=77273573423&text=Test+sms+message&from=YourAlpha¶ms%5Bvalidity%5D=1440'
var data = "recipient=77273573423&text=Test+sms+message&from=YourAlpha¶ms%5Bvalidity%5D=1440";
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://api.mobizon.kz/service/message/sendSmsMessage?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");
xhr.send(data);
<?php
use 'Mobizon\MobizonApi.php';
$api = new Mobizon\MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.kz');
// API call to send a message
if ($api->call('message',
'sendSMSMessage',
array(
// Recipient international phone number
'recipient' => '77273573423',
// Message text
'text' => 'Test sms message',
// Alphaname is optional, if you don't have registered alphaname, just skip this parameter and your message will be sent with our free common alphaname, if it's available for this direction.
'from' => 'YourAlpha',
// Message will be expired after 1440 min (24h)
'params[validity]' => 1440
))
) {
// Get message ID assigned by our system to request it's delivery report later.
$messageId = $api->getData('messageId');
if (!$messageId) {
// Message is not accepted, see error code and data for details.
}
// Message has been accepted by API.
} else {
// An error occurred while sending message
echo '[' . $api->getCode() . '] ' . $api->getMessage() . 'See details below:' . PHP_EOL . print_r($api->getData(), true) . PHP_EOL;
}