TwiML™ Fax: <Receive>

<Receive>動詞は、Twilioに着信Faxの受信を指示します。 新しいFaxインスタンスリソースを生成します。

オプションの要素の属性

属性 説明
action Faxが受信された場合、もしくは失敗した場合に問い合わせを発行する先のURLです
method action URLのリクエストに使用するHTTPmesoddodesu. POSTまたはGETのいずれかです。 初期値は POST です。
mediaType Faxメディアストアへの保存に使用されるメディアタイプです。 現在サポートされている値は application/pdf(既定)およびimage/tiffです。
storeMedia 受信済のメディアをFaxメディアストアに保存するかどうかを決定します(既定値はtrueです)。 falseに設定する場合の詳細情報については下記をご参照ください。

 

コードサンプルを読み込んでいます...
Language
<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <Receive action="/fax/received"/>
</Response>
Faxを受信しURLエンドポイントを指定する
Action URLを伴ってFaxを受信する

Faxを受信しURLエンドポイントを指定する

コードサンプルを読み込んでいます...
Language
<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <Receive mediaType="image/tiff" storeMedia="true"></Receive>
</Response>
mediaType属性を伴ってファイル形式を指定する
TIFFでFax画像を保存する

mediaType属性を伴ってファイル形式を指定する

Action Callback

actionが指定されている場合、actionコールバックに送信されるパラメーターには以下が含まれます:

パラメーター 説明
FaxSid Faxに対する34文字の一意な識別子です
AccountSid Faxが受信されたアカウントです
From 送信元のFaxマシーンの電話番号で’す
To Faxの受信に使用されたTwilio電話番号です
RemoteStationId 送信側のFax機器からレポートされる送信端末識別(TSID=Transmitting Subscriber Identification)です
FaxStatus Fax送信のステータスです
ApiVersion Faxの受信に使用されたAPIのバージョンです。 このAPIに対しては「v1」が返されます
NumPages 受信されたページ数です(利用可能な場合)
MediaUrl 受信済のメディアの取得に使用できるTwilioのサーバーのメディアURLです。 URLは2時間で有効期限が切れることに注意してください。 新しいURLはFaxインスタンスリソースから取得できます。
ErrorCode 存在する場合、問題についての詳細情報を提供するTwilioエラーコードです
ErrorMessage 存在する場合、問題についての詳細メッセージです

Avoiding Media Storage

受信後にTwilioのサーバーに保存されるべきではない機密情報が想定される場合、この動詞の属性としてstoreMedia="false"を指定できます。 しかしながら、下記の変更、制限、および起こりうる懸念事項に留意してください。

actionコールバックは必ず指定されなければならず、かつメソッド(method)はPOSTのみがサポートされます。 コールバックにはMediaUrlが供給される代わりにメディアファイル自体がMediaという名前のパラメーターに提供されます。 またコールバックは(通常のapplication/x-www-form-urlencodedではなく)multipart/form-data content-typeを使用して送信されます。

The media will be permanently deleted on Twilio's side after the callback is successfully delivered. If we do not receive a 2xx HTTP response from your server, we will continue to try to deliver the callback (with media) for the next 2 hours (we will try every 2.5 minutes). If we still have not received a 2xx response from your server after 2 hours, the media will be deleted.

Twilioは依然として、受信Faxのメタデータレコードを保存します。 このレコードを削除したい場合は、REST APIを使用してください。

ヘルプが必要ですか?

誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。

コードサンプルを読み込んでいます...
<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <Receive action="/fax/received"/>
</Response>
<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <Receive mediaType="image/tiff" storeMedia="true"></Receive>
</Response>