REST API დოკუმენტაცია
SMS და MMS REST API-ები
გაგზავნეთ დამტკიცებული აპლიკაციის შეტყობინებები და დაამუშავეთ მიღება, მიწოდების მოვლენები, სეგმენტაცია და ტარიფები.
API და მისი ავტორიზაციის მონაცემები ერთად შეარჩიეთ
დამტკიცებულ დეველოპერებისა და ავტომატიზაციის, ბიზნესისა და კომუნიკაციების პროვაიდერების ანგარიშებს ჩართული სერვისების ინტეგრირება შეუძლიათ. ინდივიდუალურ დეველოპერს კომპანიის სახელით თავის წარმოჩენა არ სჭირდება. აპლიკაციიდან SMS/MMS-ის გაგზავნას შესაბამისი დამტკიცება და რეგისტრაცია სჭირდება. ფიზიკური პირებისა და ოჯახების სერვისს მომხმარებლისთვის ხელმისაწვდომი შეტყობინებების გაგზავნის API არ აქვს.
| API ოჯახი | საბაზო URL | ავთენტიფიკაცია და შედეგი |
|---|---|---|
| კომუნიკაციები v3 | https://api.multitel.net/v3 | დამტკიცებული Basic ავტორიზაციის მონაცემები; სპეციალურად გაცემული შესაბამისი ტოკენები მხოლოდ იმ ოპერაციებისთვის, რომლებიც მათ მხარს უჭერს. JSON status და response. |
| გადაუდებელი დახმარების სერვისში რეგისტრაცია | https://api.multi.tel/emergency | დამტკიცებული Basic ავტორიზაციის მონაცემები ან სპეციალურად ჩართული bearer წვდომა. JSON code, message და data. |
| პორტალის REST ინტეგრაციები | ჰოსტი და ოპერაცია ნაჩვენებია თქვენი ანგარიშის დეველოპერის ცნობარში | გამოიყენეთ კონკრეტული ოპერაციისთვის დოკუმენტირებული ავტორიზაციის მონაცემები, ნებართვის ფარგლები და სქემა. ბრაუზერის სესიის მოთხოვნები ცალკე ინტერფეისს განეკუთვნება. |
მაგალითების გამოყენებამდე MULTITEL_API_USERNAME და MULTITEL_API_PASSWORD თქვენი სერვერის საიდუმლო კონფიგურაციის მეშვეობით დააყენეთ. არასოდეს ჩასვათ ისინი ბრაუზერის საჯარო JavaScript-ში, URL-ებში ან კოდის ვერსიების საცავში. სპეციალური ავტორიზაციის მონაცემები API ინტეგრაციის პარამეტრებში იმართება.
SMS მოთხოვნის მომზადება
გამოიყენეთ ანგარიშის კუთვნილი, დამტკიცებული და SMS-ის გაგზავნისთვის ჩართული ნომერი, მიმღები, რომელიც შეტყობინების მიღებას დათანხმდა, და საჭირო Brand/Campaign რეგისტრაცია ან დამრეკავისთვის უფასო ნომრის დადასტურება. ქვემოთ მოცემული მაგალითი მოქმედი ავტორიზაციის მონაცემებითა და ნომრებით შევსებისას რეალურ შეტყობინებას აგზავნის; ეს სატესტო გარემო არ არის.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
--request POST \
--header "Content-Type: application/json" \
--data '{"from":"YOUR_APPROVED_NUMBER","to":"YOUR_CONSENTED_RECIPIENT","text":"Your requested update is ready."}' \
"https://api.multitel.net/v3/sendsms"გამგზავნისა და მიმღების ადგილშემცვლელები ჩაანაცვლეთ საერთაშორისო ნომრებით, მხოლოდ ციფრებით და ქვეყნის კოდის ჩათვლით. MMS-ისთვის media-ში მიუთითეთ მხარდაჭერილი ფორმატის მედიის საჯაროდ ხელმისაწვდომი URL; ჯერ შეამოწმეთ MMS-ის გამოყენების უფლება და ფასი.
მიღება არ არის მიწოდება
შეამოწმეთ როგორც პასუხის გარე ოპერაციის სტატუსი, ისე დაბრუნებული შეტყობინების შედეგი. ჩაიწერეთ სერვისის მიერ მოწოდებული შეტყობინების იდენტიფიკატორი და თვალყური ადევნეთ მიწოდების სტატუსსა და ვებჰუკის (webhook) მოვლენებს. მოთხოვნის წარმატებით მიღება არ ადასტურებს, რომ შეტყობინება მიმღების ტელეფონმა მიიღო.
SMS-ის საფასური თითო სეგმენტზე ირიცხება. კოდირებისა და შეტყობინების სიგრძის გამო შეიძლება რამდენიმე სეგმენტი შეიქმნას; მედიისა და ოპერატორთან დაკავშირებული საფასურები SMS-ისგან შეიძლება განსხვავდებოდეს. გაგზავნამდე გაეცანით ანგარიშისთვის მოქმედ გასაყიდ ფასს. პასუხის მოლოდინის დროის ამოწურვის შემდეგ გაგზავნა ბრმად არ გაიმეოროთ: ჯერ დაფიქსირებული შედეგი შეამოწმეთ.
შეცდომებისა და განმეორებითი მცდელობების დამუშავება
- ავთენტიფიკაციის ან ნებართვის შეცდომა
- შეამოწმეთ, ჩართულია თუ არა API-ის ავტორიზაციის მონაცემები, რომელი სერვისია დაშვებული და რა შეზღუდვა მოქმედებს წყაროს IP-მისამართზე. პორტალის სესიის ქუქი ინტეგრაციის ავტორიზაციის მონაცემი არ არის.
- არასაკმარისი კრედიტი ან საჭირო დამტკიცების არქონა
- ოპერაციის გამეორებამდე მოაგვარეთ ანგარიშის ბალანსის, გაგზავნის დამტკიცების ან დოკუმენტის მოთხოვნის საკითხი.
- შედეგი არ არის
- ცარიელი მარაგი ან დამრეკავის სახელის არარსებობა ჩვეულებრივ შედეგად მიიჩნიეთ. ნუ ჩათვლით, რომ ფორმატით სწორ ნომერზე ყველა სერვისია ხელმისაწვდომი.
- ქსელის პასუხის მოლოდინის დროის ამოწურვა ან სერვისის შეცდომა
- მონაცემების წაკითხვისას გამოიყენეთ განმეორებითი მცდელობების შეზღუდული რაოდენობა და მცდელობებს შორის დაყოვნება. შესყიდვის, გაგზავნის ან რეგისტრაციისას ჯერ ოპერაციის მდგომარეობა შეამოწმეთ; უკვე მიღებული მოთხოვნის გამეორებამ შეიძლება ფასიანი მოქმედება გააორმაგოს.
იდემპოტენტურობის მხარდაჭერა API-ის თითოეულ ოჯახზეა დამოკიდებული. Emergency API განმეორებითი მცდელობების გასაღებებს უჭერს მხარს; ეს არ ნიშნავს, რომ ყველა v3 მოთხოვნა იდემპოტენტურია. მხარდაჭერისთვის შეინახეთ დროის ნიშნულები, დაბრუნებული ID-ები და პასუხები, საიდანაც საიდუმლო მონაცემები ამოღებულია.
გააგრძელეთ თქვენი ანგარიშის საცნობარო მასალით
ავტორიზებული საცნობარო მასალა ფილტრავს ოპერაციებს თქვენი უფლებებისა და ჩართული სერვისების მიხედვით. გამოიყენეთ მისი ზუსტი ჰოსტი, ავტორიზაციის მონაცემების ტიპი, მოთხოვნის ველები და პასუხის სქემა. კონსოლებს შეუძლიათ რეალური ოპერაციების შესრულება, მათ შორის შესყიდვებისა და შეტყობინებების გაგზავნის.