Phone Numbers - Browse Available Numbers

サービス:: Communication

API バージョン:: 2025-04-01

購入できる電話番号を参照します。応答は、閲覧条件に一致する購入に使用できる電話番号のランダム化されたリストになります。この操作はページ分割されません。結果はランダム化されるため、同じ要求を繰り返すと、同じ結果が保証されません。

POST {endpoint}/availablePhoneNumbers/countries/{countryCode}/:browse?api-version=2025-04-01

URI パラメーター

名前	/	必須	型	説明
countryCode	path	True	string	ISO 3166-2 の国コード (例: 米国)。
endpoint	path	True	string (url)	通信リソース (例: https://resourcename.communication.azure.com
api-version	query	True	string	呼び出す API のバージョン

要求本文

名前	必須	型	説明
phoneNumberType	True	PhoneNumberType	オファリングの番号の種類を表します。
assignmentType		PhoneNumberAssignmentType	オファリングの割り当ての種類を表します。ユースケースとも呼ばれます。
capabilities		PhoneNumberBrowseCapabilitiesRequest	参照操作要求に必要な最小限の機能。
phoneNumberPrefixes		string[]	一致する電話番号プレフィックス。指定した場合、検索は、指定されたプレフィックスのいずれかで始まる電話番号に制限されます。

応答

名前	型	説明
200 OK	PhoneNumbersBrowseResult	閲覧条件に一致する購入に使用できる電話番号のランダム化されたリスト。
Other Status Codes	CommunicationErrorResponse	失敗

例

Browse available phone numbers

要求のサンプル

HTTP

POST https://resourcename.communication.azure.com/availablePhoneNumbers/countries/US/:browse?api-version=2025-04-01

{
  "phoneNumberType": "geographic",
  "capabilities": {
    "calling": "outbound",
    "sms": "none"
  },
  "assignmentType": "person",
  "phoneNumberPrefixes": [
    "1425",
    "1626"
  ]
}

応答のサンプル

状態コード:: 200

{
  "phoneNumbers": [
    {
      "id": "14254567890",
      "countryCode": "US",
      "phoneNumber": "+14254567890",
      "capabilities": {
        "calling": "outbound",
        "sms": "none"
      },
      "phoneNumberType": "geographic",
      "assignmentType": "person",
      "cost": {
        "amount": 1,
        "currencyCode": "USD",
        "billingFrequency": "monthly"
      },
      "status": "available",
      "isAgreementToNotResellRequired": false
    },
    {
      "id": "16264567890",
      "countryCode": "US",
      "phoneNumber": "+16264567890",
      "capabilities": {
        "calling": "outbound",
        "sms": "none"
      },
      "phoneNumberType": "geographic",
      "assignmentType": "person",
      "cost": {
        "amount": 1,
        "currencyCode": "USD",
        "billingFrequency": "monthly"
      },
      "status": "available",
      "isAgreementToNotResellRequired": false
    }
  ]
}

定義

名前	説明
AvailablePhoneNumber	インベントリで使用可能な電話番号を表します
AvailablePhoneNumberError	電話番号の予約、解放、または購入時にエラーが発生した場合のエラーの詳細が含まれます。これは、要求に存在する場合、サービスによって無視されることに注意してください。
AvailablePhoneNumberStatus	電話番号の状態を表します。使用可能な値は、'available'、'reserved'、'expired'、'error'、'purchased' です。
BillingFrequency	コストが課金される頻度。
CommunicationError	Communication Services エラー。
CommunicationErrorResponse	Communication Services エラー。
Cost	この電話番号に対して発生したコスト。
PhoneNumberAssignmentType	オファリングの割り当ての種類を表します。
PhoneNumberBrowseCapabilitiesRequest	参照操作要求に必要な最小限の機能。
PhoneNumberCapabilities	電話番号の機能。
PhoneNumberCapabilityType	呼び出しの機能の値。
PhoneNumbersBrowseRequest	参照操作のパラメーター。
PhoneNumbersBrowseResult	電話番号の参照操作の結果。
PhoneNumberType	オファリングの番号の種類を表します。

AvailablePhoneNumber

Object

インベントリで使用可能な電話番号を表します

名前	型	説明
assignmentType	PhoneNumberAssignmentType	オファリングの割り当ての種類を表します。ユースケースとも呼ばれます。
capabilities	PhoneNumberCapabilities	電話番号の機能。
cost	Cost	この電話番号に対して発生したコスト。
countryCode	string	ISO 3166-2 の国コード (例: 米国)。
error	AvailablePhoneNumberError	電話番号の予約、解放、または購入時にエラーが発生した場合のエラーの詳細が含まれます。これは、要求に存在する場合、サービスによって無視されることに注意してください。
id	string	電話番号の ID。
isAgreementToNotResellRequired	boolean	再販契約が必要かどうかを示します。 true の場合、顧客が再販しないことを明示的に同意しない限り、電話番号を取得できません。
phoneNumber	string	E.164 形式の電話番号 (例: +11234567890)。
phoneNumberType	PhoneNumberType	オファリングの番号の種類を表します。
status	AvailablePhoneNumberStatus	電話番号の状態を表します。使用可能な値は、'available'、'reserved'、'expired'、'error'、'purchased' です。

AvailablePhoneNumberError

Object

電話番号の予約、解放、または購入時にエラーが発生した場合のエラーの詳細が含まれます。これは、要求に存在する場合、サービスによって無視されることに注意してください。

名前	型	説明
code	string	電話番号に対して実行された操作が失敗した理由を示すエラーコード。
message	string	発生したエラーを説明するエラーメッセージ。

AvailablePhoneNumberStatus

列挙

電話番号の状態を表します。使用可能な値は、'available'、'reserved'、'expired'、'error'、'purchased' です。

値	説明
available
error
expired
purchased
reserved

BillingFrequency

列挙

コストが課金される頻度。

値	説明
monthly

CommunicationError

Object

Communication Services エラー。

名前	型	説明
code	string	エラーコード。
details	CommunicationError[]	このエラーの原因となった特定のエラーの詳細。
innererror	CommunicationError	内部エラーがある場合。
message	string	エラーメッセージ。
target	string	エラーターゲット。

CommunicationErrorResponse

Object

Communication Services エラー。

名前	型	説明
error	CommunicationError	Communication Services エラー。

Cost

Object

この電話番号に対して発生したコスト。

名前	型	説明
amount	number (double)	コストの金額。
billingFrequency	BillingFrequency	コストが課金される頻度。
currencyCode	string	コスト金額の ISO 4217 通貨コード (USD など)。

PhoneNumberAssignmentType

列挙

オファリングの割り当ての種類を表します。

値	説明
application
person

PhoneNumberBrowseCapabilitiesRequest

Object

参照操作要求に必要な最小限の機能。

名前	型	説明
calling	PhoneNumberCapabilityType	呼び出しの機能の値。
sms	PhoneNumberCapabilityType	SMS の機能の値。

PhoneNumberCapabilities

Object

電話番号の機能。

名前	型	説明
calling	PhoneNumberCapabilityType	呼び出しの機能の値。
sms	PhoneNumberCapabilityType	SMS の機能の値。

PhoneNumberCapabilityType

列挙

呼び出しの機能の値。

値	説明
inbound
inbound+outbound
none
outbound

PhoneNumbersBrowseRequest

Object

参照操作のパラメーター。

名前	型	説明
assignmentType	PhoneNumberAssignmentType	オファリングの割り当ての種類を表します。ユースケースとも呼ばれます。
capabilities	PhoneNumberBrowseCapabilitiesRequest	参照操作要求に必要な最小限の機能。
phoneNumberPrefixes	string[]	一致する電話番号プレフィックス。指定した場合、検索は、指定されたプレフィックスのいずれかで始まる電話番号に制限されます。
phoneNumberType	PhoneNumberType	オファリングの番号の種類を表します。

PhoneNumbersBrowseResult

Object

電話番号の参照操作の結果。

名前	型	説明
phoneNumbers	AvailablePhoneNumber[]	購入可能な電話番号。

PhoneNumberType

列挙

オファリングの番号の種類を表します。

値	説明
geographic
tollFree

次の方法で共有

Phone Numbers - Browse Available Numbers

URI パラメーター

要求本文

応答

例

Browse available phone numbers

要求のサンプル

応答のサンプル

定義

AvailablePhoneNumber

AvailablePhoneNumberError

AvailablePhoneNumberStatus

BillingFrequency

CommunicationError

CommunicationErrorResponse

Cost

PhoneNumberAssignmentType

PhoneNumberBrowseCapabilitiesRequest

PhoneNumberCapabilities

PhoneNumberCapabilityType

PhoneNumbersBrowseRequest

PhoneNumbersBrowseResult

PhoneNumberType