创建服务台对话
该接口用于创建服务台对话。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/helpdesk/v1/start_service |
| HTTP Method | POST |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | helpdesk:helpdesk:access 访问服务台 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
Tip: 服务台请求Header中还需添加“服务台token”参数:
Key: X-Lark-Helpdesk-Authorization
Value: base64(helpdesk_id:helpdesk_token),通过base64加密将helpdesk_id和helpdesk_token用':'连接而成的字符串。
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
human_service | boolean | 否 | 是否直接进入人工(若appointed_agents填写了,该值为必填) 示例值:false |
appointed_agents | string\[\] | 否 | 客服 open ids (获取方式参考获取单个用户信息),human_service需要为true 示例值:["ou_7dab8a3d3cdcc9da365777c7ad535d62"] |
open_id | string | 是 | 用户 open id,(获取方式参考获取单个用户信息) 示例值:"ou_7dab8a3d3cdcc9da365777c7ad535d62" |
customized_info | string | 否 | 工单来源自定义信息,长度限制1024字符,如设置,获取工单详情会返回此信息 示例值:"测试自定义字段信息" |
请求体示例
json
{
"human_service": false,
"appointed_agents": [
"ou_7dab8a3d3cdcc9da365777c7ad535d62"
],
"open_id": "ou_7dab8a3d3cdcc9da365777c7ad535d62",
"customized_info": "测试自定义字段信息"
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ chat_id | string | 客服群open ID |
└ ticket_id | string | 创建的工单 ID(仅人工工单返回该参数) |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"chat_id": "创建的 chat-id",
"ticket_id": "7474857595946745884"
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 155000 | Internal error | 内部错误,请联系我们 |
| 400 | 154000 | Bad request, please check your request body | 请求不合法,请检查参数 |
| 401 | 154001 | Unauthorized, please check you have the correct access | 检查Authorization 和 X-Lark-Helpdesk-Authorization 是否正确,应用和服务台属于同一租户 |
| 404 | 154004 | Resource not found | 资源不存在,请检查ID值 |
| 401 | 154402 | Helpdesk can't be see by user | 用户不在服务台可见范围内 |
