Phone Numbers - Search Available Phone Numbers

リファレンス

サービス:: Communication

API バージョン:: 2022-12-01

購入できる電話番号を検索します。

POST {endpoint}/availablePhoneNumbers/countries/{countryCode}/:search?api-version=2022-12-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 のバージョン

要求本文

名前	必須	型	説明
assignmentType	True	PhoneNumberAssignmentType	検索する電話番号の割り当ての種類。電話番号は、ユーザーまたはアプリケーションに割り当てることができます。
capabilities	True	PhoneNumberCapabilities	電話番号の機能。
phoneNumberType	True	PhoneNumberType	検索する電話番号の種類 (地理的な電話番号、tollFree など)。
areaCode		string	目的の電話番号の市域コード (例: 425)。
quantity		integer	目的の電話番号の数量。既定値は 1 です。

応答

名前	型	説明
202 Accepted	PhoneNumberSearchResult	サービスは要求を受け入れ、後で処理を開始します。すぐに 'Accepted' が返され、'Operation-Location' ヘッダーと 'Location' ヘッダーが含まれます。クライアント側では、'Operation-Location' ヘッダーで指定された URL を使用して、操作の状態をさらに照会する必要があります。操作が正常に完了したら、'Location' ヘッダーで指定された URL を使用して最終的な結果を照会します。ヘッダー Location: string Operation-Location: string operation-id: string search-id: string
Other Status Codes	CommunicationErrorResponse	失敗

名前

型

説明

202 Accepted

PhoneNumberSearchResult

サービスは要求を受け入れ、後で処理を開始します。すぐに 'Accepted' が返され、'Operation-Location' ヘッダーと 'Location' ヘッダーが含まれます。クライアント側では、'Operation-Location' ヘッダーで指定された URL を使用して、操作の状態をさらに照会する必要があります。操作が正常に完了したら、'Location' ヘッダーで指定された URL を使用して最終的な結果を照会します。

ヘッダー

Location: string
Operation-Location: string
operation-id: string
search-id: string

Other Status Codes

CommunicationErrorResponse

失敗

例

Search for phone numbers

要求のサンプル

HTTP

POST https://resourcename.communication.azure.com//availablePhoneNumbers/countries/US/:search?api-version=2022-12-01

{
  "phoneNumberType": "tollFree",
  "assignmentType": "application",
  "capabilities": {
    "sms": "inbound+outbound",
    "calling": "none"
  },
  "areaCode": "425",
  "quantity": 1
}

応答のサンプル

状態コード:: 202

Operation-Location: /phoneNumbers/operations/search_378ddf60-81be-452a-ba4f-613198ea6c28
Location: /availablePhoneNumbers/searchResults/378ddf60-81be-452a-ba4f-613198ea6c28
operation-id: search_378ddf60-81be-452a-ba4f-613198ea6c28
search-id: 378ddf60-81be-452a-ba4f-613198ea6c28

{
  "searchId": "378ddf60-81be-452a-ba4f-613198ea6c28",
  "phoneNumbers": [
    "+18001212121"
  ],
  "phoneNumberType": "tollFree",
  "assignmentType": "application",
  "capabilities": {
    "sms": "inbound+outbound",
    "calling": "none"
  },
  "cost": {
    "amount": 1.2,
    "currencyCode": "USD",
    "billingFrequency": "monthly"
  },
  "searchExpiresBy": "2020-11-19T16:31:49.048Z"
}

定義

名前	説明
BillingFrequency	コストが課金される頻度。
CommunicationError	Communication Services エラー。
CommunicationErrorResponse	Communication Services エラー。
Error	エラーメッセージをコードにマッピングする
PhoneNumberAssignmentType	オファリングの割り当ての種類を表します。
PhoneNumberCapabilities	電話番号の機能。
PhoneNumberCapabilityType	呼び出しの機能の値。
PhoneNumberCost	1 つの電話番号に対して発生したコスト。
PhoneNumberSearchRequest	電話番号を検索する電話番号検索要求を表します。見つかった電話番号は、次の購入のために一時的に保持されます。
PhoneNumberSearchResult	電話番号検索操作の結果。
PhoneNumberType	オファリングの番号の種類を表します。

BillingFrequency

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

名前	型	説明
monthly	string

CommunicationError

Communication Services エラー。

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

CommunicationErrorResponse

Communication Services エラー。

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

Error

エラーメッセージをコードにマッピングする

名前	型	説明
AllNumbersNotAcquired	string
AuthorizationDenied	string
BillingUnavailable	string
InvalidAddress	string
InvalidOfferModel	string
MissingAddress	string
NoError	string
NoWallet	string
NotEnoughCredit	string
NotEnoughLicenses	string
NumbersPartiallyAcquired	string
OutOfStock	string
ProvisioningFailed	string
PurchaseFailed	string
ReservationExpired	string
UnknownErrorCode	string
UnknownSearchError	string

PhoneNumberAssignmentType

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

名前	型	説明
application	string
person	string

PhoneNumberCapabilities

電話番号の機能。

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

PhoneNumberCapabilityType

呼び出しの機能の値。

名前	型	説明
inbound	string
inbound+outbound	string
none	string
outbound	string

PhoneNumberCost

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

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

PhoneNumberSearchRequest

電話番号を検索する電話番号検索要求を表します。見つかった電話番号は、次の購入のために一時的に保持されます。

名前	型	規定値	説明
areaCode	string		目的の電話番号の市域コード (例: 425)。
assignmentType	PhoneNumberAssignmentType		検索する電話番号の割り当ての種類。電話番号は、ユーザーまたはアプリケーションに割り当てることができます。
capabilities	PhoneNumberCapabilities		電話番号の機能。
phoneNumberType	PhoneNumberType		検索する電話番号の種類 (地理的な電話番号、tollFree など)。
quantity	integer	1	目的の電話番号の数量。既定値は 1 です。

PhoneNumberSearchResult

電話番号検索操作の結果。

名前	型	説明
assignmentType	PhoneNumberAssignmentType	電話番号の割り当ての種類。
capabilities	PhoneNumberCapabilities	電話番号の機能。
cost	PhoneNumberCost	1 つの電話番号に対して発生したコスト。
error	Error	エラーメッセージをコードにマッピングする
errorCode	integer	検索のエラーコード。
phoneNumberType	PhoneNumberType	電話番号の種類 (地理的な番号や tollFree など)。
phoneNumbers	string[]	使用可能な電話番号。必要な検索量より少ない場合があります。
searchExpiresBy	string	この検索結果の有効期限が切れ、電話番号が保留でなくなった日付。検索結果の有効期限が 15 分未満になります (例: 2020-11-19T16:31:49.048Z)。
searchId	string	検索 ID。

PhoneNumberType

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

名前	型	説明
geographic	string
tollFree	string

次の方法で共有

Phone Numbers - Search Available Phone Numbers

URI パラメーター

要求本文

応答

例

Search for phone numbers

要求のサンプル

応答のサンプル

定義

BillingFrequency

CommunicationError

CommunicationErrorResponse

Error

PhoneNumberAssignmentType

PhoneNumberCapabilities

PhoneNumberCapabilityType

PhoneNumberCost

PhoneNumberSearchRequest

PhoneNumberSearchResult

PhoneNumberType

その他のリソース