Phone Numbers - Get Search Result

サービス:

Communication

API バージョン:

2022-12-01

検索 ID で電話番号の検索結果を取得します。

GET {endpoint}/availablePhoneNumbers/searchResults/{searchId}?api-version=2022-12-01

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (url)	通信リソース (例: https://resourcename.communication.azure.com
searchId	path	True	string	検索 ID。
api-version	query	True	string	呼び出す API のバージョン

応答

名前	型	説明
200 OK	PhoneNumberSearchResult	成功
Other Status Codes	CommunicationErrorResponse	失敗

例

Get PhoneNumber Search Result

要求のサンプル

HTTP

GET https://resourcename.communication.azure.com//availablePhoneNumbers/searchResults/378ddf60-81be-452a-ba4f-613198ea6c28?api-version=2022-12-01

応答のサンプル

状態コード:

200

{
  "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",
  "errorCode": 1000,
  "error": "OutOfStock"
}

定義

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

BillingFrequency

列挙

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

値	説明
monthly

CommunicationError

Object

Communication Services エラー。

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

CommunicationErrorResponse

Object

Communication Services エラー。

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

Error

列挙

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

値	説明
AllNumbersNotAcquired
AuthorizationDenied
BillingUnavailable
InvalidAddress
InvalidOfferModel
MissingAddress
NoError
NoWallet
NotEnoughCredit
NotEnoughLicenses
NumbersPartiallyAcquired
OutOfStock
ProvisioningFailed
PurchaseFailed
ReservationExpired
UnknownErrorCode
UnknownSearchError

PhoneNumberAssignmentType

列挙

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

値	説明
application
person

PhoneNumberCapabilities

Object

電話番号の機能。

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

PhoneNumberCapabilityType

列挙

呼び出しの機能の値。

値	説明
inbound
inbound+outbound
none
outbound

PhoneNumberCost

Object

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

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

PhoneNumberSearchResult

Object

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

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

PhoneNumberType

列挙

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

値	説明
geographic
tollFree