ნომრის მინიჭება შეტყობინებების კამპანიისთვის

გამგზავნი ნომრის მინიჭება კამპანიისთვის

გამოიყენეთ ეს ოპერაცია მას შემდეგ, რაც თქვენი შეტყობინებების ბრენდი და საწარმოო კამპანია დარეგისტრირებულია და კამპანია აქტიურია. ის თქვენს ანგარიშზე არსებულ ერთ SMS-ჩართულ ნომერს კამპანიასთან აკავშირებს. ის არ ქმნის ბრენდს, არ ქმნის და არ ამტკიცებს კამპანიას, არ ყიდულობს ნომერს და არ აგზავნის შეტყობინებას.

მიმდინარე პორტალი ამ მარშრუტს იყენებს, როდესაც კამპანიას ნომერს ანიჭებს. საჯარო API იღებს კამპანიის იდენტიფიკატორს; ბრენდს ანგარიშის საკუთრებაში არსებული კამპანიიდან გამოჰყავს და არ იღებს ცალკე ბრენდის იდენტიფიკატორს.

მოთხოვნა

გაგზავნეთ ფორმით დაკოდირებული POST HTTPS-ით თქვენი ჩართული API ანგარიშისა და მისი დაშვებული წყარო IP მისამართის გამოყენებით. გამოიყენეთ თქვენი ანგარიშის ნამდვილი ნომრისა და კამპანიის იდენტიფიკატორები. ამ მაგალითში მოცემული ნომერი გამოგონილია.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --data-urlencode 'action=add' \
  --data-urlencode "campaign=$CAMPAIGN_ID" \
  --data-urlencode 'number=12025550123' \
  'https://api.multitel.net/v3/campaign'

კამპანიის მინიჭების პარამეტრები
პარამეტრი	სავალდებულო	მნიშვნელობა
action	დიახ	გამოიყენეთ add მინიჭებისთვის ან delete ნომრის მიმდინარე კამპანიასთან ასოციაციის წასაშლელად. რეგისტრი და გარშემო არსებული ინტერვალები ნორმალიზდება.
campaign	add ოპერაციისთვის	campaignId იმ ACTIVE სტატუსის მქონე კამპანიისა, რომელიც ავთენტიფიცირებული ანგარიშის საკუთრებაშია. მისი ბრენდიც ანგარიშს უნდა ეკუთვნოდეს. კამპანია, რომელიც ცალსახად მონიშნულია როგორც sandbox, ვერ მიენიჭება ცოცხალ გამგზავნ ნომრებს. delete შემთხვევაში ეს პარამეტრი გამოტოვეთ; წაშლა ნომრის არსებულ ასოციაციას იყენებს.
number	დიახ	საკუთრებაში არსებული, აქტიური, გაუუქმებელი, SMS-ჩართული გამგზავნი ნომერი. ჩრდილოეთ ამერიკის ნომრისთვის გამოიყენეთ ქვეყნის კოდი 1, რომელსაც მოჰყვება მისი ათი ციფრი, პლუსის ნიშნის გარეშე. დამმუშავებელი შლის არაციფრულ სიმბოლოებს და ასევე ეძებს პლუს-პრეფიქსიან და ათციფრიან ეკვივალენტებს. ეს ნორმალიზაცია ტელეფონის ნომრის ზოგადი ვალიდურობის შემოწმება არ არის.

ოპერაცია ერთ ნომერს ცვლის. მას არ აქვს პაგინაცია, პაკეტური პარამეტრი ან საცდელი გაშვების ვარიანტი. არ გამოიყენოთ კამპანიის შექმნის ბოლო წერტილი მხოლოდ იმისთვის, რომ ნომერი არსებულ კამპანიას მიაბათ.

მიმდინარე ასოციაციის წაშლა

გამოიყენეთ action=delete საკუთრებაში არსებულ ნომერთან ერთად. ეს შლის მის გამგზავნ კამპანიასთან ასოციაციას და ასუფთავებს ამ ნომრისთვის შენახულ ბრენდის/კამპანიის ველებს. ის არ შლის კამპანიას ან ბრენდს, არ ათავისუფლებს ტელეფონის ნომერს, არ აუქმებს ნომრის მომსახურებას და არ აჩერებს კამპანიის განმეორებად ბილინგს.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --data-urlencode 'action=delete' \
  --data-urlencode 'number=12025550123' \
  'https://api.multitel.net/v3/campaign'

პასუხი და გადამოწმება

ეს გამოგონილი მაგალითი ასახავს API-ის ჩვეულებრივ საპასუხო კონვერტს და შედეგის შერჩეულ ველებს. დაბრუნებული ნომერი ინარჩუნებს თქვენს ანგარიშში შენახულ ფორმატს. წარმატებული წაშლის შემდეგ brandId და campaignId ცარიელი სტრიქონებია.

{
  "status": {"code": 200, "msg": "Campaign assignment updated."},
  "response": {
    "number": "+12025550123",
    "brandId": "BRAND_FROM_ACCOUNT",
    "campaignId": "CAMPAIGN_FROM_ACCOUNT",
    "providerStatus": 200
  }
}

providerStatus არის შეტყობინებების პარტნიორის HTTP სტატუსი. დამმუშავებელი იღებს 2xx ტრანსპორტის პასუხს და შემდეგ ანახლებს ნომრის ლოკალურ ჩანაწერს; ის არ განმარტავს პარტნიორის პასუხის სხეულს ცალკე ბიზნეს-დონის მიღების შედეგის დასადგენად. შესაბამისად, წარმატებული პასუხი არ ადასტურებს, რომ შეტყობინებების რეგისტრაცია დასრულებულია ან რომ მიწოდება წარმატებული იქნება. საწარმოო ტრაფიკის გაგზავნამდე გადაამოწმეთ ნომრის კამპანიის სტატუსი პორტალში.

მხოლოდ ლოკალური ასოციაცია მიწოდების დამტკიცებად არ მიიჩნიოთ. კამპანიისა და ბრენდის დამტკიცება, ნომრის მომზადება, ანგარიშის უფლებები, შინაარსის წესები და შეტყობინებების ჩვეულებრივი ლიმიტები კვლავ მოქმედებს.

შეცდომები და ნაწილობრივი შედეგები

401: დამმუშავებლისთვის ავთენტიფიცირებული ანგარიში ხელმისაწვდომი არ არის.
400: action ან number აკლია ან არასწორია, ან add მოთხოვნას არ აქვს კამპანიის იდენტიფიკატორი.
404: ნომერი არ არის საკუთრებაში არსებული, აქტიური, გაუუქმებელი SMS ნომერი.
409: კამპანია ანგარიშისთვის მიუწვდომელია, არ არის ACTIVE, ცალსახად sandbox-ია, ან მისი ბრენდი ანგარიშისთვის მიუწვდომელია.
503: შეტყობინებების ინტეგრაცია მიუწვდომელია. დაუკავშირდით მხარდაჭერას და არ შეცვალოთ ანგარიშის ავტორიზაციის მონაცემები და არ გამოიგონოთ კონფიგურაციის მნიშვნელობები.
502: შეტყობინებების მოთხოვნა ჩაიშალა, დროის ლიმიტი ამოიწურა ან დაბრუნდა არა-2xx HTTP სტატუსი. შესაძლოა დაბრუნდეს providerStatus. დროის ლიმიტის ამოწურვა არ ადასტურებს, რომ პარტნიორმა არანაირი ცვლილება არ შეიტანა.
500 და partial=true: შეტყობინებების პარტნიორმა წარმატებული HTTP სტატუსი დააბრუნა, მაგრამ ლოკალური ასოციაცია ვერ დადასტურდა. ხელახლა ცდამდე შეაჯერეთ ნომერი პორტალში ან დაუკავშირდით მხარდაჭერას.

შეამოწმეთ API-ის სტატუსის კოდი და პასუხის სხეული, ისევე როგორც HTTP შედეგი. ბრმად არ გაიმეოროთ დროის ლიმიტის ამოწურვის ან ნაწილობრივი შედეგის მქონე მოთხოვნა. ამ დამმუშავებელს არ აქვს მოთხოვნის დონის იდემპოტენტურობის გასაღები, ტრანზაქციული უკუქცევა ან კამპანიის რეგისტრაციის დასრულების შემოწმება. განმეორებითმა თანმხვედრმა ლოკალურმა მინიჭებამ შეიძლება წარმატება დააბრუნოს მაშინაც კი, როდესაც მონაცემთა ბაზა შეცვლილ სტრიქონებს არ აფიქსირებს.

მოქმედების სფერო და ეფექტები

ეს ოპერაცია ცვლის გამგზავნი ნომრის მარშრუტიზაციას და მის შენახულ კამპანიის/ბრენდის ასოციაციას. განხილულ დამმუშავებელში ის არ შეიცავს ანგარიშიდან პირდაპირ ჩამოჭრას, კამპანიის შექმნას, შესყიდვას ან შეტყობინების გაგზავნას. ეს არ არის ფასის შეთავაზება ან უფასო მომსახურების დაპირება: ნომრის, კამპანიისა და შეტყობინებების არსებული გადასახადები თქვენი ანგარიშის პირობების შესაბამისად გრძელდება.

პორტალში სხვა კამპანიაზე გადასვლა ჯერ წინა ასოციაციას შლის და შემდეგ ახალს ამატებს. ეს ცალკეული მოთხოვნებია. თუ მეორე მოთხოვნა ჩაიშლება, წინა ასოციაცია შესაძლოა უკვე წაშლილი იყოს. არ ივარაუდოთ, რომ ორი მოთხოვნა ერთად უკუიქცევა.