文档首页/ 云客服/ API参考/ 网页客户端接入/ 查询在线交谈工作台当前交谈的消息(getUserInfoBycallId)
更新时间:2024-08-02 GMT+08:00

查询在线交谈工作台当前交谈的消息(getUserInfoBycallId)

场景描述

查询在线交谈工作台当前交谈的消息。

接口方法

POST

接口URI

https://域名/apiaccess/rest/workbench/v1/getUserInfoBycallId,例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

X-APP-Key

string

False

appKey字段,用户标识

2

Authorization

string

True

鉴权字段,内容格式为:Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格)

表2 请求体参数

序号

名称

参数类型

是否必选

说明

1

callId

string

True

呼叫id

2

userId

string

True

用户id。取值范围:1到24位字符串。

3

tenantId

string

True

租户id

响应说明

  • 响应状态码: 200
表3 响应体参数

序号

名称

参数类型

是否必选

说明

1

userNickname

string

True

姓名

2

userId

string

True

用户id

3

userAvatar

string

False

用户头像

4

channel

string

True

渠道名称,例如WEB,WECHAT,FACEBOOK

5

createTime

string

True

创建时间

6

channelConfigId

string

True

渠道配置id

7

userAgent

string

False

用户代理

8

clientIp

string

False

客户端IP

9

osName

string

False

操作系统名称

10

borderType

string

False

操作系统版本

  • 响应状态码: 400

    错误的请求:请检查请求路径及参数。

  • 响应状态码: 401

    未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。

  • 响应状态码: 404

    请求的内容未找到:请检查请求的路径。

  • 响应状态码: 500

    业务失败:请依次确认您请求中各参数的取值。

错误码

无。

报文样例