API를 사용하여 팩스를 보내려면 어떻게 해야 하나요?

누가 이 기능을 사용할 수 있나요?

Enterprise 요금제에서 사용 가능합니다.

모든 구성원.

API를 사용하여 팩스를 보내려면 먼저 필요한 파일을 업로드한 다음, 해당 파일을 팩스 전송용으로 준비하고 전송을 예약해야 합니다.

팩스가 예약되면 HTTP 서버를 구현하고 웹훅 메커니즘을 활용할 수 있습니다. 이 방식을 사용하면 팩스 전송이 성공하거나 실패한 경우 모두 HTTP 메시지가 전송됩니다.

참고: 초기 인증 절차를 완료하고 API에 성공적으로 로그인했는지 확인하세요. 추가 안내는 여기에서 확인하세요.

1단계: 팩스로 전송할 파일 업로드

파일을 업로드하려면 다음 URL로 HTTP POST 요청을 시작하세요: https://restapi.fax.plus/v3/accounts/[user ID]/files?format=[file format, 'pdf' or 'tiff']


요청에 다음 헤더를 반드시 포함하세요:

    • Content-Type: 
      multipart/form-data
    • Authorization: 
      Bearer [access token]
    • x-fax-clientid: 
      [client ID]


본문(body):

{
  "fax_file": [file]
}

다음 예시에서는 현재 로그인한 사용자의 고유 식별자를 나타내기 위해 사용자 ID로 "self"를 사용합니다:

FAX.PLUS-Send-Fax-API-2.png

FAX.PLUS-Send-Fax-API-3.png

파일이 성공적으로 업로드되면 Fax.Plus에 임시로 저장된 파일의 경로를 받게 됩니다.

2단계: API를 사용하여 팩스 보내기

업로드가 완료되면 팩스 전송을 준비할 수 있습니다. 프로세스를 시작하려면 다음 URL로 HTTP POST 요청을 수행하세요:
https://restapi.fax.plus/v3/accounts/[user ID]/outbox

요청에 다음 헤더를 반드시 포함하세요:

    • Authorization:
      Bearer [access token]
    • x-fax-clientid:
      [client ID]


요청 본문(body):

{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}
 

FAX.PLUS-Send-Fax-API-4.png

팩스 예약이 성공적으로 완료되면 Outbox ID가 제공됩니다. 이 ID는 팩스가 실제로 전송되기 전에 수정하거나 삭제하는 데 사용할 수 있습니다.

참고: 팩스는 저희 API에서 여러 개의 ID와 연결됩니다. 이는 팩스 전송이 비동기적으로 작동하기 때문에 이러한 방식으로 설계되었습니다. 구체적으로, 발신 팩스는 두 가지 서로 다른 ID로 식별됩니다: 팩스가 성공적으로 전송될 때까지 사용되는 Outbox ID와, 팩스가 성공적으로 전송된 후 해당 팩스의 최종 식별자가 되는 Fax ID입니다.

3단계: 웹훅을 사용하여 전송된 팩스의 상태 확인하기

팩스를 예약한 후에는 발신함 또는 보낸 편지함에 있는 팩스 목록을 확인하여 상태를 모니터링할 수 있습니다.

또는 HTTP 서버를 구축하고 웹훅을 사용하는 옵션도 있습니다. 이렇게 하면 팩스가 성공적으로 전송되거나 전송에 실패했을 때 HTTP 메시지가 전송되도록 트리거됩니다.

웹훅을 설정하려면 다음 단계를 따르세요:

  1. Fax.Plus 계정에 로그인한 다음, 대시보드에서 설정  섹션으로 이동합니다.
  2. 통합 탭에서 WebHooks 상자를 찾습니다.
  3. 수신 팩스 항목을 찾은 다음 관리를 클릭하여 웹훅을 수정합니다.

    FAX.PLUS-Setup-API-6.png

웹훅을 설정하면 발신 팩스가 처리된 후 다음과 같은 알림을 받게 됩니다:

{
"hook": {
"id": "",
"event": "fax_sent",
"event_time": "2022-12-09 15:50:00",
"target": "http://www.example.com/callback/fax_sent"
},
"data": {
"id": "",
"pages": 1,
"from": "",
"to": "",
"start_time": "2022-12-09 15:50:00",
"file": "",
"file_name": "fax-from-1xxxxxxxxxxxx",
"cost": 1,
"status": "success"
}
}

이 메시지에는 전송 시간이 포함되며, "status" 필드를 통해 팩스 전송 성공 여부를 나타내고, 고유한 팩스 ID를 제공합니다. 이 팩스 ID를 사용하여 팩스 파일을 가져오거나 팩스 확인 보고서를 얻을 수 있습니다.

도움이 되었습니까?
2명 중 1명이 도움이 되었다고 했습니다.
More Articles in this section