Phone Numbers - Update Capabilities

Service:

Communication

API Version:

2021-03-07

電話番号の機能を更新します。

PATCH {endpoint}/phoneNumbers/{phoneNumber}/capabilities?api-version=2021-03-07

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	通信リソース (例: https://resourcename.communication.azure.com)。
phoneNumber	path	True	string	E.164 形式の電話番号 ID。 先頭にプラスを付ける場合は、 + または %2B としてエンコードできます (例: +11234567890)。
api-version	query	True	string	呼び出す API のバージョン。

要求本文

Media Types: "application/merge-patch+json"

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

応答

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

例

Update phoneNumber capabilities

Sample Request

HTTP

PATCH https://resourcename.communication.azure.com//phoneNumbers/+14792000102/capabilities?api-version=2021-03-07

{
  "calling": "inbound+outbound",
  "sms": "none"
}

Sample Response

Status code:

202

Operation-Location: /phoneNumbers/operations/capabilities_378ddf60-81be-452a-ba4f-613198ea6c28
Location: /phoneNumbers/%2b14792000102
operation-id: capabilities_378ddf60-81be-452a-ba4f-613198ea6c28
capabilities-id: 378ddf60-81be-452a-ba4f-613198ea6c28

Response Body

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

定義

名前	説明
BillingFrequency	コストが課金される頻度。
CommunicationError	Communication Services エラー。
CommunicationErrorResponse	Communication Services エラー。
PhoneNumberAssignmentType	検索する電話番号の割り当ての種類。 電話番号は、ユーザーまたはアプリケーションに割り当てることができます。
PhoneNumberCapabilities	電話番号の機能。
PhoneNumberCapabilitiesRequest	電話番号の機能。
PhoneNumberCapabilityType	呼び出しの機能の値。
PhoneNumberCost	1 つの電話番号に対して発生したコスト。
PhoneNumberType	検索する電話番号の種類 (地理的な電話番号、tollFree など)。
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 の機能の値。

PhoneNumberCapabilitiesRequest

電話番号の機能。

名前	型	説明
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 通貨コード (米国ドルなど)。

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