API를 사용하여 팩스를 보내려면 먼저 필요한 파일을 업로드한 다음, 해당 파일을 팩스 전송용으로 준비하고 전송을 예약해야 합니다.
팩스가 예약되면 HTTP 서버를 구현하고 웹훅 메커니즘을 활용할 수 있습니다. 이 방식을 사용하면 팩스 전송이 성공하거나 실패한 경우 모두 HTTP 메시지가 전송됩니다.
참고: 초기 인증 절차를 완료했고 API에 성공적으로 로그인했는지 확인하세요. 추가 안내는 여기를 참고하세요.
파일을 업로드하려면 다음 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]
본문:
{
"fax_file": [file]
}
다음 예시에서는 현재 로그인한 사용자의 고유 식별자를 나타내기 위해 사용자 ID로 "self"를 사용합니다:
파일이 성공적으로 업로드되면 Fax.Plus에 있는 파일의 임시 위치로 연결되는 경로를 받게 됩니다.
업로드가 완료되면 fax 발송 준비를 시작할 수 있습니다. 프로세스를 시작하려면 다음 URL로 HTTP POST 요청을 보내세요:
https://restapi.fax.plus/v3/accounts/[user ID]/outbox
요청에 다음 헤더를 반드시 포함하세요:
-
Authorization:
Bearer [access token] -
x-fax-clientid:
[client ID]
요청 본문:
{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}
fax 예약이 성공하면 발신함 ID(Outbox ID)가 제공됩니다. 이 ID로 fax가 실제로 발송되기 전에 수정하거나 삭제할 수 있습니다.
참고: 당사 API에서는 fax에 여러 개의 ID가 연결됩니다. 이는 fax 전송이 비동기적으로 이루어지기 때문입니다. 구체적으로, 발신 fax는 두 가지 ID로 식별됩니다. 발신함 ID(Outbox ID)는 fax가 성공적으로 발송될 때까지 사용되며, fax ID는 fax가 성공적으로 전송된 후 해당 fax의 최종 식별자가 됩니다.
fax를 예약한 후에는 발신함에 있는 fax 목록 또는 보낸 편지함 카테고리를 확인하여 상태를 모니터링할 수 있습니다.
또는 HTTP 서버를 구축하고 웹훅을 사용할 수도 있습니다. 이렇게 하면 fax가 성공적으로 발송되었거나 발송에 실패했을 때 HTTP 메시지가 전송됩니다.
웹훅을 설정하려면 다음 단계를 따르세요:
- Fax.Plus 계정에 로그인한 다음 대시보드의 설정 섹션으로 이동하세요.
- 통합 탭에서 웹훅 상자를 찾으세요.
-
수신 fax와 수신 fax를 찾으세요. 웹훅을 수정하려면 관리를 클릭하세요.
웹훅을 설정하면 발신 fax가 처리될 때 다음과 같은 알림을 받게 됩니다:
{
"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"
}
}이 메시지에는 전송 시간, fax 전송 성공 여부("status" 필드), 그리고 고유한 fax ID가 포함되어 있습니다. 이 fax ID로 fax 파일을 가져오거나 fax 확인 보고서를 받을 수 있습니다.