Fax Resource

The Fax resource is the main point of interaction between you and the Fax REST API.

Fax properties

Names in Python format
`sid`	sid<FX> Not PII The unique string that we created to identify the Fax resource.
`account_sid`	sid<AC> Not PII The SID of the Account that created the Fax resource.
`from_`	文字列 PII MTL: 120 DAYS The number the fax was sent from. Can be the phone number in E.164 format or the SIP `from` display name.
`to`	文字列 PII MTL: 120 DAYS The phone number that received the fax in E.164 format or a SIP URI.
`quality`	enum:quality Not PII The Fax Quality value that describes the fax quality. Can be: `standard`, `fine`, or `superfine`.
`media_sid`	sid<ME> Not PII The SID of the FaxMedia resource that is associated with the Fax.
`media_url`	文字列 Not PII The Twilio-hosted URL that can be used to download fax media. Note this URL expires after 2 hours. A new URL can be fetched from the instance resource if necessary.
`num_pages`	integer? Not PII The number of pages contained in the fax document.
`duration`	integer? Not PII The time in seconds it took to transmit the fax.
`status`	enum:status Not PII The status of the fax. Can be: `queued`, `processing`, `sending`, `delivered`, `receiving`, `received`, `no-answer`, `busy`, `failed` or `canceled`.
`direction`	enum:direction Not PII The transmission direction of the fax. Can be: `inbound` or `outbound`.
`api_version`	文字列 Not PII The API version used to transmit the fax. For this version of the API, it will always be `v1`.
`price`	decimal Not PII The price billed to transmit the fax, specified in `price_unit` units.
`price_unit`	currency Not PII The ISO 4217 code of the currency used to price the fax.
`date_created`	date_time<iso8601> Not PII The date and time in GMT when the resource was created specified in ISO 8601 format.
`date_updated`	date_time<iso8601> Not PII The date and time in GMT when the resource was last updated specified in ISO 8601 format.
`links`	uri_map Not PII The URLs of the fax's related resources.
`url`	url Not PII The absolute URL of the fax resource.

Faxステータス

値	概要
queued	Faxがキューイングされ、処理を待っています。
processing	Faxがダウンロード、アップロードされた、または別のフォーマットに変換されました。
sending	Faxが送信処理中です。
delivered	Faxが正常に転送されました。
receiving	Faxが受信処理中です。
received	Faxが正常に受信されました。
no-answer	宛先側が応答しなかったため、Faxの送信に失敗しました。
busy	宛先側から「Busy」信号を受け取ったため、送信に失敗しました。
failed	Faxの送信・受信に失敗しました。
canceled	TwiMLで拒否(Reject)した、またはRest APIによるキャンセルが発生しました。

Fax品質

値	Case-sensitive	概要
standard	true	低品質(204x98) の解像度は、全てのFax機器に対応しています。
fine	true	(Default) A medium quality (204x196) fax resolution; this quality boasts wide device support
superfine	true	A high quality (204x392) fax resolution; this quality may not be supported by many devices

サブリソース

1つのサブリソース（Fax Mediaリソース）を含むFaxインスタンスです。

Create a Fax resource

post

https://fax.twilio.com/v1/Faxes

新しいFaxインスタンスリソースを作り、Faxを送信する。

通常の電話番号に加えて、FaxはSIP URIにも送信可能です。詳細については、SIPの宛先にFaxを送信するを参照してください。

戻り値

単一の新規Faxインスタンスリソース、および queued ステータスと新しく作られた FaxSid を伴い、コード 201 が返ります。

From が From として利用する番号として有効ではない場合、または To がブラックリストに指定されているか、アカウントの「地理による許可」で許可されていない宛先の場合、コード 403 が返ります。

FromまたはToパラメーターが有効なE.164形式の電話番号ではない場合、Qualityの値が有効でない場合、あるいはMediaUrlまたはStatusCallbackパラメーターが有効なURLではない場合には422が返されます。

StatusCallback

Twilioからご利用のサーバーへのステータス callback は、application/x-www-form-urlencoded コンテントタイプを使いPOSTでリクエストされます。このリクエストには以下のパラメータが含まれています:

パラメーター	概要
FaxSid	Faxに対する34文字の一意な識別子です
AccountSid	Faxの送信されたアカウント
From	発信者番号、またはSIP From表示名
To	宛先の電話番号またはSIP URI
RemoteStationId	受信側のFax機器からレポートされる着信先契約者識別番号 (CSID = Called Subscriber Identification) です
FaxStatus	現在のFax送信のステータスです
ApiVersion	Fax送信に使用されたAPIバージョンで、このAPIに対しては "v1" が返されます。
OriginalMediaUrl	Fax送信時に渡されたオリジナルのURLです
NumPages	送信されたページ数です（成功した場合のみ）
MediaUrl	送信されたオリジナルのメディアの取得に使用できるTwilioのサーバー上のメディアURLです。 URLは2時間で失効することに注意してください。新しいURLはFaxインスタンスリソースから取得できます
ErrorCode	存在する場合、問題についての詳細情報を提供するTwilioエラーコードです
ErrorMessage	存在する場合、問題についての詳細メッセージです

パラメーター

Names in None format
`to` 必須	post 文字列 PII MTL: 120 DAYS The phone number to receive the fax in E.164 format or the recipient's SIP URI.
`media_url` 必須	post url Not PII The Twilio-hosted URL of the PDF that contains the fax. See our security page for information on how to ensure the request for your media comes from Twilio.
`quality` オプション	post enum:quality Not PII The Fax Quality value that describes the fax quality. Can be: `standard`, `fine`, or `superfine` and defaults to `fine`.
`status_callback` オプション	post url Not PII The URL we should call using the `POST` method to send status information to your application when the status of the fax changes.
`from` オプション	post 文字列 PII MTL: 120 DAYS The number the fax was sent from. Can be the phone number in E.164 format or the SIP `from` value. The caller ID displayed to the recipient uses this value. If this is a phone number, it must be a Twilio number or a verified outgoing caller id from your account. If `to` is a SIP address, this can be any alphanumeric string (and also the characters `+`, `_`, `.`, and `-`), which will be used in the `from` header of the SIP request.
`sip_auth_username` オプション	post 文字列 Not PII The username to use with the `sip_auth_password` to authenticate faxes sent to a SIP address.
`sip_auth_password` オプション	post 文字列 Not PII The password to use with `sip_auth_username` to authenticate faxes sent to a SIP address.
`store_media` オプション	post boolean Not PII Whether to store a copy of the sent media on our servers for later retrieval. Can be: `true` or `false` and the default is `true`.
`ttl` オプション	post integer Not PII How long in minutes from when the fax is initiated that we should try to send the fax.

例 1

Loading Code Sample...

Next Sample

出力を表示

出力

Create a Fax

Fetch a Fax resource

GET

https://fax.twilio.com/v1/Faxes/{Sid}

単一のFaxインスタンスを取得する

戻り値

単一のFaxインスタンスリソースに対し、 FaxSid が存在すると、コード 200が返ります。

FaxSid が見つからない場合、コード 404 を返します。

パラメーター

Names in None format

Names in None format
`sid` 必須	GET sid<FX> Not PII The Twilio-provided string that uniquely identifies the Fax resource to fetch.

sid

必須

GET sid<FX> Not PII

The Twilio-provided string that uniquely identifies the Fax resource to fetch.

例

Loading Code Sample...

Next Sample

出力を表示

出力

Fetch Fax

Read multiple Fax resources

GET

https://fax.twilio.com/v1/Faxes

アカウントのFaxリスト

戻り値

faxes をキーにしたリストリソース、および標準のページング情報を伴い、コード 200が返ります。(フィルタにマッチしたFaxが存在しない場合はこのリストは空になります)

FromまたはToパラメーターが有効なE.164形式の電話番号ではない場合、422を返します。

パラメーター

Names in None format
`from` オプション	GET 文字列 PII MTL: 120 DAYS Retrieve only those faxes sent from this phone number, specified in E.164 format.
`to` オプション	GET 文字列 PII MTL: 120 DAYS Retrieve only those faxes sent to this phone number, specified in E.164 format.
`date_created_on_or_before` オプション	GET date_time<iso8601> Not PII Retrieve only those faxes with a `date_created` that is before or equal to this value, specified in ISO 8601 format.
`date_created_after` オプション	GET date_time<iso8601> Not PII Retrieve only those faxes with a `date_created` that is later than this value, specified in ISO 8601 format.

例

Loading Code Sample...

Next Sample

出力を表示

出力

Read Fax

Update a Fax resource

post

https://fax.twilio.com/v1/Faxes/{Sid}

単一のFaxインスタンスをアップデートする

戻り値

単一のFaxインスタンスリソースが成功した場合、コード 200を返します。

Status が有効ではないかサポートしていない場合、コード 400を返します。

FaxSid が見つからない場合、コード 404 を返します。

既にこのFaxが完了しているか失敗しているため、このFaxをアップデートできなかった場合には、コード 409 を返します。注意: 現在のところ、Faxが送信をし始めたあとだと、キャンセルはできません。

パラメーター

Names in None format

Names in None format
`sid` 必須	post sid<FX> Not PII The Twilio-provided string that uniquely identifies the Fax resource to update.
`status` オプション	post enum:update_status Not PII The new status of the resource. Can be only `canceled`. This may fail if transmission has already started.

sid

必須

post sid<FX> Not PII

The Twilio-provided string that uniquely identifies the Fax resource to update.

status

オプション

post enum:update_status Not PII

The new status of the resource. Can be only canceled. This may fail if transmission has already started.