REST API: Hosted Numbers

Hosted Numbers API is currently in Developer Preview

HostedNumberOrdersインスタンスリソース

HostedNumberOrdersインスタンスリソースは、Twilioのプラットフォーム上で電話番号の機能をホストするためのリクエストを表しています。

The HostedNumberOrders list resource represents an account's requests for hosted phone numbers. You can POST to the list resource to create a new request to host a phone number. Upon creation of a HostedNumberOrders resource instance, a corresponding IncomingPhoneNumbers resource instance will also be created.

リソースURI

preview.twilio.com/HostedNumbers/HostedNumberOrders/{HostedNumberOrderSid}

リソースのプロパティ

プロパティ 説明
Sid このHostedNumberOrderを一意に識別する34文字の文字列です。
AccountSid アカウントを一意に識別する34文字の文字列です。
IncomingPhoneNumberSid ホストされる電話番号を表すIncomingPhoneNumberリソースを一意に識別する34文字の文字列です。
AddressSid この電話番号の所有者の住所および使命を表すAddressリソースを一意に識別する34文字の文字列です。
SigningDocumentSid ユーザーによる署名の必要な委任状(LOA=Letter of Authorization)ドキュメントを一意に識別する34文字の文字列です。
PhoneNumber ホスト対象の電話番号です。 E.164形式であることが必要です(例: +1617551212)
機能 Twilioプラットフォームでホストする機能を指定する一連のブール値です。
FriendlyName このリソースを表す最大64文字の人間にとって読み取りやすい文字列です。
ユニーク名 このアカウントに対するHostedNumberOrderを一意に識別する64文字の文字列です。
Status Status of this resource. It can hold one of the values: 1. Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, 5. Completed, 6. Action Required, 7. Failed. See section entitled HostedNumberOrders Status Values for more information on each of these statuses.
DateCreated このリソースが作成された日付で、GMT RFC 2822形式で返されます。
DateUpdated このリソースが更新された日付で、GMT RFC 2832形式が使用されます。
Email 電話番号を所有する個人のメールアドレスです。 この個人が委任状に対して許諾、署名する人物でなければならない点に注意してください。
CcEmails 委任状がCcされる人々のメールアドレスです。
VerificationType The type of ownership verification required to move the number to a verified state. The verification methods are phone-call or phone-bill.
VerificationDocumentSid The Identity Document that shows proof of ownership with a Copy of a Phone Bill.
認証コード ホストされる電話番号への通話でユーザーに通知される検証コードです。
VerificationCallSids Call Sids that show the status of the verification call to the Hosted Number Order.
CallDelay バリデーションの電話をかける前の遅延を、0 から 60 までの秒数で指定します。 初期値は 0 です。
内線番号 バリデーションの電話が接続された後にダイヤルする数字です。

HostedNumberOrdersステータス値

Status 説明
twilio-processing Twilio is processing your request and will either send to the failed status if the number is not eligible to be hosted, or move the number to received status.
received TwilioはHostedNumberOrderリクエストを受信し、リクエスト中の電話番号がTwilioのプラットフォーム上でホスト可能であると判断しました。
pending-verification Twilio is awaiting the Hosted Number Order to be verified by the end-user by picking up the phone and listening to a security token, or supplying a copy of the phone bill. The verification code is valid for 10 minutes. Subsequent calls to the API within the expiration time will send the same verification code. There can be a max of three verification attempts before the status changes to action_required.
検証済み Twilioはセキュリティートークンによってその電話に出た個人がSMSをホストするリクエストを検証したことを確認しました。
pending-loa HostedNumberOrder用の委任状が生成されましたが、ドキュメントがHostedNumberOrdrで指定されたメール受信者によって署名されていません。
carrier-processing HostedNumberOrderに対する委任状が署名され、電話番号はTwilioの契約しているプロバイダーまたはキャリアーに対して指定された機能をオンにするよう申請しました。
testing 電話番号はこのオーダーで指定された機能に対するケイパビリティーテストを実行中です。
completed HostedNumberOrderのオンボーディングが完了し、電話番号の使用準備が整いました。
action-required HostedNumberOrderのオンボーディングが失敗しました。 オペレーションスペシャリストが失敗について調査を行います。
failed HostedNumberOrderが電話番号の現在のプロバイダーまたはキャリアーによって否認されました。 この時点で、同じリクエストの再送信はできなくなります。

HostedNumberOrdersステータスコールバック

StatusCallbackURLをAPIリクエストに指定している場合、Hosted Number Ordersのステータスが変化すると、Twilioは非同期のHTTPリクエストをそのURLに送信します。 このリクエストを捕捉することで、Hosted Number Ordersのステータスが変化したことを知ることができます。

Hosted Number Ordersのステータスコールバックリクエストでは、下記の追加パラメーターも渡されます:

Status 説明
Status Hosted Number Orderの新しいステータスです
HostedNumberOrderSid Hosted Number Orderの一意なSIDです。
PhoneNumber Hosted Number Orderの+E.164形式です。

HTTP GET

リクエストされたHosted Number OrdersインスタンスリソースSIDによって指定された、単一の既存Hosted Number Ordersインスタンスリソースを返します。

コードサンプルを読み込んでいます...
Language
形式:
  • JSON
$ curl -G https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRd1af6b015e256ca5635dc9eff5526f7f \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
{
    "status": "twilio-processing",
    "unique_name": null,
    "date_updated": "2018-01-21T21:40:55Z",
    "cc_emails": [],
    "verification_code": null,
    "incoming_phone_number_sid": "PN876a18805574a952ffb73907b24205f0",
    "failure_reason": null,
    "verification_attempts": 0,
    "verification_type": "phone-call",
    "capabilities": {
        "voice": false,
        "mms": false,
        "sms": true
    },
    "sid": "HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "email": null,
    "phone_number": "+18444905863",
    "address_sid": null,
    "call_delay": 0,
    "signing_document_sid": null,
    "verification_document_sid": null,
    "verification_call_sids": [],
    "extension": null,
    "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "friendly_name": "MyHostedNumberSmsOrder",
    "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "date_created": "2018-01-21T21:40:55Z"
}
Hosted Number Orderインスタンスを取得する

HTTP POST

単一の、既に存在するHosted Number Ordersインスタンスリソースのプロパティーの更新を試み、成功した場合は更新済みリソースの表現を返します。 返されたレスポンスはGETリクエストの発行時に上記で返されたものと同一です。

HostedNumberOrdersインスタンスPOSTオプションパラメーター

パラメーター 説明
FriendlyName このリソースを表す最大64文字の人間にとって読み取りやすい文字列です。
ユニーク名 このアカウントに対するHostedNumberOrderを一意に識別する64文字の文字列です。
Status User can only post to pending-verification or "pending-loa" statuses to transition the HostedNumberOrder to initiate a Verification call or generate the LOA document to sign.
VerificationType Initiates either a phone-call or phone-bill when moving a number to pending-verification
VerificationDocumentSid The Document SID used to verify proof of ownership with a copy of a phone bill.
CallDelay バリデーションの電話をかける前の遅延を、0 から 60 までの秒数で指定します。 初期値は 0 です。
内線番号 バリデーションの電話が接続された後にダイヤルする数字です。
コードサンプルを読み込んでいます...
Language
形式:
  • JSON
$ curl -X POST https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HR36f3f0c7c8d5d9210114fdcd8b6bcf19 \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token' \
    -d "FriendlyName=My_Sms_Hosted_Number_Order" \
{
    "status": "received",
    "date_updated": "2018-01-21T21:44:10Z",
    "verification_code": null,
    "incoming_phone_number_sid": "PN876a18805574a952ffb73907b24205f0",
    "failure_reason": null,
    "verification_attempts": 0,
    "verification_type": "phone-call",
    "capabilities": {
        "mms": false,
        "voice": false,
        "sms": true
    },
    "sid": "HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "phone_number": "+18444905863",
    "call_delay": 0,
    "signing_document_sid": null,
    "verification_document_sid": null,
    "verification_call_sids": [],
    "extension": null,
    "url": "https://https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "friendly_name": "My_Sms_Hosted_Number_Order",
    "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "date_created": "2018-01-21T21:40:55Z"
}
Update Friendly Name of Hosted Number Order
レスポンス

返却されるレスポンスはGETリクエストの送信時に返却されるものと同一です。

コードサンプルを読み込んでいます...
Language
形式:
  • JSON
$ curl -XPOST https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HR36f3f0c7c8d5d9210114fdcd8b6bcf19
-u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
-d "VerificationType=phone-call"
-d "Status=pending-verification"
{
    "status": "pending-verification",
    "date_updated": "2018-01-21T22:31:43Z",
    "verification_code": "310001",
    "incoming_phone_number_sid": "PN876a18805574a952ffb73907b24205f0",
    "failure_reason": "",
    "verification_attempts": 1,
    "verification_type": "phone-call",
    "capabilities": {
        "voice": false,
        "mms": false,
        "sms": true
    },
    "sid": "HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "phone_number": "+18444905863",
    "call_delay": 0,
    "signing_document_sid": null,
    "verification_document_sid": "RI2ad9942e6daa7d8e87a154f6f675f3f8",
    "verification_call_sids": [
        "CA83f7aa47a1760188e892fe8c2ba86749"
    ],
    "extension": null,
    "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "friendly_name": "My_Sms_Hosted_Number_Order",
    "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "date_created": "2018-01-21T21:40:55Z"
}
Prove Ownership with Phone Call
コードサンプルを読み込んでいます...
Language
形式:
  • JSON
$ curl -XPOST https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HR36f3f0c7c8d5d9210114fdcd8b6bcf19 
-u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
-d "VerificationType=phone-bill"
-d "VerificationDocumentSid=RI2ad9942e6daa7d8e87a154f6f675f3f8"
{
    "status": "received",
    "date_updated": "2018-01-21T22:16:11Z",
    "verification_code": null,
    "incoming_phone_number_sid": "PN876a18805574a952ffb73907b24205f0",
    "failure_reason": "",
    "verification_attempts": 0,
    "verification_type": "phone-bill",
    "capabilities": {
        "mms": false,
        "voice": false,
        "sms": true
    },
    "sid": "HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "phone_number": "+18444905863",
    "call_delay": 0,
    "signing_document_sid": null,
    "verification_document_sid": "RI2ad9942e6daa7d8e87a154f6f675f3f8",
    "verification_call_sids": [],
    "extension": null,
    "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "friendly_name": "My_Sms_Hosted_Number_Order",
    "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "date_created": "2018-01-21T21:40:55Z"
}
Prove Ownership with Phone Bill
Ownership Verification

Ownership Verification is a security measure to host the number with Twilio for SMS to ensure the authenticity of the request.

HTTP DELETE

HostedNumberOrderをキャンセルし、その結果対応するIncomingPhoneNumberが削除されます。 HostedNumberOrderのステータスがreceivedpending-verificationverified、またはpending-loaのいずれかの場合にのみDELETEリクエストを送信できることに注意してください。 それ以降は、対応するIncomingPhoneNumbersリソースに対してDELETEリクエストを送信することでTwilioプラットフォームからオフボードすることが可能です。

コードサンプルを読み込んでいます...
Language
レスポンス形式:
  • JSON
$ curl -X DELETE https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
Hosted Number Orderを削除する
レスポンス

リクエストが成功すると、レスポンスBodyのないHTTP 204が返されます。

HostedNumberOrdersリストリソース

HostedNumberOrdersリストリソースはアカウントでアクティブまたは完了済のHostedNumberOrdersの一覧を表します。

リソースURI

preview.twilio.com/HostedNumbers/HostedNumberOrders/

リストフィルター

パラメーター 説明
Status このステータスのHostedNumberOrdersの一覧のみを取得します。
PhoneNumber このPhoneNumberのHostedNumberOrdersを取得します。
IncomingPhoneNumberSid このIncomingPhoneNumberSidを持つHostedNumberOrdersを取得します。
FriendlyName このFriendlyNameを持つHostedNumberOrdersを返します。
ユニーク名 このUniqueNameのHostedNumberOrdersを取得します。

HTTP GET

アカウントに対する全HostedNumberOrdersの一覧を返します。

コードサンプルを読み込んでいます...
Language
レスポンス形式:
  • JSON
形式:
  • JSON
$ curl -G https://preview.twilio.com/HostedNumbers/HostedNumberOrders \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
{
    "items": [
        {
            "status": "received",
            "date_updated": "2018-01-21T21:25:02Z",
            "verification_code": null,
            "incoming_phone_number_sid": "PN8b53cea1327fdb0f7f8f31364bfabe68",
            "failure_reason": null,
            "verification_attempts": 0,
            "verification_type": "phone-call",
            "capabilities": {
                "voice": false,
                "mms": false,
                "sms": true
            },
            "sid": "HR637848c52b3a2528cdda4c1b938dc902",
            "phone_number": "+18444905863",
            "call_delay": 0,
            "signing_document_sid": null,
            "verification_document_sid": null,
            "verification_call_sids": [],
            "extension": null,
            "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HR637848c52b3a2528cdda4c1b938dc902",
            "friendly_name": "My_Hosted_Number_Sms_Order",
            "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "date_created": "2018-01-21T21:19:04Z"
        }
    ],
    "meta": {
        "page": 0,
        "page_size": 50,
        "first_page_url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0",
        "previous_page_url": null,
        "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0",
        "next_page_url": null,
        "key": "items"
    }
}
全Hosted Number Ordersの一覧を取得する
レスポンス

上記のインスタンスレスポンスの一覧です。

HTTP POST

指定された機能を持った新規HostedNumberOrderを作成します。

必須パラメーター

パラメーター 説明
PhoneNumber E164形式の、ホスト対象の電話番号です
SmsCapability Twilioのプラットフォーム上でにホストするには、機能としてSMSを明示的に指定します。

オプションパラメーター

パラメーター 説明
AccountSid ユーザーが認証に使用しているアカウントSIDが既定値になります。 ここにはHostedNumberOrderを追加するサブアカウントを指定できます。
FriendlyName このリソースを表す最大64文字の人間にとって読み取りやすい文字列です。
ユニーク名 このアカウントに対するHostedNumberOrderを一意に識別する64文字の文字列です。
SmsUrl 電話番号にSMSが送信された時にTwilioがリクエストすべきURLです。 これはIncomingPhoneNumberにコピーされます。
SmsMethod SmsUrlへのリクエストに使用されるHTTPメソッドです。 GETまたはPOSTのいずれかでなければなりません。 これはIncomingPhoneNumberにコピーされます。
SmsFallbackUrl SmsUrlで定義されたTwiMLのリクエストまたは実行にエラーが発生した際にTwilioがリクエストを行うURLです。 これはIncomingPhoneNumberにコピーされます。
SmsFallbackMethod SmsFallbackUrlへのリクエストに使用されるHTTPメソッドです。 GETまたはPOSTのいずれかでなければなりません。これはIncomingPhoneNumberにコピーされます。
Status Callback URL Hosted Number Orderのステータスが変化したときにTwilioがリクエストを行うURLです。
statusCallbackMethod 上記のURLへのリクエストに使用されるHTTPメソッドです。 既定ではGETになります。
コードサンプルを読み込んでいます...
Language
形式:
  • JSON
$ curl -X POST https://preview.twilio.com/HostedNumbers/HostedNumberOrders \
    -d "PhoneNumber=+18444905863" \
    -d "SmsCapability=true"  \
    -d "FriendlyName=MyHostedNumberSmsOrder" \
    -d "StatusCallbackUrl=http://example.com/callback" \
    -d "StatusCallbackMethod=POST" \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
{
    "status": "twilio-processing",
    "date_updated": "2018-01-21T21:40:55Z",
    "verification_code": null,
    "incoming_phone_number_sid": "PN876a18805574a952ffb73907b24205f0",
    "failure_reason": null,
    "verification_attempts": 0,
    "verification_type": "phone-call",
    "capabilities": {
        "voice": false,
        "mms": false,
        "sms": true
    },
    "sid": "HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "phone_number": "+18444905863",
    "call_delay": 0,
    "signing_document_sid": null,
    "verification_document_sid": null,
    "verification_call_sids": [],
    "extension": null,
    "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "friendly_name": "MyHostedNumberSmsOrder",
    "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "date_created": "2018-01-21T21:40:55Z"
}
新規Hosted Number Orderを作成する
レスポンス

返されるレスポンスは、HostedNumberOrdersインスタンスリソースへのGETリクエストの送信時に返されるものと同一です。

AuthorizationDocuments Instance Resource

The AuthorizationDocuments instance resource represents a single request to host a customer's phone number(s) onto the Twilio platform for a given capability.

リソースURI

preview.twilio.com/HostedNumbers/AuthorizationDocuments/{AuthorizationDocumentSid}

リソースのプロパティ

プロパティ 説明
AddressSid A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.
Email Email that this AuthorizationDocument will be sent to for signing.
CcEmails A list of emails that this AuthorizationDocument will be carbon copied to.
DateCreated The date that this AuthorizationDocument was created, given in ISO 8601 format.
DateUpdated The date that this AuthorizationDocument was updated, given in ISO 8601 format.
Sid A 34 character string that uniquely identifies this AuthorizationDocument.
Status The Status of this AuthorizationDocument. One of opened, signing, signed, canceled, or failed.

AuthorizationDocument Status Values

Status 説明
opened AuthorizationDocument is in open status and can be updated with numbers or information
signing AuthorizationDocument is in signing status and cannot be updated
signed AuthorizationDocument has been signed and cannot be updated
canceled AuthorizationDocument has been canceled and cannot be updated
failed AuthorizationDocument has failed and cannot be updated
コードサンプルを読み込んでいます...
Language
形式:
  • JSON
$ curl -G https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXeb2bd370aa325bec073ed6f2a9427ead
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
{
    "status": "signing",
    "date_updated": "2017-10-12T22:27:14Z",
    "cc_emails": [
        "hostedsms+test@twilio.com"
    ],
    "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXeb2bd370aa325bec073ed6f2a9427ead",
    "address_sid": "AD1e20d20a7772e157c8ddbaba36aefef0",
    "sid": "PXeb2bd370aa325bec073ed6f2a9427ead",
    "date_created": "2017-10-12T22:27:13Z",
    "email": "hostedsms@twilio.com"
}
Get AuthorizationDocument

HTTP GET

Returns a single, existing Authorization Documents instance resource specified by the requested Hosted Number Orders instance resource SID.

コードサンプルを読み込んでいます...
Language
形式:
  • JSON
$ curl -X POST https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX51974a657d67dd0b5448fd0f87db2fb8
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token' \
    -d "CcEmails=person1@example.com&CcEmails=person2@example.com" \
    -d "Status=signing"
{
    "status": "opened",
    "date_updated": "2018-01-21T23:08:24Z",
    "cc_emails": [
        "person1@example.com",
        "person2@example.com"
    ],
    "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX51974a657d67dd0b5448fd0f87db2fb8",
    "address_sid": "ADf632cf3795fcab7969d360e12e0db30a",
    "sid": "PX51974a657d67dd0b5448fd0f87db2fb8",
    "date_created": "2018-01-19T05:51:07Z",
    "email": "HostedSMS@twilio.com",
    "links": {
        "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX51974a657d67dd0b5448fd0f87db2fb8/DependentHostedNumberOrders"
    }
}
Update AuthorizationDocument

HTTP POST

Tries to update a single, existing Authorization Documents instance resource’s properties and returns the updated resource representation if successful. The returned response is identical to that returned above when making a GET request.

Note: Authorization Documents can only be updated when in opened status. To edit, POST Status to opened.

AuthorizationDocuments Instance POST Optional Parameters

パラメーター 説明
AddressSid A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.
Email Email that this AuthorizationDocument will be sent to for signing.
CcEmails 委任状がCcされる人々のメールアドレスです。
Status The Status of this AuthorizationDocument. User can only update this to opened when AuthorizationDocument is in signing, or signing when AuthorizationDocument is in opened.
HostedNumberOrderSids A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.
コードサンプルを読み込んでいます...
Language
形式:
  • JSON
$ curl -X POST https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX51974a657d67dd0b5448fd0f87db2fb8 \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token' \
    -d "Status=opened" \
    -d "HostedNumberOrderSids="
    
{
    "status": "opened",
    "date_updated": "2018-01-21T23:10:19Z",
    "cc_emails": [
        "person1@example.com",
        "person1@example.com"
    ],
    "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX51974a657d67dd0b5448fd0f87db2fb8",
    "address_sid": "ADf632cf3795fcab7969d360e12e0db30a",
    "sid": "PX51974a657d67dd0b5448fd0f87db2fb8",
    "date_created": "2018-01-19T05:51:07Z",
    "email": "HostedSMS@twilio.com",
    "links": {
        "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX51974a657d67dd0b5448fd0f87db2fb8/DependentHostedNumberOrders"
    }
}
Remove all HostedNumberOrderSids from an Authorization Document

Note: Creating a new instance from the list resource is implicit. Any HostedNumberOrderSids passed will be the full list of HNOs. If a HostedNumberOrderSid is in pending-loa and assigned to a SigningDocumentSid, an error in the response will be received. To remove all HostedNumberOrderSids from the Authorization Document, you can POST with an empty parameter.

コードサンプルを読み込んでいます...
Language
形式:
  • JSON
$ curl -G https://preview.twilio.com/HostedNumbers/AuthorizationDocuments \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
{
    "items": [
        {
            "status": "opened",
            "date_updated": "2018-01-21T23:10:19Z",
            "cc_emails": [
                "person1@example.com",
                "person2@example.com"
            ],
            "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX51974a657d67dd0b5448fd0f87db2fb8",
            "address_sid": "ADf632cf3795fcab7969d360e12e0db30a",
            "sid": "PX51974a657d67dd0b5448fd0f87db2fb8",
            "date_created": "2018-01-19T05:51:07Z",
            "email": "HostedSMS@twilio.com",
            "links": {
                "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX51974a657d67dd0b5448fd0f87db2fb8/DependentHostedNumberOrders"
            }
        },
        {
            "status": "signed",
            "date_updated": "2018-01-19T05:14:00Z",
            "cc_emails": [],
            "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX1279c8aa750c4513e93fd121d0322e19",
            "address_sid": "ADdd118a3a836b88612a3a1bb5824d5568",
            "sid": "PX1279c8aa750c4513e93fd121d0322e19",
            "date_created": "2018-01-19T05:12:46Z",
            "email": "HostedSMS@twilio.com",
            "links": {
                "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX1279c8aa750c4513e93fd121d0322e19/DependentHostedNumberOrders"
            }
        }
    ],
    "meta": {
        "page": 0,
        "page_size": 50,
        "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0",
        "previous_page_url": null,
        "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0",
        "next_page_url": null,
        "key": "items"
    }
}
Get list of AuthorizationDocuments

AuthorizationDocuments List Resource

The AuthorizationDocuments list resource represents the list of active and inactive AuthorizationDocuments for the account.

リソースURI

preview.twilio.com/HostedNumbers/AuthorizationDocuments

リストフィルター

There are no list filters at this time.

HTTP GET

アカウントに対する全HostedNumberOrdersの一覧を返します。

コードサンプルを読み込んでいます...
Language
形式:
  • JSON
$ curl -X POST https://preview.twilio.com/HostedNumbers/AuthorizationDocuments \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
    -d "HostedNumberOrderSids=HR7e42fbbfb47d17baaae45d94c34ec4c3" \
    -d "HostedNumberOrderSids=HR18b3fc4bb26c368ceff1587ec26bf892" \
    -d "HostedNumberOrderSids=HR842cc9ce52ce257da378c2972f88fecc" \
    -d "HostedNumberOrderSids=HRc401d83d7d66901d2b65a4700457272d" \
    -d "AddressSid=AD1e20d20a7772e157c8ddbaba36aefef0" \ 
    -d "Email=owner@example.com" \
    -d "CcEmails=person1@example.com&CcEmails=person2@example.com" \
    
{
    "status": "signing",
    "date_updated": "2017-10-16T23:54:59Z",
    "cc_emails": [
        "person1@example.com",
        "person2@example.com"
    ],
    "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX5b7889b420ec6bca465c068f5bc2b67e",
    "address_sid": "AD1e20d20a7772e157c8ddbaba36aefef0",
    "sid": "PX5b7889b420ec6bca465c068f5bc2b67e",
    "date_created": "2017-10-16T23:54:58Z",
    "email": "owner@example.com"
}
Create new Authorization Document

HTTP POST

Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform. The resource is explicit and all Hosted Number Orders added upon creation are the entire list of numbers. Once the POST to create a new Authorization Document has been created, the LOA will immediately be sent out. To update the Authorization Document, update the Status to opened.

必須パラメーター

パラメーター 説明
Hosted Number Orders A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.
AddressSid これは電話番号の持ち主に関連づけられた住所に対応するAddressリソースへの参照です。 住所は委任状の中で参照されます。
Email 電話番号の所有者のメールアドレスです。 委任状ドキュメントに署名するには許可が必要です。

オプションパラメーター

パラメーター 説明
CCEmails 委任状ドキュメントがCcされるメールの一覧です。
Status The Status of this AuthorizationDocument. One of opened, signing, signed, canceled, or failed.

HTTP DELETE

There is no DELETE functionality for Authorization Documents List Resource.

ヘルプが必要ですか?

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

コードサンプルを読み込んでいます...
形式:
  • JSON
$ curl -G https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRd1af6b015e256ca5635dc9eff5526f7f \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
{
    "status": "twilio-processing",
    "unique_name": null,
    "date_updated": "2018-01-21T21:40:55Z",
    "cc_emails": [],
    "verification_code": null,
    "incoming_phone_number_sid": "PN876a18805574a952ffb73907b24205f0",
    "failure_reason": null,
    "verification_attempts": 0,
    "verification_type": "phone-call",
    "capabilities": {
        "voice": false,
        "mms": false,
        "sms": true
    },
    "sid": "HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "email": null,
    "phone_number": "+18444905863",
    "address_sid": null,
    "call_delay": 0,
    "signing_document_sid": null,
    "verification_document_sid": null,
    "verification_call_sids": [],
    "extension": null,
    "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "friendly_name": "MyHostedNumberSmsOrder",
    "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "date_created": "2018-01-21T21:40:55Z"
}
形式:
  • JSON
$ curl -X POST https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HR36f3f0c7c8d5d9210114fdcd8b6bcf19 \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token' \
    -d "FriendlyName=My_Sms_Hosted_Number_Order" \
{
    "status": "received",
    "date_updated": "2018-01-21T21:44:10Z",
    "verification_code": null,
    "incoming_phone_number_sid": "PN876a18805574a952ffb73907b24205f0",
    "failure_reason": null,
    "verification_attempts": 0,
    "verification_type": "phone-call",
    "capabilities": {
        "mms": false,
        "voice": false,
        "sms": true
    },
    "sid": "HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "phone_number": "+18444905863",
    "call_delay": 0,
    "signing_document_sid": null,
    "verification_document_sid": null,
    "verification_call_sids": [],
    "extension": null,
    "url": "https://https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "friendly_name": "My_Sms_Hosted_Number_Order",
    "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "date_created": "2018-01-21T21:40:55Z"
}
形式:
  • JSON
$ curl -XPOST https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HR36f3f0c7c8d5d9210114fdcd8b6bcf19
-u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
-d "VerificationType=phone-call"
-d "Status=pending-verification"
{
    "status": "pending-verification",
    "date_updated": "2018-01-21T22:31:43Z",
    "verification_code": "310001",
    "incoming_phone_number_sid": "PN876a18805574a952ffb73907b24205f0",
    "failure_reason": "",
    "verification_attempts": 1,
    "verification_type": "phone-call",
    "capabilities": {
        "voice": false,
        "mms": false,
        "sms": true
    },
    "sid": "HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "phone_number": "+18444905863",
    "call_delay": 0,
    "signing_document_sid": null,
    "verification_document_sid": "RI2ad9942e6daa7d8e87a154f6f675f3f8",
    "verification_call_sids": [
        "CA83f7aa47a1760188e892fe8c2ba86749"
    ],
    "extension": null,
    "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "friendly_name": "My_Sms_Hosted_Number_Order",
    "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "date_created": "2018-01-21T21:40:55Z"
}
形式:
  • JSON
$ curl -XPOST https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HR36f3f0c7c8d5d9210114fdcd8b6bcf19 
-u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
-d "VerificationType=phone-bill"
-d "VerificationDocumentSid=RI2ad9942e6daa7d8e87a154f6f675f3f8"
{
    "status": "received",
    "date_updated": "2018-01-21T22:16:11Z",
    "verification_code": null,
    "incoming_phone_number_sid": "PN876a18805574a952ffb73907b24205f0",
    "failure_reason": "",
    "verification_attempts": 0,
    "verification_type": "phone-bill",
    "capabilities": {
        "mms": false,
        "voice": false,
        "sms": true
    },
    "sid": "HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "phone_number": "+18444905863",
    "call_delay": 0,
    "signing_document_sid": null,
    "verification_document_sid": "RI2ad9942e6daa7d8e87a154f6f675f3f8",
    "verification_call_sids": [],
    "extension": null,
    "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "friendly_name": "My_Sms_Hosted_Number_Order",
    "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "date_created": "2018-01-21T21:40:55Z"
}
レスポンス形式:
  • JSON
$ curl -X DELETE https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
レスポンス形式:
  • JSON
形式:
  • JSON
$ curl -G https://preview.twilio.com/HostedNumbers/HostedNumberOrders \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
{
    "items": [
        {
            "status": "received",
            "date_updated": "2018-01-21T21:25:02Z",
            "verification_code": null,
            "incoming_phone_number_sid": "PN8b53cea1327fdb0f7f8f31364bfabe68",
            "failure_reason": null,
            "verification_attempts": 0,
            "verification_type": "phone-call",
            "capabilities": {
                "voice": false,
                "mms": false,
                "sms": true
            },
            "sid": "HR637848c52b3a2528cdda4c1b938dc902",
            "phone_number": "+18444905863",
            "call_delay": 0,
            "signing_document_sid": null,
            "verification_document_sid": null,
            "verification_call_sids": [],
            "extension": null,
            "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HR637848c52b3a2528cdda4c1b938dc902",
            "friendly_name": "My_Hosted_Number_Sms_Order",
            "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
            "date_created": "2018-01-21T21:19:04Z"
        }
    ],
    "meta": {
        "page": 0,
        "page_size": 50,
        "first_page_url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0",
        "previous_page_url": null,
        "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders?PageSize=50&Page=0",
        "next_page_url": null,
        "key": "items"
    }
}
形式:
  • JSON
$ curl -X POST https://preview.twilio.com/HostedNumbers/HostedNumberOrders \
    -d "PhoneNumber=+18444905863" \
    -d "SmsCapability=true"  \
    -d "FriendlyName=MyHostedNumberSmsOrder" \
    -d "StatusCallbackUrl=http://example.com/callback" \
    -d "StatusCallbackMethod=POST" \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
{
    "status": "twilio-processing",
    "date_updated": "2018-01-21T21:40:55Z",
    "verification_code": null,
    "incoming_phone_number_sid": "PN876a18805574a952ffb73907b24205f0",
    "failure_reason": null,
    "verification_attempts": 0,
    "verification_type": "phone-call",
    "capabilities": {
        "voice": false,
        "mms": false,
        "sms": true
    },
    "sid": "HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "phone_number": "+18444905863",
    "call_delay": 0,
    "signing_document_sid": null,
    "verification_document_sid": null,
    "verification_call_sids": [],
    "extension": null,
    "url": "https://preview.twilio.com/HostedNumbers/HostedNumberOrders/HR36f3f0c7c8d5d9210114fdcd8b6bcf19",
    "friendly_name": "MyHostedNumberSmsOrder",
    "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "date_created": "2018-01-21T21:40:55Z"
}
形式:
  • JSON
$ curl -G https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXeb2bd370aa325bec073ed6f2a9427ead
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
{
    "status": "signing",
    "date_updated": "2017-10-12T22:27:14Z",
    "cc_emails": [
        "hostedsms+test@twilio.com"
    ],
    "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PXeb2bd370aa325bec073ed6f2a9427ead",
    "address_sid": "AD1e20d20a7772e157c8ddbaba36aefef0",
    "sid": "PXeb2bd370aa325bec073ed6f2a9427ead",
    "date_created": "2017-10-12T22:27:13Z",
    "email": "hostedsms@twilio.com"
}
形式:
  • JSON
$ curl -X POST https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX51974a657d67dd0b5448fd0f87db2fb8
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token' \
    -d "CcEmails=person1@example.com&CcEmails=person2@example.com" \
    -d "Status=signing"
{
    "status": "opened",
    "date_updated": "2018-01-21T23:08:24Z",
    "cc_emails": [
        "person1@example.com",
        "person2@example.com"
    ],
    "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX51974a657d67dd0b5448fd0f87db2fb8",
    "address_sid": "ADf632cf3795fcab7969d360e12e0db30a",
    "sid": "PX51974a657d67dd0b5448fd0f87db2fb8",
    "date_created": "2018-01-19T05:51:07Z",
    "email": "HostedSMS@twilio.com",
    "links": {
        "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX51974a657d67dd0b5448fd0f87db2fb8/DependentHostedNumberOrders"
    }
}
形式:
  • JSON
$ curl -X POST https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX51974a657d67dd0b5448fd0f87db2fb8 \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token' \
    -d "Status=opened" \
    -d "HostedNumberOrderSids="
    
{
    "status": "opened",
    "date_updated": "2018-01-21T23:10:19Z",
    "cc_emails": [
        "person1@example.com",
        "person1@example.com"
    ],
    "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX51974a657d67dd0b5448fd0f87db2fb8",
    "address_sid": "ADf632cf3795fcab7969d360e12e0db30a",
    "sid": "PX51974a657d67dd0b5448fd0f87db2fb8",
    "date_created": "2018-01-19T05:51:07Z",
    "email": "HostedSMS@twilio.com",
    "links": {
        "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX51974a657d67dd0b5448fd0f87db2fb8/DependentHostedNumberOrders"
    }
}
形式:
  • JSON
$ curl -G https://preview.twilio.com/HostedNumbers/AuthorizationDocuments \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
{
    "items": [
        {
            "status": "opened",
            "date_updated": "2018-01-21T23:10:19Z",
            "cc_emails": [
                "person1@example.com",
                "person2@example.com"
            ],
            "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX51974a657d67dd0b5448fd0f87db2fb8",
            "address_sid": "ADf632cf3795fcab7969d360e12e0db30a",
            "sid": "PX51974a657d67dd0b5448fd0f87db2fb8",
            "date_created": "2018-01-19T05:51:07Z",
            "email": "HostedSMS@twilio.com",
            "links": {
                "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX51974a657d67dd0b5448fd0f87db2fb8/DependentHostedNumberOrders"
            }
        },
        {
            "status": "signed",
            "date_updated": "2018-01-19T05:14:00Z",
            "cc_emails": [],
            "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX1279c8aa750c4513e93fd121d0322e19",
            "address_sid": "ADdd118a3a836b88612a3a1bb5824d5568",
            "sid": "PX1279c8aa750c4513e93fd121d0322e19",
            "date_created": "2018-01-19T05:12:46Z",
            "email": "HostedSMS@twilio.com",
            "links": {
                "dependent_hosted_number_orders": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX1279c8aa750c4513e93fd121d0322e19/DependentHostedNumberOrders"
            }
        }
    ],
    "meta": {
        "page": 0,
        "page_size": 50,
        "first_page_url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0",
        "previous_page_url": null,
        "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments?PageSize=50&Page=0",
        "next_page_url": null,
        "key": "items"
    }
}
形式:
  • JSON
$ curl -X POST https://preview.twilio.com/HostedNumbers/AuthorizationDocuments \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
    -d "HostedNumberOrderSids=HR7e42fbbfb47d17baaae45d94c34ec4c3" \
    -d "HostedNumberOrderSids=HR18b3fc4bb26c368ceff1587ec26bf892" \
    -d "HostedNumberOrderSids=HR842cc9ce52ce257da378c2972f88fecc" \
    -d "HostedNumberOrderSids=HRc401d83d7d66901d2b65a4700457272d" \
    -d "AddressSid=AD1e20d20a7772e157c8ddbaba36aefef0" \ 
    -d "Email=owner@example.com" \
    -d "CcEmails=person1@example.com&CcEmails=person2@example.com" \
    
{
    "status": "signing",
    "date_updated": "2017-10-16T23:54:59Z",
    "cc_emails": [
        "person1@example.com",
        "person2@example.com"
    ],
    "url": "https://preview.twilio.com/HostedNumbers/AuthorizationDocuments/PX5b7889b420ec6bca465c068f5bc2b67e",
    "address_sid": "AD1e20d20a7772e157c8ddbaba36aefef0",
    "sid": "PX5b7889b420ec6bca465c068f5bc2b67e",
    "date_created": "2017-10-16T23:54:58Z",
    "email": "owner@example.com"
}