ფაქსის გაგზავნა

გაგზავნამდე

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

გამოიყენეთ MultiTEL-ის ჩართული API ანგარიში. პაროლით დაცული ანგარიშისთვის გაგზავნეთ HTTP Basic ავთენტიფიკაციის მონაცემები, ხოლო ტოკენზე დაფუძნებული ანგარიშისთვის — Bearer ტოკენი. ანგარიშის ნებართვები და IP მისამართების შეზღუდვები კვლავ მოქმედებს. არ გამოიყენოთ შიდა შემსრულებელი პროცესის ავთენტიფიკაციის მონაცემები.

დოკუმენტის ატვირთვა

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --form-string from_number=+12125550123 \
  --form-string to_number=+12125550124 \
  --form fax_file=@./document.pdf \
  https://api.multitel.net/v3/send_fax

მოთხოვნის ველები
ველი	სავალდებულო	მნიშვნელობა
`from_number`	დიახ	გამგზავნის ნომერი, რომლის გამოყენების უფლებაც გაქვთ. გამოიყენეთ საერთაშორისო ფორმატი, რომელიც იწყება + ნიშნით და ქვეყნის კოდით.
`to_number`	დიახ	მიმღების ფაქსის ნომერი საერთაშორისო ფორმატში.
`fax_file`	დიახ, მრავალნაწილიანი მოთხოვნისთვის	ატვირთული დოკუმენტი. მრავალნაწილიანი მოთხოვნის Content-Type სათაურისა და ნაწილების გამყოფის დაყენება მიანდეთ curl პროგრამას.
`webhook_url`	არა	არასავალდებულო HTTP ან HTTPS უკუგამოძახების მისამართი; სასურველია HTTPS. უკუგამოძახებით გადასაცემი მონაცემები და ჩაბარების გარანტიები ჯერ კიდევ განხილვის პროცესშია: სტატუსის დოკუმენტირებული სამუშაო პროცესის მიხედვით პერიოდულად გამოითხოვეთ fax_status.

JSON ფორმატიც მიიღება შემდეგი სათაურით: Content-Type: application/json, ნომრების იმავე ველებითა და არასავალდებულო webhook_url ველით, აგრეთვე file_name და file_b64. file_b64 შეიცავს დოკუმენტის ბაიტებს, რომლებიც მკაცრად შეესაბამება Base64 კოდირებას, data: პრეფიქსის გარეშე. უპირატესობა ენიჭება მრავალნაწილიანი მოთხოვნის ვალიდურ fax_file ველს. ეს არ არის ფაილის მისამართიდან ჩამოტვირთვის API.

დოკუმენტისა და გაგზავნის მოთხოვნების შეზღუდვები

აპლიკაცია იღებს მაქსიმუმ 15,728,640 ბაიტის მოცულობის დეკოდირებულ დოკუმენტს (15 MiB), გაფართოებებით pdf, tif, tiff, jpg, jpeg, png, doc, docx ან txt. ნებადართული გაფართოება არ იძლევა გარანტიას, რომ სერვისი შეძლებს გვერდების დათვლას ან გარდაქმნას. ინფრასტრუქტურის მიერ მოთხოვნის ზომაზე დაწესებული შეზღუდვები შეიძლება უფრო დაბალი იყოს, ხოლო Base64 მოთხოვნის ზომას ზრდის.

თითოეული ანგარიშისთვის მოქმედი აპლიკაცია უშვებს ერთსა და იმავე მიმღებთან მხოლოდ ერთ დავალებას, რომელიც რიგშია ან იგზავნება, გასული საათის განმავლობაში ამ მიმღებთან მაქსიმუმ ხუთ გაგზავნის მოთხოვნას და გასული საათის განმავლობაში ჯამში მაქსიმუმ 50 გაგზავნის მოთხოვნას. სიხშირის შეზღუდვის შესახებ პასუხი იყენებს API კოდს 429. ხელახლა ცდამდე მოიცადეთ; ნუ შეეცდებით შეზღუდვების გვერდის ავლას.

შეინახეთ დავალების იდენტიფიკატორი

წაიკითხეთ როგორც HTTP შედეგი, ისე JSON პასუხის status.code ველი. JSON ფორმატის შეცდომები შესაძლოა მოვიდეს HTTP 200 კოდით. წარმატებული JSON პასუხი შეიცავს status და response ველებს; მაგალითებში გამოყენებულია გამოგონილი მონაცემები.

{
  "status": {
    "code": 200,
    "msg": "Fax queued"
  },
  "response": {
    "job_id": "0123456789abcdef0123456789abcdef"
  }
}

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

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

API კოდებს შორისაა 400 — გამოტოვებული ველების, უკუგამოძახების არავალიდური მისამართის, უარყოფილი დოკუმენტის ან გვერდების ამოცნობის წარუმატებლობის შემთხვევაში; 401 — ავთენტიფიკაციის არარსებობისას; 402 — როდესაც ფაქსის სავარაუდო ღირებულებისა და რიგში მდგომი ან გაგზავნის პროცესში მყოფი დავალებების სავარაუდო ღირებულებების ჯამი ანგარიშზე ხელმისაწვდომ ბალანსს აღემატება; 429 — სიხშირის შეზღუდვისას; და 500 — გასაგზავნად მომზადების ეტაპის წარუმატებლობისას. კონკრეტული მიზეზის გასაგებად წაიკითხეთ status.msg.

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