视频客服小程序预约接口

发起方 接收方 请求方式
第三方 Udesk POST

计算鉴权token, token = DigestUtils.sha256Hex(appId + "&" + secret + "&" + nonce + "&" + timestap); 请求时header携带该token,header ("token: token")

参数 类型 是否必填 说明
appId String 公司标识,Udesk提供
secret String 鉴权秘钥,Udesk提供
nonce String 单次请求保证唯一,建议uuid
timestap Long 时间戳,秒
参数 类型 是否必填 说明
appId String 公司标识,Udesk提供
nonce String 单次请求保证唯一,建议uuid
timestap Long 时间戳,秒
参数 类型 是否必填 默认值 说明
bizId String null 第三方业务主键,用于关联视频客服视频记录 不能包含中文
customChannel String null 自定义渠道,视频路由会根据此字段进行路由
lockedSecond Int 300 锁定客服的时间,单位秒,最大 3600秒
lockedAgentId Long null 锁定客服的ID
sdkAppId String null Udesk下发的小程序sdkAppId
customerInfo Object null 客户信息对象,详见对象说明
miniPath String null 小程序的跳转路径,page/index/index
subscribeType Int 1 1 锁定客服并生成预约链接,2 仅生成预约链接 默认值1
navigateAction String CALL_DIRECT CALL_DIRECT 进入小程序后直接进行呼叫 HOME_PAGE 进入小程序后停留在呼叫页面,默认CALL_DIRECT
notifyInfo Object null 需要展示的通知信息,详细notifyInfo对象说明(subscribeType 为锁定客服时生效)
noteInfo Object null 自定义参数,详见noteInfo对象说明
urlButtons List null 自定义按钮,详见UrlBtton对象说明 形如 [{"name":"测试按钮","url":"https://www.baidu.com"}]
参数 类型 说明
code Int 返回码,成功时返回 1000
message String 请求结果信息,成功时为 ok
data Object 请求成功时的结果返回体,详见对象说明,失败时不返回该字段
错误码 说明
1000 成功 ok
2001 无效的小程序sdkAppId
2002 预约客服无空闲
2003 保存客户失败
2004 shcemaUrl生成失败
2005 锁定时间不能大于3600秒
60000 签名校验失败
curl -XPOST 'https://baseavs.udesk.cn/avs/openApi/v1/wechatSchema?appId=dccf&timestap=1607399411&nonce=75988827-0a66-4657-afa9-cdf422c95c04'
      -d '{
        "sdkAppId":"SqFpwzdR3IsYVdTP",
        "bizId":"898887",
        "lockedSecond":60,
        "lockedAgentId":123456,
        "customChannel":"beijing",
        "miniPath":"plugin/pages/preIndex/index",
        "customerInfo":{
              "nickName":"张三",
              "avatar":"www.sdfsdfsd.com/avatar1.jpg",
              "telephones":[{"id":null,"content":"13212314423"}],
              ...
          }
        }'
      -H 'token:yyiuuyyyyyyyyyyyyyyyyyyyy'

{
  "code": 1000,
  "data": {
    "agentId": "255764",
    "nickName":"测试客服",
    "openlink":"https://wxaurl.cn/wuJlIDskuhn",
    "lockedToken": "c88827b1001d495b9552c7b1168909ed",
    "miniPath": "plugin/pages/preIndex/index"
  },
  "message": "ok"
}

{
  "code": 2002,
  "message": "预约客服无空闲"
}