HTTP API v1.0 დოკუმენტაცია

"ემ ეს ჯგუფის" API 1.0-ის მეშვეობით შესაძლებელია სმს-ინფორმირების ინტეგრაცია თქვენს საიტში ან CRM-სისტემაში. ავტომატურ რეჟიმში აცნობეთ თქვენს მომხმარებლებს ბალანსის ცვლილების, შეკვეთის მიწოდების ან სხვა მნიშვნელოვანი მოვლენის შესახებ. ყველა მოთხოვნა ხელმისაწვდომია HTTP GET მეთოდით.

შეტყობინების გაგზავნა

SMS შეტყობინებების გაგზავნაsendsms.php
პარამეტრიფორმატიგამოყენებააღწერა
usernamestringაუცილებელიმეტსახელი
passwordstringაუცილებელიპაროლი
client_idintegerაუცილებელიმომხმარებლის იდენტიფიკატორი
service_idintegerაუცილებელიბრენდ-სახელის იდენტიფიკატორი
tostringაუცილებელიტელეფონის ნომერი საერთაშორისო ფორმატში
textstringაუცილებელიშეტყობინების ტექსტი, (ლათინური 160 სიმბოლო, ქართული 70 სიმბოლო)
utfintegerარა აუცილებელიქართული სიმბოლოებით გაგზავნა
resultstringარა აუცილებელიjson - პასუხი დაბრუნდება JSON ფორმატში
xml - პასუხი დაბრუნდება XML ფორმატში
თუ მითითებული არ არის, პასუხი ბრუნდება ტექსტური სახით "code-message_id"
ყურადღება! თუ გზავნით ქართულ (უნიკოდურ) ტექსტს და არ მიუთითებთ utf პარამეტრს, მომხმარებელი შეტობინებაში ქართული ასოების ნაცვლად მიიღებს "?" სიმბოლოებს.

შეტყობინების გაგზავნის მაგალითი:

curl http://bi.msg.ge/sendsms.php?to=995599000000&text=your+text&service_id=1&client_id=1&password=your+password&username=your+nickname&utf=1

პასუხად ბრუნდება სტატუსის კოდი და შეტყობინების იდენტიფიკატორი:

    0000-000001

პასუხის კოდების მნიშვნელობა:

კოდიაღწერა
0000შეტყობინების გაგზავნის მოთხოვნა მიღებულია. მეორე ციფრი შეტყობინების უნიკალური იდენტიფიკატორი სისტემაში, გამოიყენება შეტყობინების სტატუსის შესამოწმებლად
ყურადღება: ეს სტატუსი არ ნიშნავს შეტყობინების წარმატებით გაგზავნას
0001არასწორი პაროლი ან მეტსახელი ან დაუშვებელი IP მისამართი
0003აუცილებელი ველი ცარიელია (username, password, client_id, service_id)
0005ცარიელი შეტყობინების ტექსტი
0007არასწორი ტელეფონის ნომერი
0008არასაკმარისი ბალანსი
0009ბრენდ-სახელის პოვნა ვერ მოხერხდა
0010შეტყობინება შეიცავს აკრძალულ სიტყვას

მოთხოვნის ფორმირების მაგალითი

შეტყობინების გასაგზავნი მოთხოვნის ფორმირებისას ყველა ცვლადი უნდა გარდაქმნათ URL ფორმატში, ამისათვის შეგიძლიათ გამოიყენოთ შემდეგი ფუნქცია (ან დაწეროთ თქვენი)


function myUrlEncode($arr) {
	$res = '';
	foreach($arr as $k=>$v) {
		$res .= $k .'='. urlencode($v) .'&';
	}
	return substr($res, 0, -1);
}

$myvars = array(
	'to'         => '995YOURPHONE',
	'text'       => 'Your Text',
	'service_id' => 1,                // your service ID provided by MS Group
	'client_id'  => 1,                // your client ID provided by MS Group
	'password'   => 'Your password',  // your password provided by MS Group
	'username'   => 'Your nickname'   // your username provided by MS Group
);

$file = file_get_contents('http://bi.msg.ge/sendsms.php?' . myUrlEncode($myvars));

შეტყობინების გაგზავნა ჰოსტინგის და cloud სერვერებიდან

თუ თქვენი სერვისი განთავსებული ისეთ სერვერებზე, რომლებსაც აქვთ მრავალი IP მისამართი, ამის შესახებ უნდა აცნობოთ თქვენს მენეჯერს და ის გადმოგცემთ ალტერნატიულ პაროლს, რომელსაც გადმოსცემთ მოთხოვნის ჰედერში MSG_HEADER პარამეტრის სახით

მოთხოვნის ფორმირების მაგალითი PHP-ზე
$opts = array(
  'http'=>array(
    'method'=>"GET",
    'header'=>"MSG_HEADER: თქვენი ალტერნატიული პაროლი"
    ...
  )
);

$context = stream_context_create($opts);

$file = file_get_contents('http://bi.msg.ge/sendsms.php?
		to=995599000000&
		text=your+text&
		service_id=1&
		client_id=1&
		password=your+password&
		username=your+nickname', 
		false, $context);
// პარამეტრები ჩაანაცვლეთ თქვენი რეალური მონაცემებით, რომლებსაც მოგაწვდით მომსახურების მენეჯერი

მნიშვნელოვანია: ცვლადები უნდა იყოს UrlEncode ფუნქციაში გატარებული. მაგ. urlencode($text)

შეტყობინების სტატუსის შემოწმება

SMS შეტყობინების სტატუსის შემოწმებაtrack.php
პარამეტრიფორმატიგამოყენებააღწერა
message_idintegerაუცილებელიგაგზავნისას დაბრუნებული შეტყობინების იდენტიფიკატორი
usernamestringაუცილებელიმეტსახელი
passwordstringაუცილებელიპაროლი
client_idintegerაუცილებელიმომხმარებლის იდენტიფიკატორი

GET მეთოდით შეტყობინების სტატუსის გადამოწმების მაგალითი:

curl http://bi.msg.ge/track.php?message_id=1&client_id=1&password=your+password&username=your+nickname

პასუხად ბრუნდება სტატუსის კოდი:

    1

შეცდომის კოდების მნიშვნელობა:

კოდიაღწერა
0გაგზავნის მოლოდინში
1გადაეცა აბონენტს
2აბონენტზე გადაცემა ვერ მოხერხდა
4სტატუსის მოლოდინში
8გადაეცა სმს ცენტრს
16სმს ცენტრმა არ მიიღო
64არასწორი პაროლი ან მეტსახელი ან დაუშვებელი IP მისამართი