実行時にエージェントのプレゼンス情報を取得します。
前提条件
この API を呼び出すには、オムニチャネル エージェントまたはオムニチャネル スーパーバイザーのロールが必要です。
要求の詳細
-
URLのお知らせ:
https://<orgurl>/api/data/v9.2/CCaaS_GetPresence - メソッド: GET
- バージョン: 1.0
要求ヘッダー
| 件名 | プロパティ |
|---|---|
| 認可 | 必須。 CCaaS インスタンスのテナント内の API 呼び出しユーザーの Azure AD からのベアラー トークン。 |
| MSCRMCallerID | エージェントのプレゼンスを取得するには、偽装するユーザーの AgentID を指定します。 通話はそのエージェントのクォータに対して課金されます。 |
回答
成功した場合、このメソッドは 200 OK 応答コードと応答本文内のプレゼンス オブジェクトを返します。 このメソッドは、次の状態コードも返します。
| HTTP 状態 | プロパティ |
|---|---|
| 400 | 不正な要求 (入力パラメーターが間違っています) |
| 401 | 承認されていません |
| 404 | リソースが見つかりません |
| 429 | レート制限 (要求が多すぎます) |
| 405 | 禁止されていない API |
| 500 | サーバ内部のエラー |
応答キー
| Key | タイプ | プロパティ |
|---|---|---|
| ActiveBrowserSessions | 整数 | エージェントがログインしているブラウザまたはタブの数です。 |
| AgentId | GUID | systemusers エンティティ内のエージェントの ID です。 |
| AgentName | String | systemusers エンティティ内のエージェントの名前です。 |
| Timestamp | 整数 | エポックからのログイン時間 (秒単位) です。 |
| AllowedChannels | 文字列配列 | エージェントが使用できるチャネルです。 |
| CurrentPresenceStatusInfo | String | エージェントの現在のプレゼンス状態の名前です。 |
| DisabledChannels | 文字列配列 | エージェントが使用できないチャネルです。 |
| PresenceId | GUID | エージェントのプレゼンス状態の ID です。 この ID を使用して、OData 呼び出しを使用してプレゼンス エンティティから詳細を照会できます。 |
サンプル cURL リクエスト
curl -X GET \
'https://presencesqlorg.crmtest.Dynamics.com/api/presence/GetAgentPresence/394382b6-a4d4-ee11-904c-00224808a166' \
--header 'Accept: */*' \
--header 'OrganizationId: 11bb11bb-cc22-dd33-ee44-55ff55ff55ff' \
--header 'Content-Type: application/json' \
--header 'x-ms-organization-id: 11bb11bb-cc22-dd33-ee44-55ff55ff55ff' \
--header 'tenantId: aaaabbbb-0000-cccc-1111-dddd2222eeee' \
--header 'MSCRMCallerID: cc05cf62-6242-ee11-be6e-6045bdd7ac2c' \
--header 'Authorization: Bearer Token'