Phone Numbers - List Phone Numbers

リファレンス

Service:: Communication

API Version:: 2021-03-07

購入したすべての電話番号の一覧を取得します。

GET {endpoint}/phoneNumbers?api-version=2021-03-07

With optional parameters:

GET {endpoint}/phoneNumbers?skip={skip}&top={top}&api-version=2021-03-07

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	通信リソース (例: https://resourcename.communication.azure.com)。
api-version	query	True	string	呼び出す API のバージョン。
skip	query		integer int32	改ページのためにスキップするエントリの数を示す省略可能なパラメーター。既定値は 0 です。
top	query		integer int32	改ページのために返すエントリの数を示す省略可能なパラメーター。既定値は 100 です。

応答

名前	型	説明
200 OK	PurchasedPhoneNumbers	Success
Other Status Codes	CommunicationErrorResponse	障害

例

List purchased phone numbers

Sample Request

HTTP

GET https://resourcename.communication.azure.com//phoneNumbers?api-version=2021-03-07

Sample Response

Status code:: 200

{
  "phoneNumbers": [
    {
      "id": "11234567890",
      "phoneNumber": "+11234567890",
      "countryCode": "US",
      "assignmentType": "user",
      "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	検索する電話番号の種類 (地理的な電話番号や tollFree など)。
PurchasedPhoneNumber	購入した電話番号を表します。
PurchasedPhoneNumbers	購入した電話番号の一覧。

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

検索する電話番号の種類 (地理的な電話番号や tollFree など)。

名前	型	説明
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	電話番号が購入された日時。

PurchasedPhoneNumbers

購入した電話番号の一覧。

名前	型	説明
nextLink	string	電話番号の結果の次のページへの URL リンクを表します。
phoneNumbers	PurchasedPhoneNumber[]	電話番号の一覧を表します。

Share via