REST API: 電話番号の移管

概要

電話番号移管のためのREST APIには下記の中心となるリソースがあります:

  1. Port Orderインスタンスリソースは、お客様がTwilioへの移管を希望する電話番号が含まれる単一の移管リクエストを表します。
  2. Port LOAsインスタンスリソースは、移管をリクエストするお客様に代わってひとつまたは複数の電話番号のTwilioの移管をTwilioに許可するための単一の電子委任状(LOA=Letter of Authorization)を表します。 このインスタンスリソースは対応するPort Ordersインスタンスリソースの作成時にTwilioに送信された情報を使用して自動的に作成されます。
  3. Port OrdersリストリソースはアカウントSIDで識別されるTwilioアカウントまたはサブアカウントに関連づけられた、現在Twilioへ移管中の全電話番号の一覧を表します。
  4. Port Order LOAsリストリソースは、アカウントSIDによって識別されるアカウント、またはサブアカウントに関連づけられた全Port Order LOAドキュメントの一覧を表します。 Port OrderリストリソースへのPOSTリクエストの発行によるTwilioの新規移管リクエストの開始は、対応するPort OrdersおよびPort LOAsインスタンスリソースを作成します。

Port Orderインスタンスリソース

Port Orderインスタンスリソースは、お客様がTwilioへの移管を希望する電話番号が含まれる単一の移管リクエストを表します。

リソースURI

preview.twilio.com/porting/PortOrders/{PortOrderSid}

リソースのプロパティ

プロパティ 説明
sid このリソースを一意に識別する 34 文字の文字列です。
番号 このリソース内の移管元電話番号です。 +815012345678のようなE.164形式であることが必要です。
friendly_name このリソースを表す最大64文字の人間にとって読み取りやすい文字列です。 既定では、移管元電話番号を読みやすくフォーマットしたものになります。
status このリソースのステータスです。 下記の値のうちのいずれかを保持します: 1. CREATED(作成済)、2. PENDING(保留中)、3. SUBMITTED(送信済)、4. ACCEPTED(承認済)、5. COMPLETED(完了)、6. CANCELED(キャンセル済)、7. REJECTED(否認済)、8. FAILED(失敗)、9. REVIEW(レビュー) 各ステータスの詳細情報については、Port Ordersステータス値というタイトルのセクションを参照してください。
date_created このリソースが作成された日時です。 ISO 8601形式で取得されます。
date_updated このリソースが更新された日時です。 ISO 8601形式で取得されます。
loa_sid このリソースに関連づけられた電子委任状を一意に識別する34文字の文字列からなるPort Order LOAインスタンスのサブリソースSIDです。
iso_country 移管元の電話番号に関連づけられた事業者住所ですISO 3166-1 アルファ2の国コードです。 例: 「US」
region 移管元の電話番号に関連づけられた事業者住所の地域名です。 取りうる値は米国の2文字の州名です。 (例: 「CA」)
住所3(市区町村) 移管元の電話番号に関連づけられた事業者住所の都市名です。
postal_code 移管元の電話番号に関連づけられた事業者住所の郵便番号です。
番地 移管元の電話番号に関連づけられた事業者住所の番地名です。
company_name 移管元の電話番号を所有している企業名です。 このリソースに関連づけられる委任状(LOA)内の「Business Name」欄への入力にこの名前を使用する点に注意してください。
first_name 移管元の電話番号を所有している個人のファーストネームです。 このリソースに関連づけられる委任状(LOA)内の「First Name」欄への入力にこの名前を使用し、またこの個人が委任状に対して許諾、署名する人物でなければならない点に注意してください。
last_name 移管元の電話番号を所有している個人のラストネームです。 このリソースに関連づけられる委任状(LOA)内の「Last Name」欄への入力にこの名前を使用し、またこの個人が委任状に対して許諾、署名する人物でなければならない点に注意してください。
Email 移管元の電話番号を所有している個人のメールアドレスです。 この個人が委任状に対して許諾、署名する人物でなければならない点に注意してください。
status_updates_email Port Orderが移管のライフサイクルを経るごとにステータス更新を受信する個人のメールアドレスです。 このメールアドレスが指定されると、"email"フィールドに指定されたメールアドレスはステータス更新を受信しなくなり、委任状への署名にのみ使用されます。
ssn_last_four 移管元の電話番号を所有している個人の社会保障番号の下4桁です。 この個人が委任状に対して許諾、署名する人物でなければならない点に注意してください。 また、この項目はGETリクエストに対するAPIレスポンスとして返却されないことに注意してください。
activation_date 希望するFirm Order Commitment (FCC) の日付と時間で、番号が移管される日時を表します。 もし最短のFCCの日付が指定されたものより遅い場合には上書きされる点に注意してください。 ISO 8601フォーマットであることが必要です。 アクティベーション日のリクエストの際は、このフィールドに日付と時間の両方を含んでいることを確認してください。 (例: 「2017-07-10T07:48:59+00:00」、または「2017-07-10T07:48:59Z」)
submitted_date Port OrderリクエストがTwilioと契約しているプロバイダーまたはキャリアーに提出された日時です。 ISO 8601形式となります。
billing_phone_number この移管リクエストの移管元の電話番号に関連づけられた(現在お使いのプロバイダーまたはキャリアーの)アカウントのメインの請求先電話番号です。 +815012345678のようなE.164形式であることが必要です。
account_number 移管元の電話番号に紐づけられた(現在のプロバイダー/キャリアーの)アカウントのアカウント番号です。これは携帯電話番号には必須ですが、固定電話またはフリーダイヤルの場合はオプションです。この項目はAPIのGETリクエストへのレスポンスには含まれません。
pin_number 移管元の電話番号に関連づけられた、(現在のプロバイダーまたはキャリアーの)アカウントの暗証番号です。 これは携帯電話番号には必須ですが、固定電話または着課金の場合はオプションです。 また、この項目はGETリクエストに対するAPIレスポンスとして返却されないことに注意してください。
incoming_phone_number_sid 移管元の電話番号を一意に識別する、34文字の移管元電話番号SIDです。
status_callback 移管リクエストのステータスが変更されるごとにTwilioがPOSTするURLです。 ステータスコールバックのペイロードの構造については、Port Ordersステータスコールバックのペイロードというタイトルのセクションを参照してください。
cc_emails 移管リクエストのステータスがDelivered、Failed、Campletedのいずれかに変化するごとにTwilioからのメール通知が配信されるべき人のメールアドレスの配列です。
reason_code このリソースのステータス変更の理由を表す一意な整数のコードです。
reason このリソースのステータス変更理由を記述する、人間にとって読み取りやすい文章です。
エラー 移管リクエストがそのライフタイムでこれまで発生した全エラーの配列です。 各エラーにはエラー発生の日時に関連づけられたタイムスタンプがあります。 errorオブジェクトについての詳細情報は、Port Orderエラーというタイトルのセクションを参照してください。
url このリソースに対するURLです。

Port Orderステータスコールバックのペイロード

プロパティ 説明
port_order_sid Port Orderインスタンスリソースを一意に識別する34文字の文字列です。
callback_type コールバックの型の配列です。 2種類のコールバック型があります。 (1) status_update、そして (2) activation_date_update の2つです。 「status_update」型は、Port Orderリクエストステータスが変更されたことを意味しています。 「activation_date_update」型は、Port OrderリクエストのFOC日時の更新があったことを意味しています。 同時にこれら2つの更新が発生した場合は、この配列には「status_update」および「activation_date_update」の両方の文字列を含みます。
status Port Orderリクエストのステータスです。 詳細情報については、Port Orderのステータス値セクションを参照してください。
foc_date Port OrderリクエストのFOCの日付です。
date_updated このPort Orderリクエストが更新された日付で、ISO 8601フォーマットで返されます。
phone_number_sid 移管元の電話番号を一意に識別する、34文字の移管元電話番号SIDです。
エラー 移管リクエストがそのライフタイムでこれまで発生した全エラーの配列です。 各エラーにはエラー発生の日時に関連づけられたタイムスタンプがあります。 errorオブジェクトについての詳細情報は、Port Orderエラーというタイトルのセクションを参照してください。

Port Orderステータス値

Status 説明
Created Twilioは移管リクエストを受信し、Twilioへの番号移管が可能かどうか確認しています。
PENDING 移管リクエストに対する委任状が生成されましたが、移管のリクエストをされた顧客はまだこの委任状に署名をしていません。
申請済み 移管リクエストに対するLOAが承認され、移管プロセスを開始するためにTwilioの使用するプロバイダー/キャリアーに対して電話番号が送信されました。
accepted Twilioと契約しているプロバイダーまたはキャリアーによって許諾され、移管プロセスが開始されました。
completed 移管プロセスが終了し、電話番号の使用準備が整いました。
Canceled 移管リクエストが(通常はエンドユーザーまたはコンシューマーによって)キャンセルされました。 しかしこれはTwilioの内部プロセス、あるいはTwilioの契約しているキャリアー側によって引き起こされる場合もあります。 この時点で、同一の移管リクエストを編集および再申請することは出来なくなります。
Rejected 移管リクエストがその電話番号の現在のプロバイダーまたはキャリアーによって拒否されました。 この時点で、同一の移管リクエストを再申請することは出来なくなります。
FAILED 移管リクエストに失敗しました。この時点で、同一の移管リクエストを再申請することは出来なくなります。
REVIEW 移管リクエストが移管APIの通常のワークフローで処理不能な状態に入り、現在はTwilioの移管オペレーターによって手動で処理されています。 移管の進捗に応じて、通常どおりステータス変更を伴って更新を送信します。

Port Orderエラー

プロパティ 説明
日付 port orderによってこのエラーが発生した日時で、ISO 8601形式で返されます。
code Port Orderによって発生したエラーを表す一意な整数コードです。
reason Port Orderによって発生したエラーを説明した、人間が読み取りやすいテキストです。

Port Orderに関連するエラー

コード 名前 説明
21801 Port Order: E.164形式の着信電話番号が見つかりません Twilioに移管する電話番号が指定されませんでした。 
21802 移管オーダー: 現在のプロバイダーにおける電話番号の事業者住所のISO 3166-1 alpha-2国番号が見つかりません 現在の電話サービスプロバイダーの顧客サービス記録と同様に移管元電話番号のサービスアドレスに国番号が指定しませんでした。
21803 Port Order:: 現在の提供者の電話番号の事業者住所の州または地域が見つかりません 移管する電話番号の事業者住所の番地が、現在ご利用のサービスプロバイダーでカスタマーサービスレコードのとおりに指定されていませんでした。
21804 番号移管オーダー: 移管前のプロバイダーで電話番号のサービス・アドレスの都市が指定されていません 移管する電話番号のサービス・アドレスの都市が、現在ご利用のサービス・プロバイダーでカスタマー・サービス・レコードのとおりに指定されていませんでした。
21805 Port Order: 現在のプロバイダーの電話番号の事業者住所の郵便番号が見つかりません 移管する電話番号の事業者住所の都市が、現在ご利用のサービスプロバイダーでカスタマー・サービスレコードのとおりに指定されていませんでした。
21806 番号移管オーダー: 移管前のプロバイダーで電話番号のサービス・アドレスの番地が指定されていません 移管する電話番号のサービス・アドレスの番地が、現在ご利用のサービス・プロバイダーでカスタマー・サービス・レコードのとおりに指定されていませんでした。
21807 Port Order: 許諾した署名者のファーストネームが見つかりません 移管する電話番号の持ち主で、関連する承諾書に署名する権限を持つ人物の名(ファーストネーム)が指定されませんでした。
21808 番号移管オーダー: 認証された署名者の氏(苗字)が見つかりません 移管する電話番号の持ち主で、関連する委任状に署名する権限を持つ人物のラストネームが指定されませんでした。
21809 Port Order: アカウント番号が見つかりません(携帯電話番号のみ) 移管元電話番号に関連づけられた暗証番号が指定されませんでした。 これは携帯電話番号には必須ですが、固定電話または着課金の番号の場合はオプションです。
21810 Port Order: 暗証番号が見つかりません(ワイヤレス番号のみ) 移管元電話番号に紐づけられた暗証番号が指定されませんでした。これは携帯電話番号には必須ですが、固定電話またはフリーダイヤルの場合はオプションです。
21811 番号移管オーダー: 権限付与署名者のメールアドレスが見つかりません (LOAの署名のみ) 移管元電話番号に関連づけられた暗証番号が指定されませんでした。
21812 Port Order: 無効な着信電話番号です (E.164形式である必要があります) 指定された移管元電話番号が無効です。 +815012345678のようなE.164形式であることが必要です。
21813 Port Order: 無効な国コードです (ISO 3166-1 alpha-2 形式である必要があります) 移管元電話番号の事業者住所の国コードが無効です。 これは「US」のような、ISO 3166-1 alpha-2形式でなければなりません。
21814 Port Order: 無効なアクティベーション日です (ISO 8601形式である必要があります) 有効化の希望、または確定オーダーコミットメントの日時、言い換えれば番号が移管される日時の指定が有効ではありません。 ISO 8601形式でなければなりません。
21815 Port Order: 無効な請求先電話番号です (E.164形式である必要があります) 指定された課金対象の電話番号が無効です。 +815012345678のようなE.164形式であることが必要です。
21816 Port Order: 無効な暗証番号です 指定された暗証番号が無効です。
21817 Port Order: 社会保障番号の最後の4桁が無効です 指定された社会保障番号の最後の4桁が無効です。
21818 Port Order: 無効なメールアドレスです 指定されたメールアドレスが無効です。
21819 Port Order: 無効なコールバックURLです 指定されたコールバックURLが無効です。
21820 番号移管オーダー: CCリスト中に無効なメールアドレスがあります(有効なメールアドレスの配列である必要があります) 指定したひとつまたは複数のメールアドレスが無効です。
21822 Port Order: 無効なステータスです 指定されたステータスが無効です。 各ステータスの詳細情報については、Port Ordersステータス値というタイトルのセクションを参照してください。
21824 番号移管オーダー: 社会保障番号の最後の4桁が指定されていません 移管する電話番号の持ち主で、関連する承諾書に署名する認証を持つ人物の社会保障番号の最後の4桁が指定されませんでした。 これは携帯電話番号には必須ですが、固定電話またはフリーダイヤルの場合はオプションです。
21825 Port Order: Before SIDが無効です 指定されたSIDが無効です。
21826 Port Order: After SIDが無効です 指定されたSIDが無効です。
21827 番号移管オーダー: 着信用電話番号は移管できません 電話番号は移管できません。 番号がすでにTwilioに存在しているか、この番号がTwilioによる移管をサポートしていないことが原因として考えられます。
21828 Order: 承諾した署名者の名前が無効です 移管元電話番号の持ち主で、かつ委任状を許諾し署名する個人の、指定されたファーストネームおよび(また)ラストネームが無効です。
21829 Port Order: Port Orderは変更できません 移管リクエストはこれ以上変更できません。 Port Orderインスタンスリソースは、そのステータスが「Created」または「Received」の場合に限り変更可能です。
21830 Port Order: Port Orderはキャンセルできません この移管リクエストはもうキャンセルできません。 いったん「Completed」ステータスとなった移管リクエストはキャンセルできません。
21831 移管オーダー: 移管できません 移管リクエストが現在の電話番号サービスプロバイダーによって否認されました。 詳細情報については、「なぜ移管リクエストが否認されたのですか」を参照してください。
21832 Port Order: 携帯電話番号のPort Orderは、委任状の署名後はキャンセルできません この移管リクエストはもうキャンセルできません。携帯電話の移管リクエストはそのステータスが「Created」、「Received」、または「Submitting」のいずれかである間のみキャンセル可能です。
21833 Port Order: FOC日時が48時間以内のためPort Orderはキャンセルできません FOC日時(つまり番号が移管された日)から48時間以内はこのPOSTリクエストはキャンセルできません。
21834 Port Order: 無効な住所です: 電話番号の事業者住所の番地は指定された市、州、郵便番号と一致しません 指定された番地名がPort Orderに指定した都市、州、および(または)郵便番号には存在しません。
21835 Port Order: Port Orderが完了できません Port Orderが完了できません。 これはTwilioの背後のキャリアーで電話番号の移管サポートの準備ができていないか、お客様の現在のキャリアーが移管リクエストを拒否したかのいずれかの理由によります。
21836 Port Order: アカウント番号が見つかりません(携帯番号のみ)、および社会保障番号の最後の4桁が見つかりません(携帯番号のみ) 移管元の電話番号の持ち主の社会保障番号の最後の4桁に関連づけられたアカウント番号が指定されませんでした。 これは携帯電話番号には必須ですが、固定電話または着課金の番号の場合はオプションです。
21837 移管オーダー: 着信電話番号はすでに別の移管オーダーでの移管プロセスに入っています。 移管元の電話番号がすでに署名済みの委任状の一部になっています。
21838 Port Order: 着信電話番号がすでにTwilioのインベントリーに存在します。 サポートにお問い合わせください 移管元の電話番号がすでにTwilioのインベントリーに存在し、移管できません。 サポートにお問い合わせください。

HTTP GET

リクエストされた移管オーダーインスタンスリソースSID、または{PortOrderSid}によって指定された既存の単一の移管オーダーインスタンスリソースを返します。

リクエスト
$ curl -G https://preview.twilio.com/porting/PortOrders/PO800f449d0399ed014aae2bcc0cc2f2ec \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
レスポンス
{
    "last_name": "Smith",
    "date_updated": "2017-07-05T11:29:34Z",
    "cc_emails": ["blah@twilio.com", "porting@twilio.com"],
    "number": "+14153077754",
    "incoming_phone_number_sid": "PN00f449d0399ed014aae2bcc0cc245lf",
    "street": "645 Random St",
    "postal_code": "94107",
    "port_type": "UNKNOWN",
    "city": "San Francisco",
    "first_name": "Jim",
    "errors": [{
      "code": 21835,
      "date": "2017-07-05T11:29:30.627Z",
      "reason": "Unable to port in number [14153077754] - number exists as an LRN."
    },...]
    "company_name": "Random Inc",
    "sid": "PO800f449d0399ed014aae2bcc0cc2f2ec",
    "activation_date": "2017-07-025T11:29:34Z",
    "email": "jim.smith@random.com",
    "status_updates_email": "joe.smith@random.com",
    "status": "REJECTED",
    "current_carrier": "Some Carrier",
    "billing_phone_number": null,
    "url": "https://preview.dev.twilio.com/porting/PortOrders/POb6e35c042f7689baf321b1f84be6a053",
    "earliest_activation_date": null,
    "loa_sid": "PX0fff0afcc9eda017f42674b7a0cc9f38",
    "friendly_name": "Random123",
    "iso_country": "US",
    "account_number": "7754",
    "date_created": "2017-07-05T11:28:38Z",
    "region": "CA",
    "status_callback": "http://someurl.io"
}

HTTP POST/PUT

単一の、既に存在するPort Orderインスタンスリソースのプロパティーの更新を試み、成功した場合は更新済みリソースの表現を返します。 返却されるレスポンスはGETリクエストの送信時に返却されるものと同一です。 既に存在するPort Orderインスタンスリソースの、事業者住所の値とFOC日を含むプロパティーはリソースが「CREATED」または「REJECTED」ステータスの場合のみ更新できる点に注意してください。

HTTP DELETE

移管リクエストをキャンセルし(結果としてこの移管リクエストの電話番号の移管もキャンセルされます)、Port Orderインスタンスリソースのステータスを「CANCELED」に設定します。 返されたレスポンスはGETリクエストの発行時に上記で返されたものと同一です。

Port Order LOAsインスタンスリソース

Port Order LOAsインスタンスリソースは、移管をリクエストするお客様に代わってひとつまたは複数の電話番号のTwilioの移管をTwilioに許可するための単一の電子委任状(LOA=Letter of Authorization)を表します。 このインスタンスリソースは対応するPort Ordersインスタンスリソースの作成時にTwilioに送信された情報を使用して自動的に作成されます。

リソースURI

preview.twilio.com/porting/Loas/{PortLOASid}

リソースのプロパティ

プロパティ 説明
sid このリソースを一意に識別する 34 文字の文字列です。
status このリソースのステータスです。 1. open, 2. signing, 3. signed, or 4. canceled のいずれかの値を保持しています
uri このリソースのURIで、https://preview.twilio.comに対して相対的です

Port Order LOAに関連するエラー

コード 名前 説明
21901 Port Order LOA: 無効なSIDです 指定されたSIDが無効です。
21904 Port Order LOA: 無効なステータスです 指定されたステータスが無効です。
21905 移管オーダーLOA: 署名リクエストはすでに送信されています LOAはすでに署名されています。

HTTP GET

リクエストされたPort Order LOAインスタンスリソースSID、または{PortLOASid}によって指定された単一で既存のPort Order LOAインスタンスリソースを返します。

リクエスト
$ curl -G https://preview.twilio.com/porting/Loas/PX800f449d0399ed014aae2bcc0cc2f2ec \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token'
レスポンス
{
    "status": "signing",
    "first_name": "Jim",
    "last_name": "Smith",
    "sid": "PX800f449d0399ed014aae2bcc0cc2f2ec",
    "email": "jim.smith@random.com"
}

HTTP POST

このリソースへの空のBodyを伴ったPOSTリクエストの発行によって、一つまたは複数の移管リクエストに関連づけられた単一かつ既存のPort Order LOAインスタンスリソースが更新され、委任状の署名プロセスが開始されます。 これにより、紐付けられた移管リクエストで指定されたメールアドレス宛にメールが送信されます。単一のPort Order LOAsインスタンスリソースは同一の名前、住所、移管のタイプ、およびTwilioアカウントを共有する複数のPort Orderインスタンスリソースに関連づけられることに注意してください。

リクエスト
$ curl -XPOST https://preview.twilio.com/porting/Loas/PX800f449d0399ed014aae2bcc0cc2f2ec \ 
    -H "Content-Type: application/json" \
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token' \
    -d ''
レスポンス

返されたレスポンスはGETリクエストの発行時に上記で返されたものと同一です。

HTTP PUT

利用できません。

HTTP DELETE

利用できません。

Port Orderリストリソース

Port OrdersリストリソースはアカウントSIDで識別されるTwilioアカウントまたはサブアカウントに関連づけられた、現在Twilioへ移管中の全電話番号の一覧を表します。

リソースURI

preview.twilio.com/porting/PortOrders

リストフィルター

リストリソースに対して特定のクエリー文字列パラメーターを指定することで一覧を制限できます。 このパラメーターは大文字と小文字を区別する点に注意してください。

パラメーター 説明
Sid Port Orderを、そのリソースを一意に識別する34文字の文字列から取得します。
AccountSid この34文字の文字列で一意に識別されるアカウントに関連づけられたPort Orderの一覧を取得します。
会社名 この名称の企業に関連づけられたPort Orderの一覧を取得します。
Email このメールアドレスの個人が所有する電話番号のPort Orderの一覧を取得します。
LoaSid この34文字の文字列で一意に識別されるアカウントに関連づけられたPort Orderの一覧を取得します。
ProviderSid この34文字の文字列によって一意に識別されるプロバイダーによってホストされていた、またはこれからホストされる電話番号のPort Orderの一覧を取得します。
ZendeskId この34文字の文字列で一意に識別されるZendeskチケットに関連づけられたPort Orderの一覧を取得します。
ActivationDateMin ISO 8601形式で指定されたこの日時以前にアクティベートされる(された)Port Orderの一覧を取得します。
ActivationDateMax ISO 8601形式で指定されたこの日時以前にアクティベートされる(された)Port Orderの一覧を取得します。
IncomingPhoneNumberSid この34文字の文字列で一意に識別される電話番号を伴ったPort Orderの一覧を取得します。
番号 この電話番号のPort Orderの一覧を返します。 +815012345678のようなE.164形式であることが必要です。
Status この状態のPort Orderの一覧を取得します。 下記の値のうちのいずれかを保持します: 1. CREATED(作成済)、2. PENDING(保留中)、3. SUBMITTED(送信済)、4. ACCEPTED(承認済)、5. COMPLETED(完了)、6. CANCELED(キャンセル済)、7. REJECTED(否認済)、8. FAILED(失敗)、9. REVIEW(レビュー)
FriendlyName この「分かりやすい名前」を含むPort Orderの一覧を取得します。
PageSize これら多数のPort Orderを取得します。
BeforeSid 全Port Orderの一覧の中から、このSIDを持つPort Order以前のPort Orderの一覧を取得します。
AfterSid 全Port Orderの一覧の中から、このSIDを持つPort Order以降のPort Orderの一覧を取得します。

HTTP GET

フレンドリーネーム “Random123” を持つすべての移管オーダーの一覧を返します。

リクエスト
$ curl -G https://preview.twilio.com/porting/PortOrders \ 
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token' \
    -d "FriendlyName=Random123" \
レスポンス
{
    "meta": {
      "page": 0,
      "page_size": 50,
      "first_page_url": "https://preview.twilio.com/porting/PortOrders?PageSize=50&Page=0",
      "previous_page_url": null,
      "url": "https://preview.twilio.com/porting/PortOrders?PageSize=50&Page=0",
      "next_page_url": "https://preview.dev.twilio.com/porting/PortOrders?PageSize=50&Page=1",
      "key": "orders"
    },
    "orders": [{
      "last_name": "Smith",
      "date_updated": "2017-07-05T11:29:34Z",
      "cc_emails": ["blah@twilio.com", "porting@twilio.com"],
      "number": "+14153077754",
      "incoming_phone_number_sid": "PN00f449d0399ed014aae2bcc0cc245lf",
      "street": "645 Random St",
      "postal_code": "94107",
      "port_type": "UNKNOWN",
      "city": "San Francisco",
      "first_name": "Jim",
      "errors": [{
        "code": 21835,
        "date": "2017-07-05T11:29:30.627Z",
        "reason": "Unable to port in number [14153077754] - number exists as an LRN."
      },...],
      "company_name": "Random Inc",
      "sid": "PO800f449d0399ed014aae2bcc0cc2f2ec",
      "activation_date": "2017-07-025T11:29:34Z",
      "email": "jim.smith@random.com",
      "status_updates_email": "joe.smith@random.com",
      "status": "REJECTED",
      "current_carrier": "Some Carrier",
      "billing_phone_number": null,
      "url": "https://preview.dev.twilio.com/porting/PortOrders/POb6e35c042f7689baf321b1f84be6a053",
      "earliest_activation_date": null,
      "loa_sid": "PX0fff0afcc9eda017f42674b7a0cc9f38",
      "friendly_name": "Random123",
      "iso_country": "US",
      "account_number": "7754",
      "date_created": "2017-07-05T11:28:38Z",
      "region": "CA",
      "status_callback": "http://someurl.io"
    },...]
}

HTTP POST

Twilioに移管される電話番号を含む単一の新規Port Orderインスタンスリソースの作成によって、単一の新規移管リクエストを開始します。

必須パラメーター

パラメーター 説明
番号 移管元電話番号は、+815012345678のようなE.164形式であることが必要です。
iso_country 移管元の電話番号に関連づけられた事業者住所のISO 3166-1 アルファ2の国コードです。 例: 「US」
region 移管元の電話番号に関連づけられた事業者住所の地域名です。 取りうる値は米国の2文字の州名です。 (例: 「CA」)
住所3(市区町村) 移管元の電話番号に関連づけられた事業者住所の都市名です。
postal_code 移管元の電話番号に関連づけられた事業者住所の郵便番号です。
番地 移管元の電話番号に関連づけられた事業者住所の番地名です。
first_name 移管元の電話番号を所有している個人のファーストネームです。 このリソースに関連づけられる委任状(LOA)内の「First Name」欄への入力にこの名前を使用し、またこの個人が委任状に対して許諾、署名する人物でなければならない点に注意してください。
last_name 移管元の電話番号を所有している個人のラストネームです。 このリソースに関連づけられる委任状(LOA)内の「Last Name」欄への入力にこの名前を使用し、またこの個人が委任状に対して許諾、署名する人物でなければならない点に注意してください。
Email 移管元の電話番号を所有している個人のメールアドレスです。 この個人が委任状に対して許諾、署名する人物でなければならない点に注意してください。

オプションパラメーター

パラメーター 説明
friendly_name このリソースに対する、人間にとって読み取りやすい最大64文字までの説明文です。 既定では、これは電話番号を読みやすくフォーマットしたものになります。
company_name 移管元の電話番号を所有している企業名です。 このリソースに関連づけられる委任状(LOA)内の「Business Name」欄への入力にこの名前を使用する点に注意してください。
billing_phone_number この移管リクエストの移管元の電話番号に関連づけられた(現在お使いのプロバイダーまたはキャリアーの)アカウントのメインの請求先電話番号です。 +815012345678のようなE.164形式であることが必要です。
account_number この移管リクエストの移管元の電話番号に関連づけられた(現在お使いのプロバイダーまたはキャリアーの)アカウント番号です。これは携帯電話番号には必須ですが、固定電話またはフリーダイヤルの場合はオプションです。
pin_number この移管リクエストの移管元の電話番号に関連づけられた(現在お使いのプロバイダーまたはキャリアーの)暗証番号です。 これは携帯電話番号には必須ですが、固定電話またはフリーダイヤルの場合はオプションです。
ssn_last_four 移管元の電話番号を所有している個人の社会保障番号の下4桁です。 この個人が委任状に対して許諾、署名する人物でなければならない点に注意してください。 これは携帯電話番号には必須ですが、固定電話または着課金の番号の場合はオプションです。
activation_date 希望するFirm Order Commitment (FOC) の日時で、ISO 8601形式で指定します – つまり、番号の移管される日時のことです。 もっとも早く手配できる日付が、指定された日付より後日になる場合にはこれは上書きされます。
status_callback 移管リクエストのステータスがDelivered、Failed、Campletedのいずれかに変化するごとにTwilioからのPOSTリクエストが送信されるURLです。
status_updates_email Port Orderが移管のライフサイクルを経るごとにステータス更新を受信する個人のメールアドレスです。 このメールアドレスが指定されると、"email"フィールドに指定されたメールアドレスはステータス更新を受信しなくなり、委任状への署名にのみ使用されます。
cc_emails 移管リクエストのステータスがDelivered、Failed、Campletedのいずれかに変化するごとにTwilioからのメール通知が配信されるべき人のメールアドレスの配列です。
リクエスト
$ curl -XPOST https://preview.twilio.com/porting/PortOrders \
    -H "Content-Type: application/json" \
    -d '{"number":"+14153077754","iso_country":"US","region":"CA","city":"SAN FRANCISCO","postal_code":94107,"street":"645 Harrison st.","first_name":"James","last_name":"The Third","email":"james.thethird@random.com"}'  \
    -u "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token"
レスポンス

返却されるレスポンスは、Port OrdersインスタンスリソースへのGETリクエストの発行に対して返却されるものと同一です。

HTTP PUT

利用できません。

HTTP DELETE

利用できません。

Port Order LOAsリストリソース

Port Order LOAsリストリソースは、アカウントSIDによって識別されるアカウント、またはサブアカウントに関連づけられた全Port Order LOAドキュメントの一覧を表します。

リソースURI

preview.twilio.com/porting/Loas

リストフィルター

リストリソースに対して特定のクエリー文字列パラメーターを指定することで一覧を制限できます。 このパラメーターは大文字と小文字を区別する点に注意してください。

パラメーター 説明
Sid 委任状ドキュメントを、そのリソースを一意に識別する34文字の文字列から取得します。
Status この状態のPort Order LOAドキュメントの一覧を取得します。 以下のいずれかの値を保持します: 1. OPEN、2. SIGNING、3. SIGNED、4. CANCELED、そして5. REVIEWです。
このファーストネームの持ち主が所有する電話番号のPort Order LOAドキュメントの一覧を取得します。
このラストネームの持ち主が所有する電話番号のPort Order LOAドキュメントの一覧を取得します。
Email このメールアドレスの持ち主が所有する電話番号のPort OrderのPort Order LOAドキュメントの一覧を取得します。
BeforeSid 全Port Orderの一覧からこのSIDを持つPort Order以前のPort Order LOAドキュメントの一覧を取得します。
AfterSid 全Port Orderの一覧からこのSIDを持つPort Order以降のPort Order LOAドキュメントの一覧を取得します。
PageSize これら多数のPort Order LOAドキュメントを取得する

HTTP GET

アカウントSIDによって識別されるアカウント、またはサブアカウントに関連づけられた全Port Order LOAドキュメントの一覧を取得します。

リクエスト
$ curl -G https://preview.twilio.com/porting/Loas \ 
    -u 'ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:your_auth_token' \
レスポンス
{
    "meta": {
      "page": 0,
      "page_size": 50,
      "url": "https://preview.twilio.com/porting/Loas?PageSize=50&Page=0",
      "first_page_url": "https://preview.dev.twilio.com/porting/Loas?PageSize=50&Page=0",
      "next_page_url": "https://preview.dev.twilio.com/porting/Loas?PageSize=50&Page=1",
      "previous_page_url": null,
      "key": "loas"
    },
    "loas": [{
      "status": "open",
      "first_name": "Jim",
      "last_name": "Smith",
      "url": "https://preview.twilio.com/porting/Loas/PX0fff0afcc9eda017f42674b7a0cc9f38",
      "sid": "PX0fff0afcc9eda017f42674b7a0cc9f38",
      "email": "jim.smith@random.com"
    },...]
}

HTTP POST

利用できません。

HTTP PUT

利用できません。

HTTP DELETE

利用できません。

ヘルプが必要ですか?

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