აირჩიეთ შემომავალი ან გამავალი დოკუმენტი
თავსებადობის ეს საბოლოო წერტილი იღებს თქვენი ანგარიშის კუთვნილ ფაქსის დოკუმენტს. გამოიყენეთ გააქტიურებული MultiTEL API ანგარიში HTTPS პროტოკოლით, მისთვის განსაზღვრული ავტორიზაციის მონაცემებითა და IP შეზღუდვებით. ის ფაქსს არ აგზავნის და არც ხელახლა აგზავნის.
| პარამეტრი | სავალდებულო | მნიშვნელობა |
|---|---|---|
type | დიახ | გამოიყენეთ inbound ან outbound, ზუსტად ნაჩვენები სახით. |
id | დიახ | inbound მნიშვნელობისთვის გამოიყენეთ fax_inbox ფუნქციის მიერ დაბრუნებული hash. outbound მნიშვნელობისთვის გამოიყენეთ fax_outbox ფუნქციის მიერ დაბრუნებული uuid. |
ეს მნიშვნელობები გზაში უნდა განთავსდეს. მარშრუტია /v3/fax_file/{type}/{id}, და არა fax_download გზის დამატებითი სეგმენტებით. შემომავალი დოკუმენტის ჰეში არც ჩანაწერის რიცხვითი იდენტიფიკატორია და არც გამავალი დავალების იდენტიფიკატორი. დააკოპირეთ იდენტიფიკატორი შესაბამისი საფოსტო საქაღალდის სიიდან; ის ავთენტიფიკაციას არ ანაცვლებს.
მიღებული ფაქსის ჩამოტვირთვა
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--dump-header fax-response.headers --output fax-response.bin \
https://api.multitel.net/v3/fax_file/inbound/c20ad4d76fe97759aa27a0c99bff6710მაგალითში მოცემული ჰეში შეესაბამება შემოსული შეტყობინებების გამოგონილ ჩანაწერს 12. საკუთარი მნიშვნელობის მისაღებად გამოიყენეთ fax_inbox. არსებული შემომავალი ჩანაწერის ჩამოტვირთვა მას ნახულად მონიშნავს. ეს ხდება ფაილის ხელმისაწვდომობის შემოწმებამდე, ამიტომ ფაილის მიუწვდომლობის შეცდომის შემთხვევაშიც კი viewed შეიძლება დარჩეს true მნიშვნელობით. თუ გსურთ, რომ ფაქსის ნახვის მდგომარეობა უცვლელი დარჩეს, ეს საბოლოო წერტილი მხოლოდ მიღებული ფაქსის არსებობის შესამოწმებლად არ გამოიყენოთ.
დამმუშავებელი უპირატესობას შენახულ PDF ფაილს ანიჭებს. სხვა შემთხვევაში ის იყენებს შენახულ TIFF ფაილს და, თუ კონვერტერი ხელმისაწვდომია, ცდილობს მის PDF ფორმატში გარდაქმნას. თუ გარდაქმნა მიუწვდომელია ან წარმოშობს გამონაკლისს, რომელსაც პროგრამა ამუშავებს, სანაცვლოდ ბრუნდება TIFF ფაილი. ყოველთვის შეამოწმეთ დაბრუნებული Content-Type და ნუ ჩათვლით წინასწარ, რომ ფორმატი PDF იქნება.
გამავალი ფაქსის ჩამოტვირთვა
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--dump-header fax-response.headers --output fax-response.bin \
https://api.multitel.net/v3/fax_file/outbound/0123456789abcdef0123456789abcdefგამოიყენეთ uuid, რომლის წყაროც არის fax_outbox. თავსებადობის ეს ჩამოტვირთვა უპირატესობას ანიჭებს შენახულ PDF ბინარულ ობიექტს, შემდეგ — TIFF ბინარულ ობიექტს, შემდეგ კი ხელმისაწვდომ PDF ფაილს, TIFF ფაილს ან თავდაპირველ წყარო ფაილს. ეს პრიორიტეტების მიმდევრობა განსხვავდება გამავალი ფაქსების მიმდინარე fax_download დამმუშავებლის მიმდევრობისგან. ახალი ინტეგრაციებისთვის, რომლებიც იყენებს send_fax, გამოიყენეთ ჩამოტვირთვის ის მიმდინარე სამუშაო პროცესი თავისი job_id პარამეტრით.
თავდაპირველი წყარო ფაილი შეიძლება დაბრუნდეს application/octet-stream ტიპით და არა PDF ან TIFF ფორმატით. დანართის ფაილის სახელმა შეიძლება შეინარჩუნოს წყარო ფაილის გაფართოება. თავსებადობის რეჟიმში გამავალი ფაქსის ჩამოტვირთვა შემოსული შეტყობინებების ჩანაწერს ნახულად არ მონიშნავს, დავალების სტატუსს არ ცვლის და გადაცემას არ ქმნის.
ბაიტები და შეცდომები ცალ-ცალკე დაამუშავეთ
წარმატების შემთხვევაში ბრუნდება დოკუმენტის დაუმუშავებელი ბაიტები Content-Type, დანართის აღმნიშვნელი Content-Disposition და Content-Length სათაურებით. ეს არ არის Base64 კოდირების JSON გარსი. სათაურები და ბაიტები შეინახეთ ცალ-ცალკე, როგორც ნაჩვენებია, შეამოწმეთ პასუხის ტიპი და მხოლოდ ამის შემდეგ მიანიჭეთ ფაილს შესაბამისი სახელი ან დაამუშავეთ ის. წყარო ფაილის დაშვებული გაფართოება არ იძლევა გარანტიას, რომ დოკუმენტი ვარგისია ან გარდაქმნილია.
API კოდი 400 ნიშნავს, რომ გზის სავალდებულო მნიშვნელობა აკლია ან type არასწორია. API კოდი 404 ნიშნავს, რომ ანგარიშის ფარგლებში არსებული ჩანაწერი ან მისი ფაილი მიუწვდომელია. შეცდომები იყენებს ჩვეულებრივ JSON status/response გარსს და შეიძლება დაბრუნდეს HTTP 200 სტატუსით. შეამოწმეთ პასუხის Content-Type და JSON გარსის status.code, რათა შეცდომის სხეული დოკუმენტად არ გაიხსნას.
კონფიდენციალურობა და ხელმისაწვდომობა
ფაქსის შიგთავსი შეიძლება შეიცავდეს სენსიტიურ ინფორმაციას. ჩამოტვირთული ფაილები შეინახეთ მხოლოდ იქ, სადაც მათზე წვდომა თქვენს განზრახულ მიმღებებს ექნებათ, და ჟურნალებში დოკუმენტის სრული ბაიტები არ შეიტანოთ. საფოსტო საქაღალდის ჩანაწერი არ იძლევა გარანტიას, რომ მისი ფაილი ხელმისაწვდომი დარჩება. ფაილების შენახვის ვადა ან ყველა ისტორიულად შენახული დოკუმენტის თავსებადობის გარანტია დადგენილი არ არის.