Phone Numbers - Get Operation

サービス:

Communication

API バージョン:

2022-12-01

ID で操作を取得します。

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

URI パラメーター

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

応答

名前	型	説明
200 OK	PhoneNumberOperation	操作が完了したら、応答ヘッダーの 'Location' 属性で指定された URL を使用して、操作の最終的な結果を照会します。 ヘッダー Location: string
Other Status Codes	CommunicationErrorResponse	失敗

例

Get long running operation status by operation id

要求のサンプル

HTTP

GET https://resourcename.communication.azure.com//phoneNumbers/operations/search-my-operation-id?api-version=2022-12-01

応答のサンプル

状態コード:

200

Location: /availablePhoneNumbers/searchResults/378ddf60-81be-452a-ba4f-613198ea6c28

{
  "status": "succeeded",
  "resourceLocation": "/availablePhoneNumbers/searchResults/378ddf60-81be-452a-ba4f-613198ea6c28",
  "createdDateTime": "2020-11-19T16:31:49.048Z",
  "id": "search-my-operation-id",
  "operationType": "search",
  "lastActionDateTime": "2020-11-19T22:31:49.048Z"
}

定義

名前	説明
CommunicationError	Communication Services エラー。
CommunicationErrorResponse	Communication Services エラー。
PhoneNumberOperation
PhoneNumberOperationStatus	操作の状態。
PhoneNumberOperationType	操作の種類 (検索など)

CommunicationError

Object

Communication Services エラー。

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

CommunicationErrorResponse

Object

Communication Services エラー。

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

PhoneNumberOperation

Object

名前	型	説明
createdDateTime	string (date-time)	操作が作成された日付。
error	CommunicationError	Communication Services エラー。
id	string	操作の ID。
lastActionDateTime	string (date-time)	操作が変更された最新の日付。
operationType	PhoneNumberOperationType	操作の種類 (検索など)
resourceLocation	string	操作の結果を取得するための URL (ある場合)。
status	PhoneNumberOperationStatus	操作の状態。

PhoneNumberOperationStatus

列挙

操作の状態。

値	説明
failed
notStarted
running
succeeded

PhoneNumberOperationType

列挙

操作の種類 (検索など)

値	説明
purchase
releasePhoneNumber
search
updatePhoneNumberCapabilities