メニュー

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Faxリソース

Faxリソースは、皆さんのプログラムと Fax REST APIの架け橋となる中心になります。

Faxインスタンスリソース

このリソースは、送信したFax・着信したFaxに対する参照物になります。

リソース URL

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

{FaxSid} は34文字の各Faxに対してユニークな識別子

リソースのプロパティ

Faxインスタンスは、以下のプロパティで構成されます:

Names in C# format
Sid
sid<FX> Not PII

A 34 character string that uniquely identifies this fax.

AccountSid
sid<AC> Not PII

The unique SID identifier of the Account.

From
文字列 PII MTL: 120 DAYS

The number the fax was sent from, in E.164 format, or the SIP From display name.

To
文字列 PII MTL: 120 DAYS

E.164 "To" - 電話番号 - Faxを受信した電話番号、またはSIP URIです。

Quality
enum:quality Not PII

ファックス品質値のうちの1つ

MediaSid
sid<ME> Not PII

Faxインスタンスに関連づけられたMediaインスタンスを参照する、MEで始まる34文字の一意な識別子です。

MediaUrl
文字列 Not PII

メディアのダウンロードに使用可能なTwilioによってホストされているURLです (このURLは2時間で失効しますが、インスタンスリソースから新しいURLを取得可能です)

NumPages
integer? Not PII

このFax文章の総ページ数

Duration
integer? Not PII

The time taken to transmit the fax, in seconds.

Status
enum:status Not PII

The status of this fax. One of queued, processing, sending, delivered, receiving, received, no-answer, busy, failed or canceled.

Direction
enum:direction Not PII

The transmission direction of this fax. One of inbound or outbound.

ApiVersion
文字列 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 this fax, in price_unit units.

PriceUnit
currency Not PII

このFaxに掛かった料金のISO 4217形式通貨単位

DateCreated
date_time<iso8601> Not PII

このFaxが生成されたISO 8601形式の日時

DateUpdated
date_time<iso8601> Not PII

このFaxが最後に更新されたISO 8601形式の日時

Links
uri_map Not PII

Contains a dictionary of URL links to nested resources of this fax.

Url
url Not PII

The URL of this 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品質

概要
standard 低品質(204x98) の解像度は、全てのFax機器に対応しています。
fine 中品質(204x196) の解像度、比較的多くのFax機器で対応しています。
superfine A high quality (204x392) fax resolution; this quality may not be supported by many devices

サブリソース

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

HTTP GET

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

戻り値

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

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

        
        
        
        

        HTTP POST

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

        オプションパラメーター

        Names in C# format
        pathSid
        必須
        post sid<FX> Not PII

        A 34 character string that uniquely identifies this fax.

        status
        オプション
        post enum:update_status Not PII

        The updated status of this fax. The only valid option is canceled. This may fail if the status has already started transmission.

        戻り値

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

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

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

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

              
              
              
              

              HTTP PUT

              サポートされていません。

              HTTP DELETE

              Faxインスタンスと、関連づけられたFax Mediaインスタンスを削除します。 このアクションは取り消しできないため、ご使用には十分ご注意ください。

              戻り値

              このリソースとそのサブリソースの削除に成功した場合、すでに以前に削除していた場合、元から存在しなかった場合は204を返します

              Faxインスタンスがまだcompleted状態に移行していない場合、あるいはまだ削除されていない場合は409を返します

              Faxリストリソース

              リストリソースは、これまでに送受信したFaxのリスト、これから送る新規のFaxのリソースを返します。

              リソース URL

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

              HTTP GET

              アカウントのFaxリスト

              オプションパラメーター

              Names in C# format
              from
              オプション
              GET 文字列 PII MTL: 120 DAYS

              Filters the returned list to only include faxes sent from the supplied number, given in E.164 format.

              to
              オプション
              GET 文字列 PII MTL: 120 DAYS

              Filters the returned list to only include faxes sent to the supplied number, given in E.164 format.

              dateCreatedOnOrBefore
              オプション
              GET date_time<iso8601> Not PII

              Filters the returned list to only include faxes created on or before the supplied date, given in ISO 8601 format.

              dateCreatedAfter
              オプション
              GET date_time<iso8601> Not PII

              Filters the returned list to only include faxes created after the supplied date, given in ISO 8601 format.

              戻り値

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

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

                    
                    
                    
                    

                    HTTP POST

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

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

                    パラメーター

                    Names in C# format
                    to
                    必須
                    post 文字列 PII MTL: 120 DAYS

                    The phone number or SIP address to send the fax to, E.164-formatted.

                    mediaUrl
                    必須
                    post url Not PII

                    The HTTP or HTTPS URL where the fax media PDF resides that Twilio will make a GET request to. (See our security page for information on how to ensure the request for your media comes from Twilio)

                    quality
                    オプション
                    post enum:quality Not PII

                    品質を示す値で、既定値はfineです

                    statusCallback
                    オプション
                    post url Not PII

                    Faxのステータスが変化した際にPOSTを受信するためのステータスコールバックURLです

                    from
                    オプション
                    post 文字列 PII MTL: 120 DAYS

                    The phone number to use as the caller id, E.164-formatted. If using a phone number, it must be a Twilio number or a verified outgoing caller id for your account. If sending to a SIP address, this can be any alphanumeric string (plus the characters +, _, ., and -) to use in the From header of the SIP request.

                    sipAuthUsername
                    オプション
                    post 文字列 Not PII

                    The username to use for authentication when sending to a SIP address.

                    sipAuthPassword
                    オプション
                    post 文字列 Not PII

                    The password to use for authentication when sending to a SIP address.

                    storeMedia
                    オプション
                    post boolean Not PII

                    Whether or not to store a copy of the sent media on Twilio's servers for later retrieval (defaults to true)

                    ttl
                    オプション
                    post integer Not PII

                    How many minutes from when a fax was initiated should Twilio attempt to send a fax.

                    戻り値

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

                    FromFrom として利用する番号として有効ではない場合、または 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 存在する場合、問題についての詳細メッセージです

                          
                          
                          
                          

                          HTTP PUT

                          サポートされていません。

                          HTTP DELETE

                          サポートされていません。

                          Rate this page:

                          ヘルプが必要ですか?

                          We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.