CustomerServiceUrl

更新时间 2024-07-24 02:58:49

我的收藏

注意

该接口已不支持新增接入，建议开发者直接接入平台客服组件

使用限制

目前只对授权行业的开发者开放官方客服能力，用 im_type 参数声明所属行业。

接口说明

该接口用于行业授权小程序获取官方客服链接，得到链接后通过 web-view 组件加载链接，可以跳转至客服页面，实现接入官方客服的能力。

代调用小程序使用 authorizer_access_token 作为调用凭据 access-token。

基本信息

HTTP URL	https://developer.toutiao.com/api/apps/chat/customer_service_url
HTTP Method	GET
权限要求	无

请求头

名称	类型	是否必须	描述
access-token	string	是	授权小程序接口调用凭据，详情见 getAccessToken

请求参数

名称	类型	是否必填	描述	示例值
appid	string	是	授权小程序 appid	tt**********
openid	string	是	用户在当前小程序的 ID，使用 code2session 接口返回的 openid	SuQBK********N5f
type	string	是	来源，抖音传 1128，抖音极速版传 2329	1128
scene	string	是	场景值，固定值 1	1
order_id	string	否	订单号	162d********31
im_type	string	是	im_type声明客服所属行业，小程序服务类目必须属于该行业。 "group_buy"：酒旅、美食、其他本地服务行业	group_buy

请求示例

js复制
curl --location --request GET 'https://developer.toutiao.com/api/apps/chat/customer_service_url?scene=1&openid
=SuQBK********N5f&appid=ttabc********8&type=1128&im_type=group_buy&order_id=162d********' \
--header 'Access-Token: 080112**************************50673d3d'

响应参数

名称	类型	是否必填	描述	示例值
err_no	int	是	错误码	0
err_msg	string	是	错误信息	"success"
log_id	string	是	字节内部log_id，用于问题快速定位	"20272************"
data	object	是	data 字段	"https://lf3-csp.bytetos.com/xxx.html"

data 字段

名称	类型	是否必填	描述	示例值
url	string	是	官方客服链接	"https://lf3-csp.bytetos.com/xxx.html"

响应示例

正常返回

json复制
{
  "data": {
    "url": "https://lf3-csp.bytetos.com/xxx.html"
  },
  "err_no": 0,
  "err_msg": "",
  "log_id": "202209272************1184041BF1BB"
}

错误返回

json复制
{
  "data": {
    "url": ""
  },
  "err_no": 11009,
  "err_msg": "参数不全",
  "log_id": "20220927************184041BF1BB"
}

错误码

HTTP状态码	错误码	描述	排查建议
200	-1	系统错误	系统错误
200	11002	scene 参数不合法	scene 参数不合法
200	11002	appid 参数不合法	appid 参数不合法
200	11002	openid 参数不合法	openid 参数不合法
200	11002	type 参数不合法	type 需要传固定值1
200	11009	参数绑定错误	参数类型错误
200	11015	im_type 参数不合法	im_type 参数不合法
200	11016	token 解析 appid 失败	重新获取token
200	11016	token 与 appid 不匹配	token 与 appid 不匹配
200	11020	当前服务类目不允许使用该im_type	小程序现有的服务类目不属于im_type指定行业
200	11021	appid未加白名单	appid未加白名单