侧边栏

文档首页


CRM扩展

数据接口

呼叫能力

Android IM SDK手册(暂停使用)

iOS IM SDK手册(暂停使用)

Android SIP SDK手册

iOS SIP SDK手册

客户端标准版快速集成

帮我吧远程SDK版本

网页在线客服集成

微信接入

帮我吧文档:数据接口:工单:工单模板

获取工单模板列表

请求参数

请求地址

GET /api/v1/tickettemplates.json

调用者权限

管理员

调用示例

curl https://www.bangwo8.com/api/v1/tickettemplates.json \
  -v -u {account}:{password}

返回参数

名称 类型 只读 必填 注释
tId string 工单模板ID,系统自动生成
url varchar 该工单模板的资源url
ticketTemplateName string 工单模板名称
ticketTemplateDescription string 工单模板的描述
visibleRange string 工单模板的可见范围:1-所有客服,2-客服分组,3-客服,4-当前用户,“当前用户”为配置时,登录后台的人,默认可见范围取值为1-所有客服
servicerGroupId string 客服分组ID,当“visibleRange”取值为“2-客服分组”时,该字段会有值
servicerId string 客服ID,当“visibleRange”取值为“3-客服”时,该字段会有值
isReleased string 是否发布:0-未发布,1-已发布。工单模板发布后,会自动生成URL地址,在该地址填写的内容会自动生成工单,工单默认选中当前模板
creatorId string 创建工单模板的客服ID
createDT string 创建时间,格式为:2018-06-04 10:26:40

返回示例

{
    "tickettemplates": [
        {
            "tId": "4",
            "ticketTemplateName": "安装表",
            "ticketTemplateDescription": "",
            "visibleRange": "1",
            "servicerGroupId": "0",
            "servicerId": "0",
            "isReleased": "1",
            "creatorId": "520177",
            "createDT": "2019-08-21 15:37:01"
        },
        {
            "tId": "8",
            "ticketTemplateName": "维修单",
            "ticketTemplateDescription": "",
            "visibleRange": "1",
            "servicerGroupId": "0",
            "servicerId": "0",
            "isReleased": "0",
            "creatorId": "520177",
            "createDT": "2019-09-09 17:52:58"
        },
        {
            "tId": "9",
            "ticketTemplateName": "保养单",
            "ticketTemplateDescription": "",
            "visibleRange": "1",
            "servicerGroupId": "0",
            "servicerId": "0",
            "isReleased": "0",
            "creatorId": "520177",
            "createDT": "2019-09-09 17:54:32"
        },
        {
            "tId": "10",
            "ticketTemplateName": "设计和开发产品申请表",
            "ticketTemplateDescription": "",
            "visibleRange": "1",
            "servicerGroupId": "0",
            "servicerId": "0",
            "isReleased": "0",
            "creatorId": "520177",
            "createDT": "2019-09-26 15:43:41"
        },
        {
            "tId": "12",
            "ticketTemplateName": "研发项目打印记录表",
            "ticketTemplateDescription": "",
            "visibleRange": "1",
            "servicerGroupId": "0",
            "servicerId": "0",
            "isReleased": "0",
            "creatorId": "520177",
            "createDT": "2019-09-29 15:55:14"
        },
        {
            "tId": "14",
            "ticketTemplateName": "材质报告",
            "ticketTemplateDescription": "",
            "visibleRange": "1",
            "servicerGroupId": "0",
            "servicerId": "0",
            "isReleased": "0",
            "creatorId": "520177",
            "createDT": "2019-09-29 16:07:38"
        },
        {
            "tId": "16",
            "ticketTemplateName": "研发产前会议记录表",
            "ticketTemplateDescription": "",
            "visibleRange": "1",
            "servicerGroupId": "0",
            "servicerId": "0",
            "isReleased": "0",
            "creatorId": "520177",
            "createDT": "2019-09-29 16:30:19"
        },
        {
            "tId": "18",
            "ticketTemplateName": "上机打样工程单",
            "ticketTemplateDescription": "",
            "visibleRange": "1",
            "servicerGroupId": "0",
            "servicerId": "0",
            "isReleased": "0",
            "creatorId": "520177",
            "createDT": "2019-09-29 16:39:25"
        },
        {
            "tId": "20",
            "ticketTemplateName": "设计开发项目评审表",
            "ticketTemplateDescription": "",
            "visibleRange": "1",
            "servicerGroupId": "0",
            "servicerId": "0",
            "isReleased": "0",
            "creatorId": "520177",
            "createDT": "2019-09-30 00:00:58"
        },
        {
            "tId": "22",
            "ticketTemplateName": "手工测试数据表",
            "ticketTemplateDescription": "",
            "visibleRange": "1",
            "servicerGroupId": "0",
            "servicerId": "0",
            "isReleased": "0",
            "creatorId": "520177",
            "createDT": "2019-09-30 01:16:26"
        },
        {
            "tId": "24",
            "ticketTemplateName": "拓盛-项目进度管控表",
            "ticketTemplateDescription": "",
            "visibleRange": "4",
            "servicerGroupId": "0",
            "servicerId": "520177",
            "isReleased": "0",
            "creatorId": "520177",
            "createDT": "2019-09-30 09:26:30"
        },
        {
            "tId": "26",
            "ticketTemplateName": "实验记录测试表",
            "ticketTemplateDescription": "",
            "visibleRange": "1",
            "servicerGroupId": "0",
            "servicerId": "0",
            "isReleased": "0",
            "creatorId": "520177",
            "createDT": "2019-10-07 12:20:29"
        },
        {
            "tId": "28",
            "ticketTemplateName": "项目管理",
            "ticketTemplateDescription": "",
            "visibleRange": "4",
            "servicerGroupId": "0",
            "servicerId": "520177",
            "isReleased": "0",
            "creatorId": "520177",
            "createDT": "2019-10-12 17:33:07"
        },
        {
            "tId": "30",
            "ticketTemplateName": "创建工单接口模板",
            "ticketTemplateDescription": "",
            "visibleRange": "1",
            "servicerGroupId": "0",
            "servicerId": "0",
            "isReleased": "0",
            "creatorId": "520177",
            "createDT": "2019-10-21 16:30:25"
        },
        {
            "tId": "32",
            "ticketTemplateName": "测试",
            "ticketTemplateDescription": "",
            "visibleRange": "4",
            "servicerGroupId": "0",
            "servicerId": "520177",
            "isReleased": "0",
            "creatorId": "520177",
            "createDT": "2019-10-22 14:37:27"
        }
    ],
    "count": "15"

查看指定工单模板信息

请求参数

名称 类型 只读 必填 注释
tId string 工单模板ID,系统自动生成

请求地址

GET /api/v1/tickettemplates/{tId}.json

调用者权限

管理员

调用示例

curl https://www.bangwo8.com/api/v1/tickettemplates/28.json \
  -v -u {account}:{password}

返回参数

名称 类型 只读 必填 注释
tId string 工单模板ID,系统自动生成
url varchar 该工单模板的资源url
ticketTemplateName string 工单模板名称
ticketTemplateDescription string 工单模板的描述
visibleRange string 工单模板的可见范围:1-所有客服,2-客服分组,3-客服,4-当前用户,“当前用户”为配置时,登录后台的人,默认可见范围取值为1-所有客服
servicerGroupId string 客服分组ID,当“visibleRange”取值为“2-客服分组”时,该字段会有值
servicerId string 客服ID,当“visibleRange”取值为“3-客服”时,该字段会有值
isReleased string 是否发布:0-未发布,1-已发布。工单模板发布后,会自动生成URL地址,在该地址填写的内容会自动生成工单,工单默认选中当前模板
creatorId string 创建工单模板的客服ID
createDT string 创建时间,格式为:2018-06-04 10:26:40

返回示例

{
    "tickettemplate": {
        "tId": "28",
        "ticketTemplateName": "项目管理",
        "ticketTemplateDescription": "",
        "visibleRange": "4",
        "servicerGroupId": "0",
        "servicerId": "520177",
        "isReleased": "0",
        "creatorId": "520177",
        "createDT": "2019-10-12 17:33:07"
    }
}

获取多个工单模板信息

请求参数

名称 类型 只读 必填 注释
tId string 工单模板ID,系统自动生成

请求地址

GET /api/v1/tickettemplates/show_many.json?ids={ids}//多个工单模板id以逗号分隔拼接

调用者权限

管理员

调用示例

curl https://www.bangwo8.com/api/v1/tickettemplates/show_many.json?ids=1,2 \
  -v -u {account}:{password}

返回参数

名称 类型 只读 必填 注释
tId string 工单模板ID,系统自动生成
url varchar 该工单模板的资源url
ticketTemplateName string 工单模板名称
ticketTemplateDescription string 工单模板的描述
visibleRange string 工单模板的可见范围:1-所有客服,2-客服分组,3-客服,4-当前用户,“当前用户”为配置时,登录后台的人,默认可见范围取值为1-所有客服
servicerGroupId string 客服分组ID,当“visibleRange”取值为“2-客服分组”时,该字段会有值
servicerId string 客服ID,当“visibleRange”取值为“3-客服”时,该字段会有值
isReleased string 是否发布:0-未发布,1-已发布。工单模板发布后,会自动生成URL地址,在该地址填写的内容会自动生成工单,工单默认选中当前模板
creatorId string 创建工单模板的客服ID
createDT string 创建时间,格式为:2018-06-04 10:26:40

返回示例

{
    "tickettemplates": [
        {
            "tId": "28",
            "ticketTemplateName": "项目管理",
            "ticketTemplateDescription": "",
            "visibleRange": "4",
            "servicerGroupId": "0",
            "servicerId": "520177",
            "isReleased": "0",
            "creatorId": "520177",
            "createDT": "2019-10-12 17:33:07"
        },
        {
            "tId": "30",
            "ticketTemplateName": "创建工单接口模板",
            "ticketTemplateDescription": "",
            "visibleRange": "1",
            "servicerGroupId": "0",
            "servicerId": "0",
            "isReleased": "0",
            "creatorId": "520177",
            "createDT": "2019-10-21 16:30:25"
        }
    ]
}

获取指定工单模板的自定义字段列表

请求参数

名称 类型 只读 必填 注释
tId string 工单模板ID

请求地址

GET /api/v1/tickettemplates/{id}/ticketfields.json

调用者权限

管理员

调用示例

curl https://www.bangwo8.com/api/v1/tickettemplates/1/ticketfields.json? \
  -v -u {account}:{password}

返回参数

名称 类型 注释
tId string 工单模板ID,系统自动生成
url varcha 该工单模板的资源url
ticketTemplateName string 工单模板名称
ticketTemplateDescription string 工单模板的描述
visibleRange string 工单模板的可见范围:1-所有客服,2-客服分组,3-客服,4-当前用户,“当前用户”为配置时,登录后台的人,默认可见范围取值为1-所有客服
servicerGroupId string 客服分组ID,当“visibleRange”取值为“2-客服分组”时,该字段会有值
servicerId string 客服ID,当“visibleRange”取值为“3-客服”时,该字段会有值
isReleased string 是否发布:0-未发布,1-已发布。工单模板发布后,会自动生成URL地址,在该地址填写的内容会自动生成工单,工单默认选中当前模板
creatorId string 创建工单模板的客服ID
isRequired int 是否必填,1-必填 0-非必填
isReadonly int 是否只读,1-只读 0-不只读
createDT string 创建时间,格式为:2018-06-04 10:26:40

返回示例

{
    "ticket_fields": [
        {
            "id": "10131271",
            "name": "一阶段",
            "key": "field_108",
            "type": "14",
            "isRequired": "1",
            "isReadonly": "0",
            "readonly_range": "",
            "readonly_support": "0",
            "custom_field_options": [],
            "custom_field_table": []
        },
        {
            "id": "10131274",
            "name": "二阶段",
            "key": "field_109",
            "type": "14",
            "isRequired": "1",
            "isReadonly": "0",
            "readonly_range": "",
            "readonly_support": "0",
            "custom_field_options": [],
            "custom_field_table": []
        }
    ]
}

获取指定工单模板的所有字段列表(包含系统字段)

请求参数

名称 类型 只读 必填 注释
tId string 工单模板ID

请求地址

GET /api/v2/tickettemplates/{id}/ticketfields.json

调用者权限

  管理员

调用示例

curl https://www.bangwo8.com/api/v2/tickettemplates/1/ticketfields.json? -v -u {account}:{password}
//说明:自字段相关信息可参考[[帮我吧文档:数据接口:工单:工单字段|JSON格式]],默认按字段编码升序返回。

返回值示例

请参考查询工单字段列表的返回值。


页面工具