დეველოპერებისთვის

DELETE/tcr/v2/campaign/{campaignId}

შეტყობინებების კამპანიის დეაქტივაცია

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

ამ გვერდზე
  1. არსებული შეტყობინებების კამპანიის დეაქტივაცია
  2. ჯერ გააუქმეთ შესაბამისი ნომრების მიბმები
  3. გაგზავნეთ განზრახული დეაქტივაციის მოთხოვნა
  4. შეამოწმეთ რეგისტრაციაც და მიბმებიც
  5. შეწყვეტა ანგარიშის ფინანსური ანგარიშსწორებისგან დამოუკიდებელია

არსებული შეტყობინებების კამპანიის დეაქტივაცია

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

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

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

ჯერ გააუქმეთ შესაბამისი ნომრების მიბმები

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

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

გაგზავნეთ განზრახული დეაქტივაციის მოთხოვნა

კამპანიის იდენტიფიკატორისა და შესაბამისი გაგზავნის კონფიგურაციის გადახედვის შემდეგ გაგზავნეთ DELETE მოთხოვნა JSON სხეულის გარეშე:

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  --request DELETE \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

დოკუმენტირებული წარმატებული პასუხია HTTP 204 ცარიელი სხეულით. შეამოწმეთ HTTP სტატუსი და ნუ დაელოდებით JSON ფორმატის status/response გარსს. წაშლის მოთხოვნის მიღებისას მიმდინარე სერვისი კამპანიის რესურსს ადგილობრივად მონიშნავს წაშლილად და ვადაგასულად, ხოლო მის ძველ ჩანაწერს — ვადაგასულად. წაშლა კასკადურად არ ვრცელდება ბრენდზე.

ამ განზრახული მოთხოვნისთვის გამოიყენეთ იდემპოტენტურობის ერთი გასაღები და განმეორებისთვის უცვლელად შეინახეთ მეთოდი, გზა, მოთხოვნის პარამეტრები და სხეულის ბაიტები. უკვე დამუშავების პროცესში მყოფი მოთხოვნის დუბლიკატმა შეიძლება დააბრუნოს 409 პასუხი Retry-After სათაურით; დასრულებული მოთხოვნის განმეორებისას შეიძლება დაბრუნდეს შენახული შედეგი. ქეშირებული შეცდომა ან გაწყვეტილი კავშირი არ ადასტურებს, რეესტრმა უკვე შეასრულა თუ არა მოქმედება. შეინახეთ კამპანიის იდენტიფიკატორი და, თუ არსებობს, requestId.

შეამოწმეთ რეგისტრაციაც და მიბმებიც

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

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

დეაქტივაციის შედეგები
შედეგიშემდეგი ნაბიჯი
204პასუხის სხეული მოსალოდნელი არ არის. შეამოწმეთ კამპანიის მდგომარეობა და ნომრების მიბმები, რომლებიც დამოუკიდებლად იმართება.
400წაიკითხეთ მიღებული ვალიდაციის ან რეესტრის მდგომარეობის შეცდომა. შეამოწმეთ კამპანიის ზუსტი იდენტიფიკატორი და არსებული მდგომარეობა.
401, 403, 404შეამოწმეთ API-ის საავთენტიფიკაციო მონაცემები, წყაროს ნებადართული IP მისამართი და ანგარიშის მფლობელობა. არ ჩაანაცვლოთ იდენტიფიკატორი სხვა მომხმარებლის იდენტიფიკატორით.
409, 429გაარჩიეთ დამუშავების პროცესში მყოფი ან კონფლიქტური იდემპოტენტური მოთხოვნა მოთხოვნების სიხშირის შეზღუდვისგან; თუ მოწოდებულია Retry-After, დაიცავით მასში მითითებული ლოდინის დრო.
500, 502 ან ლოდინის დროის ამოწურვაშეინახეთ მოთხოვნის დეტალები, წაიკითხეთ არსებული კამპანიის მონაცემები და ხელახლა გაგზავნამდე შეაჯერეთ ისინი.

შეწყვეტა ანგარიშის ფინანსური ანგარიშსწორებისგან დამოუკიდებელია

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

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