=====远程协助服务记录===== ====服务记录JSON格式==== ^名称 ^类型 ^只读 ^注释^ |csId| int |是| 服务记录id,系统自动分配 | |csIdS| char|是| 会话id,标识一次会话| |csBTime| DATETIME |是| 服务开始时间,格式为:2017-8-27 10:32:12| |csETime| DATETIME |是 | 服务结束时间,格式为:2017-8-27 10:32:12 | |csStat| tinyint| 是 |服务状态,0-无效,1-服务中,2-服务等待中,3-服务延长中,4-服务保留中,5-服务完成| |csServicerId| int|是 | 处理客服id | |uniqueNumber| char|是| 帮我吧客户端ID(9位ID),系统生成| |csSId| int |是| 服务卡id | |csPrice| decimal|否|服务费 | |payStat| tinyint|是|支付状态,0-没支付,1-支付成功,2-支付失败,3-刚打开支付页面更新记录,4-在线扣费成功 | |payDateTime| DATETIME |是|支付时间 | |companyName| varchar|否|公司名称 | |contactor| varchar|否|联系人 | |contactMethod| varchar|否|联系方式 | |ComputerName| varchar|否|主机备注 | |ptId| int|是|一级问题类型id | |ptChildId| int|是|二级问题类型id | |ptThird| int|是|三级问题类型id | |note| text|否|问题描述 | |ProblemSolution| text|否|解决办法 | |commentScore| tinyint|否|评价,5-好评,3-中评,1-差评,0-未评价| |comment| varchar|否|评价内容| |isFinish| tinyint|否|问题是否得以解决,0-没解决,1-已解决 | |ChatRecord| tinyint|是|有无文字聊天,0-无聊天记录,1-有聊天记录 | |Remote| tinyint|是|有无远程,0-没有发起远程,1-发起远程 | |TransferFile| tinyint|是|有无文件传输,0-没有传输文件,1-有传输文件 | |FileCount| tinyint|是|本次服务传输的文件个数 | |custom_fields| array|否|远程服务记录自定义字段 | |contents| varchar|是|聊天记录的资源url | ====服务记录JSON示例==== { "csId": 123, "csIdS": "MjAxNy0wOC0xOCAxMDozMzowNQ==", "csBTime": "2017-8-27 10:21:10", "csETime": "2017-8-27 10:21:10", "csStat": 5, "csServicerId": 223, "csPrice": 234.00, "payStat": 1, "payDateTime": "2017-8-27 10:21:10", "companyName": "金万维科技有限公司", "contactor": "张三", "contactMethod": "13240138478", "ComputerName": "这里是主机备注", "ptId": 223, "ptChildId": 453, "ptThird": 345, "note": "这里是问题描述", "ProblemSolution": "这里是解决办法", "commentScore": 5, "comment": "这里是评价内容", "isFinish": 1, "ChatRecord": 1, "Remote": 1, "TransferFile": 1, "FileCount": 3, "custom_fields": [ { "key": "field_1", "value": "4334" }, { "key": "field_3", "value": "1" //复选框 }, { "key": "field_2", "value": "下拉菜单的某一项" } ] "contents":"https://www.bangwo8.com/api/v1/remoterecord/chatrecords/123.json" } ====消息JSON格式==== ^名称 ^类型 ^注释 ^ |spokesman |varchar |发言人的名字。发言人是客服时,返回客服姓名,发言人是用户时,返回客户端9位ID| |spokesman_identity |tinyint |发言人的身份:1-客服,2-用户| |msg |text |聊天内容| |time |datetime |消息发送时间| ====消息JSON示例==== { "spokesman": "289789809", "spokesman_identity": "2", "msg": "kj", "time": "2018-10-24 15:14:12" } ====服务记录列表==== GET /api/v1/remoterecord/histories.json //说明:接口返回值中的“一级问题类型”、“二级问题类型”、“三级问题类型”均为下拉列表类型的字段,当前接口默认返回的是选项ID,以下接口可返回选项内容,而非选项ID// GET /api/v1/remoterecord/histories_v2.json \\ **调用者权限** 管理员 **调用参数** ^名称 ^必需的 ^类型 ^注释^ |starttime |否 |datetime |按创建时间筛选,开始时间,格式为:2017-08-27| |endtime |否 |datetime |按创建时间筛选,结束时间,格式为:2017-08-29| |page |否 |int |分页获取,默认为1| |per_page |否 |int |每页大小,默认为100| //说明:结束时间是包含当前时间的,例如结束时间为2017-08-29,则返回的记录包含2017-08-29当天的。// **调用示例** curl https://www.bangwo8.com/api/v1/remoterecord/histories.json \ -v -u {account}:{password} **返回值示例** Status: 200 OK { "remoterecords": [ { "csId": 123, "csIdS": "MjAxNy0wOC0xOCAxMDozMzowNQ==", ... }, { "csId": 124, "csIdS": "MjAxNy0wOC0xOCAxMDozMzowNQ==", ... }, ... ], "count": 42, "next_page": "https://www.bangwo8.com/api/v1/remoterecord/histories.json?per_page=40&page=2", "previous_page": null } ====查看指定客服的服务记录==== GET /api/v1/remoterecord/histories/{id}.json **调用者权限** 管理员 **调用参数** ^名称 ^必需的 ^类型 ^注释^ |starttime |否 |datetime |按创建时间筛选,开始时间,格式为:2017-08-27| |endtime |否 |datetime |按创建时间筛选,结束时间,格式为:2017-08-29| |page |否 |int |分页获取,默认为1| |per_page |否 |int |每页大小,默认为100| //说明:结束时间是包含当前时间的,例如结束时间为2017-08-29,则返回的记录包含2017-08-29当天的。// **调用示例** curl https://www.bangwo8.com/api/v1/remoterecord/histories/{id}.json \ -v -u {account}:{password} **返回值示例** Status: 200 OK { "remoterecords": [ { "csId": 123, "csIdS": "MjAxNy0wOC0xOCAxMDozMzowNQ==", ... }, { "csId": 124, "csIdS": "MjAxNy0wOC0xOCAxMDozMzowNQ==", ... }, ... ], "count": 42, "next_page": "https://www.bangwo8.com/api/v1/remoterecord/histories/{id}.json?per_page=40&page=2", "previous_page": null } ====查看指定服务记录的聊天记录==== GET /api/v1/remoterecord/chatrecords/{id}.json //说明:仅支持文本消息。// **调用者权限** 管理员 **调用参数** ^名称 ^必需的 ^类型 ^注释^ |time_start |否 |datetime |按聊天内容发送日期筛选:开始时间,格式为:2017-8-27| |time_end |否 |datetime |按聊天内容发送日期筛选:结束时间,格式为:2017-8-27,与time_start成对出现| |page |否 |int |分页获取,默认为1| |per_page |否 |int |每页大小,默认为100| **调用示例** curl https://www.bangwo8.com/api/v1/remoterecord/chatrecords/221.json -v -u {account}:{password} **返回值示例** Status: 200 OK { "remote_chatrecords":{ "csId":"221", "contents":[ { "spokesman":213, "spokesman_identity":1, "msg":"这里是具体的聊天内容", "time":"2017-8-23 13:12:23" }, { "spokesman":234, "spokesman_identity":1, "msg":"这里是具体的聊天内容", "time":"2017-8-23 13:12:23" } ] }, "count":42, "next_page":"https://www.bangwo8.com/api/v1/remoterecord/chatrecords/221.json?per_page=40&page=2", "previous_page":null } ====查看指定远程服务的服务总结==== **请求参数** ^名称 ^必填 ^类型 ^注释^ |csId|是 | int|服务记录id,系统自动分配 | |servicesummary_type|是 |int |1-im 2-呼叫中心 3-远程协助 获取远程服务的服务总结servicesummary_type=3| **请求地址** GET /api/v1/servicesummary/{csId}.json **调用者权限** 所有客服 **调用示例** curl https://www.bangwo8.com/api/v1/servicesummary/231.json -v -u {account}:{password} **返回参数** ^名称 ^只读 ^类型 ^注释^ |ticketTemplateName|是 | String|模板名称 | |custom_fields|是 |array |服务总结模板自定义字段| **返回值示例** { "status":"200" , "message":"Successful", "data":{ "serviceSummary":{ "ticketTemplateName": "服务总结模板名称", "custom_fields": [//自定义字段 { "key": "field_1",//自定义字段的唯一标识,可从帮我吧后台查看 "value": "4334" }, { "key": "field_3",//自定义字段的唯一标识,可从帮我吧后台查看 "value": "1" //复选框 }, { "key": "field_2", "value": "下拉菜单的某一项" }, { "key": "field_4", "value": "附件的下载地址" //附件多个时,以逗号分隔 } ] } } } //注意 没有绑定服务总结模板返回示例 { "status":"120001" , "message":"No service summary template", } 未填写服务总结返回示例 { "status":"120002" , "message":"No service summary information", }