获取业务模板列表

业务模板相关接口

业务模板列表

获取所有业务模板的列表信息。

请求方法: GET

请求路径: /api/v1/biztemplates.json

认证方式: Bearer Token

请求参数

无

响应参数

参数	类型	说明
`templateId`	string	业务模板 ID
`name`	string	模板名称
`desc`	string	模板描述
`visible`	string	可见范围
`applyModule`	object	适用模块
`creatorId`	string	创建坐席 ID
`createTime`	datetime	创建时间
`updaterId`	string	更新坐席 ID
`updateTime`	datetime	更新时间
`custom_fields`	array	自定义字段数据
`relTicketTpl`	string	关联工单模板

custom_fields 字段说明

参数	类型	说明
`id`	string	字段 ID，系统自动分配
`url`	string	字段的资源 URL
`name`	string	字段名字
`key`	string	字段的唯一标识
`system`	string	是否为系统字段：1-系统字段，0-自定义字段（默认）
`type`	string	字段类型（详见下方类型对照表）
`isRequired`	int	是否必选：1-非必选，0-必选
`isReadonly`	int	是否只读：1-只读，0-可编辑
`readonly_range`	int	只读范围（`isReadonly=1`时生效）：1-所有客服，2-客服分组，3-客服，4-当前用户
`readonly_support`	string	只读范围对象 ID（客服 ID 或客服分组 ID）
`custom_field_options`	array	下拉列表、高级复选框选项或级联目录

字段类型对照表

值	类型
`1`	下拉列表
`2`	单行文本
`3`	多行文本
`4`	正整数
`5`	小数
`6`	复选框
`7`	正则表达式
`8`	日期（格式：2018-02-03）
`12`	附件
`14`	高级复选框
`17`	电话类型的文本
`18`	级联字段
`26`	日期时间（2020-01-01 10:00:00）

请求示例

响应示例

{
  "requestId": "8c4a9c0d-d52b-487a-8959-3aa3a777d136",
  "status": "0",
  "message": "OK",
  "data": {
    "bizTemplates": [
      {
        "templateId": "15",
        "name": "im记录模板",
        "desc": "",
        "visible": "所有客服",
        "applyModule": {
          "2": "IM在线聊天"
        },
        "relTicketTpl": "工单模板-6",
        "custom_fields": [
          {
            "id": "1",
            "type": "1",
            "key": "priorityLevel",
            "name": "工单优先级",
            "optionInfos": [
              {
                "1": "低",
                "2": "正常",
                "3": "高",
                "4": "紧急"
              }
            ],
            "system": "1"
          }
        ],
        "creatorId": "177757",
        "createTime": "2019-11-13 11:26:27",
        "updaterId": "177757",
        "updateTime": "2019-11-13 11:26:27"
      }
    ]
  }
}

在 Header 添加参数

Authorization

，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password

示例：

Authorization: Basic *****************

返回响应

🟢200成功

application/json

Body

示例

{
    "requestId": "4433dddf-0c8e-44ec-8990-8be5552a4cfe",
    "status": "0",
    "message": "OK",
    "data": {
        "bizTemplates": [
            {
                "templateId": "10",
                "name": "BIANAM1",
                "desc": "",
                "visible": "所有客服",
                "applyModule": {
                    "2": "IM在线聊天"
                },
                "relTicketTpl": "",
                "custom_fields": [
                    {
                        "id": "1",
                        "type": "1",
                        "key": "ticketStatus",
                        "name": "工单状态",
                        "optionInfos": [
                            {
                                "1": "新建",
                                "2": "已开启",
                                "3": "待回应",
                                "4": "已解决",
                                "6": "已关闭"
                            }
                        ],
                        "system": "1"
                    },
                    {
                        "id": "1",
                        "type": "2",
                        "key": "subject",
                        "name": "工单标题",
                        "custom_field_options": [],
                        "system": "1"
                    },
                    {
                        "id": "1",
                        "type": "3",
                        "key": "descript",
                        "name": "工单描述",
                        "custom_field_options": [],
                        "system": "1"
                    },
                    {
                        "id": "1",
                        "type": "1",
                        "key": "priorityLevel",
                        "name": "工单优先级",
                        "optionInfos": [
                            {
                                "1": "低",
                                "2": "正常",
                                "3": "高",
                                "4": "紧急"
                            }
                        ],
                        "system": "1"
                    },
                    {
                        "id": "12280033",
                        "name": "下拉列表",
                        "key": "field_1",
                        "type": "1",
                        "isRequired": "0",
                        "isReadonly": "0",
                        "custom_field_options": [
                            {
                                "key": "1931788",
                                "value": "下拉1天"
                            },
                            {
                                "key": "1931791",
                                "value": "下拉2天"
                            },
                            {
                                "key": "4678142",
                                "value": "下拉10小时"
                            },
                            {
                                "key": "4678143",
                                "value": "下拉20小时"
                            },
                            {
                                "key": "4714936",
                                "value": "选项10分钟"
                            },
                            {
                                "key": "4714937",
                                "value": "选项20分钟"
                            },
                            {
                                "key": "4740592",
                                "value": "氟化钠对方讲话蛋打飞机很大方"
                            },
                            {
                                "key": "4887534",
                                "value": "啧啧啧啧啧啧自知则知之咋咋咋啧啧啧啧则知之咋咋咋咋咋自行车打扫干净考试大纲盛大国际卡拉是搭嘎"
                            },
                            {
                                "key": "4895504",
                                "value": "A"
                            },
                            {
                                "key": "4895505",
                                "value": "B"
                            },
                            {
                                "key": "4895506",
                                "value": "C"
                            },
                            {
                                "key": "4895507",
                                "value": "D"
                            },
                            {
                                "key": "4895508",
                                "value": "E"
                            },
                            {
                                "key": "4895509",
                                "value": "F"
                            },
                            {
                                "key": "4895510",
                                "value": "G"
                            },
                            {
                                "key": "4895511",

业务模板相关接口#

业务模板列表#

请求参数#

响应参数#

custom_fields 字段说明#

字段类型对照表#

请求示例#

响应示例#

请求参数

请求示例代码

返回响应

业务模板相关接口

业务模板列表

请求参数

响应参数

custom_fields 字段说明

字段类型对照表

请求示例

响应示例