取得
このインターフェースは、会社のすべての操作ログを取得するために使用されます。
リクエストメソッド
GET work_logs
リクエストパラメータ
| 属性 | 型 | 説明 | 必須 |
|---|---|---|---|
| begin_date | 文字列 | 開始日 | はい |
| end_date | 文字列 | 終了日 | はい |
| page | 整数 | ページ番号 | いいえ, デフォルトは1 |
| per_page | 整数 | 1ページあたりの件数, 最大50 | いいえ, デフォルト20 |
- 注：日付形式は 'YYYY-MM-DD' です。
- 注：このインターフェースは90日以内の操作ログのみ取得できます。
レスポンスデータ
| 属性 | 型 | 説明 |
|---|---|---|
| code | 整数 | 実行結果コード,1000は成功を表します |
| meta | JSONオブジェクト | ページネーション情報 |
| logs | 配列 | ログ内容,構造は以下の通り |
- metaのデータ構造
| 属性 | 型 | 説明 |
|---|---|---|
| current_page | 整数 | 現在のページ番号 |
| total_pages | 整数 | 総ページ数 |
- logのデータ構造
| 属性 | 型 | 説明 |
|---|---|---|
| id | 整数 | 業務記録テンプレートのID |
| user_id | 文字列 | 操作者ID |
| user_nick_name | 文字列 | 操作者名 |
| obj_id | 整数 | 操作対象ID |
| obj_nick_name | 文字列 | 操作対象名 |
| device_ua | 文字列 | 端末 |
| ip | 文字列 | IPアドレス |
| op_module | 文字列 | 操作モジュール |
| op_type | 文字列 | 操作タイプ |
| op_desc | 文字列 | 操作内容 |
| created_at | 文字列 | 操作時のタイムスタンプ |
- op_moduleの説明
| 値 | 説明 |
|---|---|
| sys | システム |
| im | インスタントメッセージング |
| cc | コールセンター |
| ticket | チケット |
- op_typeの説明
| 値 | 説明 |
|---|---|
| sys_login | Webログイン状態 |
| sys_status | Webオンライン状態 |
| im_stauts | 会話オンライン状態 |
| cc_work_way | 通話デバイス状態 |
| cc_work_state | 通話オンライン状態 |
| ticket_allot | チケット受信割り当てスイッチ |
| ### サンプル |
リクエスト
curl -X GET 'http://demo.udesk.cn/open_api_v1/work_logs?email=admin@udesk.cn×tamp=1639119642&sign=5f17da1c4a2103185643ab5bb949545e406a65de9abaa3e529204ef3f9f54a1e&sign_version=v2&nonce=k99qp2j7tbbxvwfuhzo9sk&begin_date=2021-12-09&end_date=2021-12-10' \
レスポンス
{
"code": 1000,
"logs":
[
{
"id": 32905,
"user_id": 741,
"user_nick_name": "wlyb3test",
"obj_id": 741,
"obj_nick_name": "wlyb3test",
"device_ua": "Browser-Windows 10 Chrome 92.0.4515",
"ip": "100.121.196.62",
"op_module": "sys",
"op_type": "sys_login",
"op_desc": "非ログイン ---> ログイン",
"created_at": "2021-12-09T14:06:49.000+08:00"
}
]
}
codeエラーコード説明
| エラーコード | エラーメッセージ |
|---|---|
| 2059 | open apiの署名が正しくありません |
| 2000 | 開始日付が不正です |
| 2000 | 終了日付が不正です |
| 2000 | 終了日付は開始日付より前に設定できません |