業務記録テンプレートの取得

このAPIは、企業のすべての業務記録テンプレートを取得するために使用されます。

リクエストメソッド

get notes/note_template

リクエストパラメータ

なし

レスポンスデータ

属性	型	説明
code	整数	実行結果コード、1000は成功を表します
note_template	配列	テンプレート内容、構造は以下の通り

• note_templateのデータ構造

属性	型	説明
id	整数	業務記録テンプレートのID
name	文字列	業務記録テンプレートの名称
desc	文字列	業務記録テンプレートの説明
category	文字列	業務記録テンプレートのタイプ
custom_fields	配列	業務記録テンプレートに含まれるカスタムフィールド
ticket_template_id	整数	チケットテンプレートID
updated_at	日時	業務記録テンプレートの最終更新日時

• custom_fieldsのデータ構造

属性	型	説明
field_id	整数	カスタムフィールドのID
field_type	文字列	カスタムフィールドのタイプ
name	文字列	カスタムフィールドの名前
comment	文字列	カスタムフィールドの説明
is_required	boolean	必須項目かどうか

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/notes/note_template?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス

{
    "code": 1000,
    "note_template": [
        {
            "id": 1,
            "name": "IM業務記録",
            "desc": "カスタマーサポートがIM会話内容を整理・記録するために適用されます",
            "category": "im",
            "ticket_template_id": 1,
            "updated_at": "2017-08-18T12:06:02.000+08:00",
            "custom_fields": [
                {
                    "field_id": 3,
                    "field_type": "TextField",
                    "name": "TextField_3",
                    "comment": null,
                    "owner": "Ticket",
                    "is_required": true
                },
                {
                    "field_id": 14,
                    "field_type": "TextField",
                    "name": "TextField_14",
                    "comment": "発達",
                    "owner": "Ticket",
                    "is_required": false
                },
                {
                    "field_id": 40,
                    "field_type": "TextField",
                    "name": "TextField_40",
                    "comment": null,
                    "owner": "Ticket",
                    "is_required": false
                },
                {
                    "field_id": 5,
                    "field_type": "SelectField",
                    "name": "SelectField_5",
                    "comment": null,
                    "owner": "Ticket",
                    "is_required": false
                },
                {
                    "field_id": 17,
                    "field_type": "TextField",
                    "name": "TextField_17",
                    "comment": null,
                    "owner": "Ticket",
                    "is_required": false
                }
            ]
        },
        {
            "id": 2,
            "name": "コールセンター業務記録",
            "desc": "カスタマーサポートがコールセンター通話記録を整理・記録するために適用されます",
            "category": "call",
            "ticket_template_id": 1,
            "updated_at": "2017-08-18T12:06:02.000+08:00",
            "custom_fields": []
        }
    ]
}

業務記録テンプレートの修正

このインターフェースは、業務記録テンプレートの内容を修正するために使用されます。

リクエストメソッド

post notes/update_note_template

リクエストパラメータ (request body)

属性	必須	タイプ	説明	制限
id	いいえ	整数型	業務テンプレートのID
category	いいえ	整数型	業務テンプレートのタイプ
ticket_template_id	いいえ	整数型	チケットテンプレートのID
custom_fileds	いいえ	配列	カスタムフィールドのタイプ

• 注意:
• idとcategoryのどちらか一方は必須であり、空であってはなりませんが、両方を同時に渡すことはできません。
• categoryの値はimまたはcallです。
• idのみを渡した場合、idに対応する業務記録テンプレートが返され、更新時間が修正されます。
• categoryのみを渡した場合、categoryに対応する業務記録テンプレートが返され、更新時間が修正されます。

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/notes/update_note_template?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X POST \
-H 'content-type:application/json' \
-d '{
  "id":"1",
    "ticket_template_id": 30002,
    "custom_fileds":  [
       {"field_id":3, "field_type":"TextField", "is_required":true},
     {"field_id":14, "field_type":"TextField", "is_required":false},
     {"field_id":40, "field_type":"TextField", "is_required":false},
     {"field_id":17, "field_type":"TextField", "is_required":false},
     {"field_id":5, "field_type":"SelectField", "is_required":false},
     {"field_id":41, "field_type":"TextField", "is_required":true}

   ]

}'

レスポンス

{
    "code": 1000,
    "ticket_template_id":30002,
    "note_template": {
        "id": 1,
        "name": "IM業務記録",
        "desc": "カスタマーサポートがIM会話の内容を整理して記録するために適用されます",
        "category": "im",
        "ticket_template_id": 30002,
        "custom_fields": [
            {
                "field_id": 3,
                "field_type": "TextField",
                "name": "TextField_3",
                "comment": null,
                "is_required": true
            },
            {
                "field_id": 14,
                "field_type": "TextField",
                "name": "TextField_14",
                "comment": "発達",
                "is_required": false
            },
            {
                "field_id": 40,
                "field_type": "TextField",
                "name": "TextField_40",
                "comment": null,
                "is_required": false
            },
            {
                "field_id": 17,
                "field_type": "TextField",
                "name": "TextField_17",
                "comment": null,
                "is_required": false
            },
            {
                "field_id": 5,
                "field_type": "SelectField",
                "name": "SelectField_5",
                "comment": null,
                "is_required": false
            },
            {
                "field_id": 41,
                "field_type": "TextField",
                "name": "TextField_41",
                "comment": null,
                "is_required": true
            }
        ]
    }
}

業務記録リストの取得

このAPIは、特定の条件を満たす業務記録のリストを取得するために使用されます。

リクエストメソッド

get /notes

リクエストパラメータ(query string)

属性	必須	型	説明	制限
start_date	いいえ	日時	業務記録の開始日時
end_date	いいえ	日時	業務記録の終了日時
category	いいえ	文字列	業務記録のタイプ。値は"im"または"call"
page	いいえ	整数	現在のページ。デフォルトは1
per_page	いいえ	整数	1ページあたりに表示するデータ数。範囲は1〜50、デフォルトは20

• 説明：
• 作成日時がstart_dateとend_dateの間にある業務記録を取得します。デフォルトでは当日のデータを取得します。1年以内のデータを取得可能です。フォーマットは年-月-日(例：2017-09-10)です。
• 渡されたpageパラメータのフォーマットが正しくない場合、このパラメータは解析されず、デフォルト値の1が使用されます。

レスポンスデータ

属性	型	説明
code	整数	実行結果コード。1000は成功を表します
note_record	配列	業務記録
meta	オブジェクト	ページネーション関連の内容

• note_recordのデータ構造

属性	型	説明
id	整数	業務記録ID
content	文字列	内容
agent_id	整数	サポート担当者ID
agent_nick_name	文字列	サポート担当者ニックネーム
customer_id	整数	顧客ID
customer_nick_name	文字列	顧客ニックネーム
custom_fields	配列	カスタムフィールド
created_at	日時	業務記録作成時間
last_editor_id	整数	最終編集者ID
last_editor_nick_name	文字列	最終編集者ニックネーム
category	文字列	業務記録タイプ
session_id	整数	関連セッションID
session_type	文字列	業務記録タイプ
updated_at	日時	業務記録の最終更新時間
### サンプル
#### リクエスト

curl https://demo.udesk.cn/open_api_v1/notes?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2

レスポンス

{
    "code": 1000,
    "note_record": [
        {
            "id": 3,
            "content": "NULL",
            "category": "im",
            "custom_fields": {
                "SelectField_2": "1"
            },
            "created_at": "2017-01-17T14:14:55.000+08:00",
            "updated_at": "2017-01-17T14:14:55.000+08:00",
            "customer_id": 1014,
            "customer_nick_name": null,
            "agent_id": 1,
            "agent_nick_name": "alalla",
            "last_editor_id": 1,
            "last_editor_nick_name": "alalla",
            "session_id": 2,
            "session_type": "ImSubSession",
            "agent_note_template_id": 6
        },
        {
            "id": 2,
            "content": "NULL",
            "category": "im",
            "custom_fields": {
                "TextField_3": "2017-01-19"
            },
            "created_at": "2017-01-17T14:14:51.000+08:00",
            "updated_at": "2017-01-17T14:14:51.000+08:00",
            "customer_id": 1014,
            "customer_nick_name": null,
            "agent_id": 1,
            "agent_nick_name": "alalla",
            "last_editor_id": 1,
            "last_editor_nick_name": "alalla",
            "session_id": 4,
            "session_type": "ImSubSession",
            "agent_note_template_id": 3
        },
        {
            "id": 1,
            "content": "主題ラララ",
            "category": "im",
            "custom_fields": {
                "TextField_3": "2017-01-25",
                "TextField_4": "23:58:59",
                "TextField_5": "12313",
                "TextField_6": "2343243",
                "TextField_7": "https://demo.udesk.cn/entry/analysis/im/record",
                "SelectField_2": "0",
                "SelectField_3": "0,0,0",
                "SelectField_5": "0,1,2"
            },
            "created_at": "2017-01-17T14:13:41.000+08:00",
            "updated_at": "2017-01-17T14:13:41.000+08:00",
            "customer_id": 1014,
            "customer_nick_name": null,
            "agent_id": 1,
            "agent_nick_name": "alalla",
            "last_editor_id": 1,
            "last_editor_nick_name": "alalla",
            "session_id": 5,
            "session_type": "ImSubSession",
            "agent_note_template_id": 2
        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_records": 3
    }
}

特定の業務記録詳細を取得

このインターフェースは、特定の条件を満たす1件の業務記録を取得するために使用されます。

リクエストメソッド

get /notes/detail

リクエストパラメータ(query string)

属性	必須	型	説明	制限
note_id	いいえ	整数型	業務記録ID
category	いいえ	文字列	業務記録タイプ
session_id	いいえ	整数型	関連ID

• 説明: 結果を取得する方法は2通りあります。
• 1つは、渡されたnote_idに基づいて直接クエリする方法で、note_idを渡すだけで済みます。
• もう1つは、categoryとsession_idを組み合わせてクエリする方法で、categoryとsession_idの両方を渡す必要があり、どちらも空であってはなりません。
• 3つの値を同時に渡すことはできません。

レスポンスデータ

属性	型	説明
code	整数型	実行結果コード、1000は成功を表します
note_record	オブジェクト	業務記録

• note_recordのデータ構造

属性	型	説明
id	整数型	業務記録ID
content	文字列	業務記録の主題
agent_id	整数型	サポート担当者ID
agent_nick_name	文字列	サポート担当者のニックネーム
customer_id	整数型	顧客ID
customer_nick_name	文字列	顧客のニックネーム
custom_fields	配列	カスタムフィールド
created_at	日時	業務記録の作成時間
updated_at	日時	業務記録の最終更新時間
last_editor_id	整数型	最終編集者のID
last_editor_nick_name	文字列	最終編集者のニックネーム
category	文字列	業務記録タイプ
session_id	整数型	関連ID
session_type	文字列	業務記録
### サンプル
#### リクエスト

curl https://demo.udesk.cn/open_api_v1/notes/detail?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2&note_id=1

レスポンス

{
    "code": 1000,
    "note_record": {
        "id": 1,
        "content": "主題ラララ",
        "category": "im",
        "custom_fields": {
            "TextField_3": "2017-01-25",
            "TextField_4": "23:58:59",
            "TextField_5": "12313",
            "TextField_6": "2343243",
            "TextField_7": "https://demo.udesk.cn/entry/analysis/im/record",
            "SelectField_2": "0",
            "SelectField_3": "0,0,0",
            "SelectField_5": "0,1,2"
        },
        "created_at": "2017-01-17T14:13:41.000+08:00",
        "updated_at": "2017-01-17T14:13:41.000+08:00",
        "customer_id": 1014,
        "customer_nick_name": null,
        "agent_id": 1,
        "agent_nick_name": "alalla",
        "last_editor_id": 1,
        "last_editor_nick_name": "alalla",
        "session_id": 5,
        "session_type": "ImSubSession",
        "agent_note_template_id": 2
    }
}

業務記録を修正

このAPIは、特定の業務記録を修正するために使用されます。

リクエストメソッド

put /notes/:id

リクエストパラメータ(request body)

属性	必須	型	説明	制限
note	はい	オブジェクト	業務記録の内容

noteのデータ構造は以下の通りです

属性	必須	型	説明	制限
content	いいえ	文字列	業務記録の主題
last_editor_id	いいえ	整数型	最終編集者のID
custom_fields	いいえ	オブジェクト	カスタムフィールド
### 返却データ

属性	タイプ	説明
code	整数型	実行結果コード、1000は成功を表す
note_record	オブジェクト	業務記録

note_recordのデータ構造

属性	タイプ	説明
id	整数型	業務記録ID
content	文字列	業務記録の主題
agent_id	整数型	カスタマーサポートID
agent_nick_name	文字列	カスタマーサポートのニックネーム
customer_id	整数型	顧客ID
customer_nick_name	文字列	顧客のニックネーム
custom_fields	配列	カスタムフィールド
created_at	日時	業務記録の作成時間
last_editor_id	整数型	最終編集者のID
last_editor_nick_name	文字列	最終編集者のニックネーム
category	文字列	業務記録のタイプ
session_id	整数型	関連ID
session_type	文字列	業務記録

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/notes/1?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X PUT \
-H 'content-type:application/json' \
-d '{
  "content": "業務記録を修正",
  "custom_fields" : {
      "TextField_3": "2017-01-25",
        "TextField_4": "23:58:59",
        "TextField_5": "12313",
        "TextField_6": "2343243",
        "TextField_7": "https://demo.udesk.cn/entry/analysis/im/record",
        "SelectField_2": "0",
        "SelectField_3": "0,0,0",
        "SelectField_5": "0,1,2"
  }
}'

レスポンス

{
    "code": 1000,
    "note_record": {
        "id": 1,
        "content": "業務記録を修正",
        "category": "im",
        "custom_fields": {
            "TextField_3": "2017-01-25",
            "TextField_4": "23:58:59",
            "TextField_5": "12313",
            "TextField_6": "2343243",
            "TextField_7": "https://demo.udesk.cn/entry/analysis/im/record",
            "SelectField_2": "0",
            "SelectField_3": "0,0,0",
            "SelectField_5": "0,1,2"
        },
        "created_at": "2017-01-17T14:13:41.000+08:00",
        "customer_id": 1014,
        "customer_nick_name": null,
        "agent_id": 1,
        "agent_nick_name": "alalla",
        "last_editor_id": 1,
        "last_editor_nick_name": "alalla",
        "session_id": 5,
        "session_type": "ImSubSession"
    }
}

業務記録変更

このインターフェースは、業務記録の作成または変更に使用されます。

リクエストメソッド

post /notes

リクエストパラメータ

属性	必須	型	説明	制限
category	はい	文字列	業務記録タイプ,im/call
session_id	はい	整数	業務記録関連ID
note	はい	オブジェクト	業務記録内容

• noteのデータ構造は以下の通りです。

属性	必須	型	説明	制限
agent_id	はい	整数	サポート担当者ID
customer_id	はい	整数	顧客ID
session_id	はい	整数	業務記録に対応するsession_id
session_type	はい	文字列	業務記録に対応するタイプ
content	はい	文字列	業務記録詳細内容
last_editor_id	はい	整数	最終編集者ID
custom_fields	はい	オブジェクト	カスタムフィールド
### レスポンスデータ

属性	型	説明
code	整数型	実行結果コード,1000は成功を表します
note_record	オブジェクト	業務記録

• note_recordのデータ構造

属性	型	説明
id	整数型	業務記録ID
content	文字列	業務記録の主題
agent_id	整数型	カスタマーサポートID
agent_nick_name	文字列	カスタマーサポートのニックネーム
customer_id	整数型	顧客ID
customer_nick_name	文字列	顧客のニックネーム
custom_fields	配列	カスタムフィールド
created_at	日時	業務記録の作成時間
last_editor_id	整数型	最終編集者のID
last_editor_nick_name	文字列	最終編集者のニックネーム
category	文字列	業務記録のタイプ
session_id	整数型	関連付けID
session_type	文字列	業務記録

例

リクエスト

curl https://demo.udesk.cn/open_api_v1/notes?email=admin@udesk.cn&timestamp=1494474404&sign=6892f1b794071c260e1b1eac15df588fc919c9e86eb742affaa742ad6c03cb52&nonce=2d931510-d99f-494a-8c67-87feb05e1594&sign_version=v2 \
-X POST \
-H 'content-type:application/json' \
-d '{
    "category": "im",
    "session_id": 5,
    "note": {
        "content": "業務記録を修正",
        "agent_id": 1,
        "customer_id": 1014,
        "session_id": 5,
        "session_type": "ImSubSession",
        "last_editor_id": 1,
        "custom_fields": {
            "TextField_3": "2017-01-25",
            "TextField_4": "23:58:59",
            "TextField_5": "12313",
            "TextField_6": "2343243",
            "TextField_7": "https://demo.udesk.cn/entry/analysis/im/record",
            "SelectField_2": "0",
            "SelectField_3": "0,0,0",
            "SelectField_5": "0,1,2"
        }
    }
}'

レスポンス

{
    "code": 1000,
    "note_record": {
        "id": 1,
        "content": "業務記録を修正",
        "category": "im",
        "custom_fields": {
            "TextField_3": "2017-01-25",
            "TextField_4": "23:58:59",
            "TextField_5": "12313",
            "TextField_6": "2343243",
            "TextField_7": "https://demo.udesk.cn/entry/analysis/im/record",
            "SelectField_2": "0",
            "SelectField_3": "0,0,0",
            "SelectField_5": "0,1,2"
        },
        "created_at": "2017-01-17T14:13:41.000+08:00",
        "customer_id": 1014,
        "customer_nick_name": null,
        "agent_id": 1,
        "agent_nick_name": "alalla",
        "last_editor_id": 1,
        "last_editor_nick_name": "alalla",
        "session_id": 5,
        "session_type": "ImSubSession"
    }
}

---

コードエラーコード

エラーコード	message情報	exception:message情報	説明
2000	不明なエラー	申し訳ありませんが、idとcategoryのいずれかを入力する必要があり、値は空にできません	idとcategoryのいずれかを入力する必要があり、値は空にできません
	不明なエラー	検証失敗: チケットテンプレートは空にできません	チケットテンプレートが空または存在しません
	不明なエラー	per_pageの範囲は1~50です	per_pageの範囲は1~50です
	不明なエラー	申し訳ありませんが、該当リソースは存在しません	入力されたidに対応するリソースが見つかりません。idが存在しないか、idの形式が正しくない可能性があります
	不明なエラー	categoryとsession_idは同時に入力する必要があり、空にできません	categoryとsession_idは同時に入力する必要があり、空にできません
	不明なエラー	存在しないパラメータタイプ	categoryの取り得る値はimまたはcallのいずれかです
	不明なエラー	last_editor_idに対応するエージェントが存在しません	last_editor_idに対応するエージェントが存在しません
2005	該当リソースが見つかりませんでした	ActiveRecord::RecordNotFound	入力されたidに対応するリソースが見つかりません。idが存在しないか、idの形式が正しくない可能性があります
	該当リソースが見つかりませんでした	Couldn't find ImSubSession with 'id'=xxx WHERE im_sub_sessions.company_id = ?	categoryとsession_idに対応するリソースが見つかりません
2015	管理者以外は操作できません	管理者以外は操作できません	インターフェースを呼び出す際のメールアドレスは管理者のものである必要があります。管理者以外は操作できません
2059	open apiの署名が正しくありません	open apiの署名が正しくありません	open apiの署名が正しくありません。詳細は認証セクションのドキュメントを参照してください