业务记录接口 - Udesk | 开发者中心

获取业务记录模板

该接口用于获取公司下的所有业务记录模板

请求方法

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	字符串	自定义字段的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
            }
        ]
    }
}

获取业务记录列表

本接口用于获取满足某条件的业务记录列表

请求方法

get /notes

请求参数(query string)

属性	必填	类型	说明
start_date	否	日期时间	业务记录
end_date	否	日期时间	业务记录
category	否	字符串	业务记录类型,值为"im"或"call"
page	否	整型	当前页,默认为1
per_page	否	整型	每页显示的数据量,范围1~50,默认为20

说明：
获取创建时间在start_date和end_date之间的业务记录,默认获取当天的,可获取一年内的数据，格式为年-月-日(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
    }
}

获取某一条业务记录详情

本接口用于获取满足某条件的一条业务记录

请求方法

get /notes/detail

请求参数(query string)

属性	必填	类型	说明
note_id	否	整型	业务记录id
category	否	字符串	业务记录类型
session_id	否	整型	关联id

说明: 这里有两种获取结果的方式
一种是根据传入的note_id直接查询,传入note_id即可
另一种是由category结合session_id来查询的,必须同时传入category和session_id,且不可为空
三个值不可同时传入

返回数据

属性	类型	说明
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
    }
}

修改业务记录

该接口用于修改某条业务记录

请求方法

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"
    }
}

Code错误码

错误码	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需同时传入，且不可为空
	未知错误	unexist params type	ccategory的取值范围是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签名不对，详细内容参考鉴权部分的文档

Keys	Action
`?`	Open this help
`n`	Next page
`p`	Previous page
`s`	Search

获取业务记录模板

请求方法

请求参数

返回数据

示例

请求

返回

修改业务记录模板

请求方法

请求参数(request body)

示例

请求

返回

获取业务记录列表

请求方法

请求参数(query string)

返回数据

示例

请求

返回

获取某一条业务记录详情

请求方法

请求参数(query string)

返回数据

示例

请求

返回

修改业务记录

请求方法

请求参数(request body)

note的数据结构如下

返回数据

note_record的数据结构

示例

请求

返回

业务记录变更

请求方法

请求参数

返回数据

示例

请求

返回

Code错误码

文档反馈