Phone Numbers - Get By Number

サービス:

Communication

API バージョン:

2022-12-01

指定された購入した電話番号の詳細を取得します。

GET {endpoint}/phoneNumbers/{phoneNumber}?api-version=2022-12-01

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string url	通信リソース (例: https://resourcename.communication.azure.com
phoneNumber	path	True	string	詳細が E.164 形式でフェッチされる購入済みの電話番号 (例: +11234567890)。
api-version	query	True	string	呼び出す API のバージョン

応答

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

例

Fetch purchased phone number

要求のサンプル

HTTP

GET https://resourcename.communication.azure.com//phoneNumbers/+11234567890?api-version=2022-12-01

応答のサンプル

状態コード:

200

{
  "id": "11234567890",
  "phoneNumber": "+11234567890",
  "countryCode": "US",
  "assignmentType": "person",
  "phoneNumberType": "geographic",
  "capabilities": {
    "calling": "inbound+outbound",
    "sms": "inbound"
  },
  "purchaseDate": "2020-11-19T16:31:49.048Z",
  "cost": {
    "amount": 0.8,
    "currencyCode": "USD",
    "billingFrequency": "monthly"
  }
}

定義

名前	説明
BillingFrequency	コストが課金される頻度。
CommunicationError	Communication Services エラー。
CommunicationErrorResponse	Communication Services エラー。
PhoneNumberAssignmentType	オファリングの割り当ての種類を表します。
PhoneNumberCapabilities	電話番号の機能。
PhoneNumberCapabilityType	呼び出しの機能の値。
PhoneNumberCost	1 つの電話番号に対して発生したコスト。
PhoneNumberType	オファリングの番号の種類を表します。
PurchasedPhoneNumber	購入した電話番号を表します。

BillingFrequency

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

名前	型	説明
monthly	string

CommunicationError

Communication Services エラー。

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

CommunicationErrorResponse

Communication Services エラー。

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

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 など)。

PhoneNumberType

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

名前	型	説明
geographic	string
tollFree	string

PurchasedPhoneNumber

購入した電話番号を表します。

名前	型	説明
assignmentType	PhoneNumberAssignmentType	電話番号の割り当ての種類。 電話番号は、ユーザーまたはアプリケーションに割り当てることができます。
capabilities	PhoneNumberCapabilities	電話番号の機能。
cost	PhoneNumberCost	1 つの電話番号に対して発生したコスト。
countryCode	string	電話番号の国の ISO 3166-2 コード (例: 米国)。
id	string	電話番号の ID (例: 11234567890)。
phoneNumber	string	電話番号の E.164 形式の文字列 (例: +11234567890)。
phoneNumberType	PhoneNumberType	電話番号の種類 (地理的、tollFree など)。
purchaseDate	string	電話番号が購入された日時。