შეინარჩუნეთ ბრენდი და გამოყენების შემთხვევა ერთად
გამოიყენეთ თქვენს ანგარიშზე არსებული ბრენდის ID და გამოყენების შემთხვევის მნიშვნელობა, რომელიც იმავე ბრენდის კვალიფიკაციის სიამ დააბრუნა. მომხმარებლის სამუშაო პროცესი პროვაიდერისადმი მოთხოვნამდე ამოწმებს საკუთრებას. დარწმუნდით, რომ დაბრუნებული ობიექტის usecase ემთხვევა არჩეულ მნიშვნელობას. ერთი ბრენდის ან გამოყენების შემთხვევის მოძიება არ ადგენს მოთხოვნებს სხვისთვის.
წაიკითხეთ მიმდინარე მოთხოვნები
| ველი | როგორ იყენებს მას პორტალი |
|---|---|
| minSubUsecases / maxSubUsecases | ქვე-გამოყენების შემთხვევების მინიმალური და მაქსიმალური რაოდენობა ამ არჩევანისთვის. აირჩიეთ მნიშვნელობები ქვე-გამოყენების შემთხვევების მოქმედი კატალოგიდან და არა თავისუფალი ტექსტით. |
| mnoMetadata | ოპერატორის სპეციფიკური მოთხოვნები, გასაღებად ოპერატორის ID-ით. ოპერატორის ასარჩევად გამოიყენეთ მიმდინარე პასუხში არსებული ID-ები. |
| mnoSupport / qualify | ოპერატორის მხარდაჭერა და კვალიფიკაცია. პორტალი გამორიცხავს ოპერატორებს, რომლებსაც რომელიმე ველისთვის აშკარად აქვთ მონიშნული false, და მოითხოვს მინიმუმ ერთ უფლებამოსილ არჩეულ ოპერატორს. |
| minMsgSamples | ოპერატორისთვის საჭირო ნიმუშების რაოდენობა. პორტალი მოითხოვს მინიმუმ ერთ არაცარიელ ნიმუშს და აკმაყოფილებს უმაღლეს მინიმუმს უფლებამოსილ არჩეულ ოპერატორებს შორის. |
| reqSubscriberOptin / reqSubscriberOptout / reqSubscriberHelp | აბონენტის სავალდებულო დეკლარაციები. სადაც მოითხოვება, შესაბამისი დეკლარაცია უნდა იყოს true. ჩართულ დეკლარაციებს ასევე სჭირდება საკვანძო სიტყვისა და საპასუხო შეტყობინების ველები. |
| noEmbeddedLink / noEmbeddedPhone | შეზღუდვები ჩაშენებულ ბმულებზე ან ტელეფონის ნომრებზე. პორტალი უარყოფს დეკლარირებულ ფუნქციას, თუ მას უფლებამოსილი არჩეული ოპერატორი კრძალავს. |
გამოიყენეთ არჩეული ოპერატორების მოთხოვნები ერთობლივად
ოპერატორების მოთხოვნები შეიძლება განსხვავდებოდეს. როდესაც ოპერატორების აშკარა სია არ არის მიწოდებული, პორტალი ითვალისწინებს პასუხში არსებულ ოპერატორების ყველა მეტამონაცემს; არაცარიელი სია შემოწმებებს მხოლოდ იმ არჩეული ID-ებით ზღუდავს. არ გამოიყენოთ მხოლოდ პირველი ოპერატორის ნიმუშების რაოდენობა ან დეკლარაციები. აირჩიეთ ოპერატორები პასუხიდან, შეამოწმეთ მხარდაჭერა და კვალიფიკაცია, დააკმაყოფილეთ ნიმუშების უმაღლესი მოქმედი მინიმუმი და დააკმაყოფილეთ სავალდებულო ჩართვის (opt-in), გამორთვის (opt-out) და დახმარების დეკლარაციები მთელი ამ არჩევანისთვის. პორტალი უარყოფს არჩეულ ოპერატორების ID-ებს, რომლებიც მიმდინარე პასუხში არ არის, და უარყოფს არჩევანს, რომელსაც უფლებამოსილი ოპერატორი არ აქვს.
მოთხოვნები აღწერს, რა უნდა იქნას მიწოდებული; ისინი არ ამტკიცებს, რომ მომხმარებლის თანხმობის პროცესი ან კამპანიის შინაარსი ამ მოთხოვნებს აკმაყოფილებს. შეაგროვეთ მართალი, წარმომადგენლობითი ნიმუშები და დეკლარაციები. ავტომატურად არ ჩართოთ დეკლარაციები ფორმის გასავლელად.
მოამზადეთ ნიმუშები და აბონენტის პასუხები
მიმდინარე კამპანიის ფორმა შეტყობინების ნიმუშებისთვის იყენებს ველებს sample1 – sample5 ჩათვლით. თუ მოთხოვნების დაკმაყოფილება ხელმისაწვდომი ფორმის ფარგლებში შეუძლებელია, შეჩერდით და არჩევანი მხარდაჭერის სამსახურთან ერთად მოაგვარეთ. ჩართული აბონენტის დეკლარაციისთვის მიაწოდეთ მისი შესაბამისი საკვანძო სიტყვები და საპასუხო ტექსტი: optinKeywords/optinMessage, optoutKeywords/optoutMessage და helpKeywords/helpMessage. შეინარჩუნეთ ნიმუშების შესაბამისობა არჩეულ გამოყენების შემთხვევასთან და მომხმარებლის რეალურ შეტყობინებებთან.
გადახედეთ ნებისმიერ სარეგისტრაციო მოთხოვნამდე
განაახლეთ მოთხოვნები, როდესაც ბრენდის, გამოყენების შემთხვევის ან ოპერატორების არჩევანი იცვლება. პორტალი შექმნამდე ხელახლა ამოწმებს არჩეულ გამოყენების შემთხვევას, ქვე-გამოყენების შემთხვევების რაოდენობას, ოპერატორების უფლებამოსილებას, ნიმუშებსა და დეკლარაციებს. ანგარიშის ფასები და რეგისტრაციის პირობები ცალკე გადახედეთ. ეს GET არ არეგისტრირებს და არ ამტკიცებს კამპანიას, არ უზიარებს მას შეტყობინებების ოპერატორს და არ ანიჭებს ტელეფონის ნომერს. შექმნა და გაშვება (provisioning) ცალკე ოპერაციებია.
დაამუშავეთ მოთხოვნების წარუმატებელი მოძიება
თუ მოთხოვნა ვერ სრულდება, აბრუნებს მოულოდნელ JSON-ს ან არ ემთხვევა არჩეულ გამოყენების შემთხვევას, დატოვეთ ფორმა დაუსრულებელი და მიეცით მომხმარებელს შეცდომის მოგვარების შემდეგ ხელახლა ცდის საშუალება. არ ჩაანაცვლოთ მიუწვდომელი მოთხოვნები ცარიელი ობიექტით და არ ივარაუდოთ, რომ მონაცემების არარსებობა მოთხოვნების არარსებობას ნიშნავს. დაიცავით Retry-After და გამოიყენეთ ლოდინის ინტერვალის ზრდა (backoff) სიხშირის ლიმიტებისა და ხელმისაწვდომობის შეფერხებებისთვის.
მოთხოვნა
გამოიყენეთ ჩართული API ანგარიში HTTPS-ით დაშვებული წყარო IP მისამართიდან. მიმდინარე მარშრუტი მხარს უჭერს ანგარიშის ავთენტიფიკაციის პოლიტიკას, მათ შორის Basic ავთენტიფიკაციას და ჩართულ bearer API ანგარიშებს. არ გამოიყენოთ პროვაიდერის ავთენტიფიკაციის მონაცემები.
GET ბრენდის ID-ითა და არჩეული გამოყენების შემთხვევის მნიშვნელობით URL-ის გზაში. მოთხოვნის სხეული არ არის საჭირო.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID/usecase/$USECASE"| სახელი | ტიპი | სავალდებულო | აღწერა |
|---|---|---|---|
brand_id | string | დიახ | რეესტრის ბრენდის ID, რომელიც დაკავშირებულია თქვენს ავთენტიფიცირებულ MultiTEL ანგარიშთან. გამოიყენეთ ბრენდის ID და არა ლოკალური მონაცემთა ბაზის სტრიქონის ID, კამპანიის ID ან ბიზნესის საგადასახადო ნომერი. დააკოდირეთ იგი როგორც URL-ის გზის ერთი სეგმენტი. |
usecase | string | დიახ | მანქანურად წაკითხვადი usecase მნიშვნელობა, რომელიც არჩეულია იმავე ბრენდის კვალიფიკაციის სიიდან. შეინარჩუნეთ მისი სიმბოლოების რეგისტრი; არ გაგზავნოთ ნათარგმნი საჩვენებელი იარლიყი. დააკოდირეთ იგი როგორც URL-ის გზის ერთი სეგმენტი. |
პასუხი
მიმდინარე TCR მარშრუტი პირდაპირ აბრუნებს რეესტრის JSON სხეულს და ინარჩუნებს მის HTTP სტატუსს. ის არ ამატებს მოძველებულ v3 status/response კონვერტს. შემოკლებული გამოგონილი მაგალითი არ არის რეალური კვალიფიკაციის შედეგი. გამოყენებამდე შეამოწმეთ HTTP სტატუსი და JSON-ის მოსალოდნელი ფორმა. პორტალი ელოდება ობიექტს, რომლის usecase ემთხვევა არჩეულ გამოყენების შემთხვევას. ოპერატორების მოთხოვნები განთავსებულია mnoMetadata-ის ქვეშ, გასაღებად ოპერატორის ID-ით. მაგალითში მოცემული ოპერატორის ID და მოთხოვნები გამოგონილია. შესაძლოა დაბრუნდეს პროვაიდერის სხვა ველებიც.
პასუხის საილუსტრაციო ფორმა; არა რეალური ანგარიშის მონაცემები და არა მიმდინარე ფასის შეთავაზება.
{
"usecase": "2FA",
"minSubUsecases": 0,
"maxSubUsecases": 0,
"mnoMetadata": {
"12345": {
"mnoSupport": true,
"qualify": true,
"minMsgSamples": 1,
"reqSubscriberOptin": true,
"reqSubscriberOptout": true,
"reqSubscriberHelp": true,
"noEmbeddedLink": false,
"noEmbeddedPhone": false
}
}
}შეცდომები
- 401: ანგარიშის ავთენტიფიკაცია ვერ მოხერხდა. შეამოწმეთ API ავთენტიფიკაციის მონაცემები, ჩართული მდგომარეობა და მოქმედი წყარო-IP შეზღუდვები.
- 404: ბრენდი არ არის დაკავშირებული ავთენტიფიცირებულ ანგარიშთან, ან პროვაიდერი ვერ პოულობს მოთხოვნილ ბრენდს ან არჩევანს. ლოკალური საკუთრების უარყოფა ბრუნდება პროვაიდერისადმი მოთხოვნამდე.
- რეესტრის სხვა შეცდომები: ზედა დონის (upstream) HTTP სტატუსი და სხეული შენარჩუნებულია. არასწორი ან მიუწვდომელი გამოყენების შემთხვევა არ არის წარმატებული ცარიელი მოთხოვნების ნაკრები.
- 429: ანგარიშის ან საერთო პროვაიდერის მოთხოვნების ლიმიტი მიღწეულია. დაიცავით Retry-After.
- 502/503: ტრანსპორტის, პროვაიდერის ან სიხშირის შემზღუდველის ხელმისაწვდომობის შეფერხება. შეინარჩუნეთ ფორმა და სცადეთ ხელახლა ლოდინის ინტერვალის ზრდით (backoff).
ხელმისაწვდომობა და გვერდითი ეფექტები
- განხილული GET ამოწმებს ბრენდის არსებულ საკუთრებას, უკავშირდება რეესტრს და წერს მოთხოვნის აუდიტის ჩანაწერებს. ის არ ქმნის ბრენდს ან კამპანიას და არ არიცხავს რეგისტრაციის საფასურს.
- პროვაიდერის საფასურის მეტამონაცემები არ არის MultiTEL-ის მომხმარებლის საცალო ფასის შეთავაზება. პორტალი ანგარიშის ფასებს ცალკე განიხილავს მოგვიანებით სარეგისტრაციო მოთხოვნამდე.
- კვალიფიკაცია და მოთხოვნები შეიძლება შეიცვალოს. გაგზავნამდე განაახლეთ ისინი არჩეული ბრენდისა და გამოყენების შემთხვევისთვის. წარმატებული მოძიება არ არის კამპანიის დამტკიცება, ნომრის მინიჭება ან შეტყობინებების გაგზავნის დაწყების ნებართვა.