エージェント アクティビティ エンドポイント

エージェント アクティビティ ログは、ウィジェットの状態が変更されたときに作成されるレコードです。ウィジェットへのログイン、デルタキャスト通話通知の受信、通話の応答など、さまざまなステータスが考えられます。アクティビティごとに新しい オブジェクトが作成されます。どのフィールドに (PII)が含まれる可能性があるかを確認するには、次のモデルをご覧ください。

[
  {
    "id": 0,
    "agent_id": 0,
    "whodunnit": {
      "id": 0,
      "name": "string",
      "last_name": "string",
      "first_name": "string",
      "agent_number": "string",
      "avatar_url": "string"
    },
    "status": {
      "id": 0,
      "name": "string",
      "color": "string"
    },
    "started_at": "2018-06-06T21:12:24.766Z",
    "ended_at": "2018-06-06T21:12:24.766Z",
    "duration": 0,
    "activity": "login",
    "call_id": 0,
    "chat_id": 0
  }
]

次の表に、アクティビティ ログが作成される可能性のあるすべてのアクティビティの概要を示します。

アクティビティ 説明
chat_picked_up エージェントが エージェントをピックアップしたときに発生するイベント
chat_pick_up_attempt エージェントが応答エージェントになろうとしたときに発生するイベント
chat_notification_offered エンドユーザーがチャット セッションをリクエストすると、そのキューに割り当てられたエージェントに通知が送信されます。このイベントは、通知が送信されたときに発生します。
call_notification_offered エンドユーザーが電話をかけ、マルチキャストまたはデルタキャストの通話通知がエージェントに送信されたときに発生するイベント。
call_pick_up_attempt エージェントがマルチキャストまたはデルタキャストの通話をピックアップしようとしたときに発生するイベント。
call_picked_up エージェントがマルチキャストまたはデルタキャストの通話に応答したときに発生するイベント。
deltacast_call_notification_offered エンドユーザーがマルチキャスト対応のキューに電話をかけ、そのキューのエージェントにデルタキャスト通話がブロードキャストされたことを示すイベント。
deltacast_call_pick_up_attempt エージェントがデルタキャスト通話に応答しようとしたときに発生するイベント
deltacast_call_picked_up エージェントがデルタキャスト通話に正常に応答したときに発生するイベント。
deltacast_call_missed エージェントがデルタキャスト通話に応答しなかったときに発生するイベント
multicast_call_notification_offered エンドユーザーがマルチキャスト対応のキューに電話をかけ、そのキューのエージェントにマルチキャスト通話がブロードキャストされたことを示すイベント
multicast_call_pick_up_attempt エージェントがマルチキャスト通話に応答しようとしたときに発生するイベント
multicast_call_picked_up エージェントがマルチキャスト通話に応答したときに発生するイベント
call_outbound_dialing エージェントがウィジェットのダイヤルパッドを使用してエンドユーザーに電話をかけたときに発生するイベント。
user_status_changed エージェントがウィジェットの状態を変更したときに発生するイベント
ログイン エージェントがウィジェットからログアウトしたときに発生するイベント
ログアウト エージェントがウィジェットにログインしたときに発生するイベント

エージェント アクティビティ ログ

パラメータ 必須 データ型 定義
sort_column FALSE 文字列 レスポンス オブジェクトの任意のフィールドに基づいてレスポンスを並べ替えます。
sort_direction FALSE ASC または DESC 並べ替えの方向(昇順または降順)を示します。
ページ FALSE 文字列 per と組み合わせて、レコードのページを示します。たとえば、per が 200 でページが 2 の場合、レスポンスにはレコード 201 ~ 400 が含まれます。ページ 1 には 1 ~ 200 が含まれます。
per FALSE 文字列 ページと組み合わせて、レコードのページに含めるレコードの数を示します。たとえば、per が 200 でページが 2 の場合、レスポンスにはレコード 201 ~ 400 が含まれます。ページ 1 には 1 ~ 200 が含まれます。
started_at[from] FALSE UTC 時間 started_at フィールドの下限を作成します。返されるレコードはすべて、入力値より後のものになります。
started_at[to] FALSE UTC 時間 started_at フィールドの上限を作成します。返されるレコードはすべて、入力値より前のものになります。
ended_at[from] FALSE UTC 時間 ended_at フィールドの下限を作成します。返されるレコードはすべて、入力値より後のものになります。
ended_at[to] FALSE UTC 時間 ended_at フィールドの上限を作成します。返されるレコードはすべて、入力値より前のものになります。
duration[from] FALSE 数値 duration フィールドの下限を作成します。返されるレコードはすべて、入力値より後のものになります。
duration[to] FALSE 数値 duration フィールドの上限を作成します。返されるレコードはすべて、入力値より前のものになります。
id[] FALSE 配列 [文字列] 配列 [文字列]。検索して返すレコードの ID
agent_id[] FALSE 配列 [文字列] エージェント ID でレスポンスをフィルタします。
activity[] FALSE 配列 [文字列] エージェントが完了したタスク/アクティビティでレコードをフィルタします。有効な値は、login、logout、call_outbound_dialing、deltacast_call_notification_offered、deltacast_call_pick_up_attempt、deltacast_call_picked_up、deltacast_call_projected、deltacast_call_missed、deltacast_call_bounced、multicast_call_notification_offered、multicast_call_pick_up_attempt、multicast_call_picked_up、user_status_changed、chat_notification_offered、chat_pick_up_attempt、chat_picked_up です。
whodunnit_id[] FALSE 配列 [文字列] エージェント ID でレスポンスをフィルタします。Whodunnit はエージェント オブジェクトのサブセットで、主キーとして同じ agent_id を使用します。
call_id[] FALSE 配列 [文字列] 入力された通話 ID でレコードをフィルタします。
chat_id[] FALSE 配列 [文字列] 入力されたチャット ID でレコードをフィルタします。

エンドポイント:

Method: GET
Type: 
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/agent_activity_logs

リクエスト/レスポンスの例:

リクエストの例: エージェント アクティビティ ログの例

本文: なし

レスポンスの例: エージェント アクティビティ ログの例

[
    {
        "id": 190578,
        "agent_id": 118,
        "status": {
            "id": -10,
            "name": "Offline",
            "color": "grey",
        },
        "started_at": "2017-12-22T00:54:18.000Z",
        "ended_at": null,
        "duration": 0,
        "call_id": null,
        "chat_id": null,
        "activity": "logout",
        "whodunnit": null
    },
    {
        "id": 199548,
        "agent_id": 118,
        "status": {
            "id": -10,
            "name": "Offline",
            "color": "grey",
        },
        "started_at": "2018-01-09T22:54:26.000Z",
        "ended_at": null,
        "duration": 0,
        "call_id": null,
        "chat_id": null,
        "activity": "logout",
        "whodunnit": null
    },
    {
        "id": 190577,
        "agent_id": 118,
        "status": {
            "id": -10,
            "name": "Offline",
            "color": "grey",
        },
        "started_at": "2017-12-22T00:54:18.000Z",
        "ended_at": "2018-01-08T22:54:22.000Z",
        "duration": 1548004,
        "call_id": null,
        "chat_id": null,
        "activity": "user_status_changed",
        "whodunnit": null
    },
    {
        "id": 199547,
        "agent_id": 118,
        "status": {
            "id": -10,
            "name": "Offline",
            "color": "grey",
        },
        "started_at": "2018-01-09T22:54:26.000Z",
        "ended_at": null,
        "duration": 0,
        "call_id": null,
        "chat_id": null,
        "activity": "user_status_changed",
        "whodunnit": null
    },
    {
        "id": 190270,
        "agent_id": 118,
        "status": {
            "id": -1,
            "name": "Unavailable",
            "color": "red",
        },
        "started_at": "2017-12-21T21:34:14.000Z",
        "ended_at": "2017-12-22T00:54:18.000Z",
        "duration": 12004,
        "call_id": null,
        "chat_id": null,
        "activity": "user_status_changed",
        "whodunnit": null
    },
    {
        "id": 198036,
        "agent_id": 118,
        "status": {
            "id": -1,
            "name": "Unavailable",
            "color": "red",
        },
        "started_at": "2018-01-08T22:54:22.000Z",
        "ended_at": "2018-01-09T22:54:26.000Z",
        "duration": 86404,
        "call_id": null,
        "chat_id": null,
        "activity": "user_status_changed",
        "whodunnit": null
    },
    {
        "id": 22249,
        "agent_id": 129,
        "status": {
            "id": -10,
            "name": "Offline",
            "color": "grey",
        },
        "started_at": "2017-06-19T18:34:39.000Z",
        "ended_at": null,
        "duration": 0,
        "call_id": null,
        "chat_id": null,
        "activity": "login",
        "whodunnit": null
    }
]

ステータス コード:200