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

GET/v3/lnp/project/{uniqueid}

ნომრების პორტირების პროექტის წაკითხვა

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

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

ანგარიშსა და პროექტზე წვდომა

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

მოთხოვნა

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/lnp/project/$PROJECT_ID"

ამ პასუხს მოეპყარით როგორც კონფიდენციალურ ინფორმაციას

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

პასუხის სტრუქტურა

გამოგონილი მაგალითი შერჩეული ველებით; პასუხში შესაძლოა დამატებითი ველებიც დაბრუნდეს.

{
  "status": {
    "code": 200,
    "msg": "Project Detail"
  },
  "response": {
    "project": {
      "id": 11,
      "uniqueid": "PROJECT_EXAMPLE",
      "project_name": "Example transfer",
      "location": "US",
      "status": 0,
      "status_str": "Pending"
    },
    "counts": {
      "total": 0,
      "pending": 0,
      "in_progress": 0,
      "completed": 0,
      "rejected": 0
    },
    "numbers": [],
    "events": [],
    "uploads": []
  }
}

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

პროექტის დეტალების განყოფილებები
განყოფილებაშიგთავსი
projectჩანაწერის რიცხვითი იდენტიფიკატორი, პროექტის უნიკალური იდენტიფიკატორი, პროექტის სახელი, მდებარეობა, შენახული ანგარიშსწორების, საკონტაქტო და მისამართის მონაცემები, შექმნის დრო და გამოთვლილი სტატუსი. ძველი ველი, რომელიც აღნიშნავს ოპერატორს, საიდანაც ნომრები გადადის, იწერება ასე: loosing_carrier.
countsნომრების ჩანაწერების საერთო რაოდენობა და Pending, In Progress, Completed და Rejected სტატუსების მრიცხველები.
numbersნომრების მონაცემთა იგივე ნაკრები, რასაც პროექტის ნომრების სიის მოთხოვნის მისამართი აბრუნებს, მომხმარებლის კომენტარებისა და შენახული დაგეგმვის მნიშვნელობების ჩათვლით.
eventsმოვლენების შენახული ჩანაწერები და მონაცემთა შიგთავსის დაუმუშავებელი თუ გარჩეული ველები, მოვლენების მოთხოვნის მისამართისთვის მოქმედი ხილვადობისა და ფორმატის შეზღუდვების გათვალისწინებით.
uploadsდოკუმენტის მეტამონაცემები: რიცხვითი იდენტიფიკატორი, upload_type, file_name, file_extension, date_created და ფარდობითი download_url. ამ URL-ზე წვდომისთვის კვლავ საჭიროა ანგარიშის ავთენტიფიკაცია.

შეჯამებისა და მეტამონაცემების განმარტება

გამოთვლილი სტატუსის განსაზღვრისას უპირატესობა ენიჭება In Progress სტატუსს, შემდეგ Pending, შემდეგ Completed, შემდეგ კი Rejected სტატუსს; თუ სხვა სტატუსი ვერ განისაზღვრა, გამოიყენება Pending. შეჯამების Completed სტატუსის მიუხედავად, შეიძლება არსებობდეს უარყოფილი ნომრებიც. შეამოწმეთ მრიცხველები და ნომრების სტატუსები და ნუ ჩათვლით, რომ ყველა ნომრის პორტირება დასრულდა.

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

შეცდომები და შეზღუდვები

შეამოწმეთ როგორც HTTP პასუხი, ისე status.code/status.msg. თუ პროექტი არ არსებობს, წაშლილია ან ანგარიშს არ ეკუთვნის, ბრუნდება API კოდი 404 შეტყობინებით, რომ პროექტი ვერ მოიძებნა. ასევე მოქმედებს ავთენტიფიკაციისა და წყაროს IP მისამართის შეზღუდვები. მაგალითები რეალურ მოთხოვნას არ ასრულებს, ხოლო წარმატებული პასუხი არ ადასტურებს, რომ ოპერატორმა პორტირება მიიღო ან დაასრულა.

ზემოქმედება და სამუშაო პროცესი

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