Help Center/ Cognitive Engagement Center/ API Reference/ Web Client Access Interface Reference/ Querying Information About the Current Chat on the Online Chat Workbench (getUserInfoBycallId)
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Querying Information About the Current Chat on the Online Chat Workbench (getUserInfoBycallId)

Scenario

This interface is invoked to query information about the current chat on the online chat workbench.

Method

POST

URI

https://Domain name/apiaccess/rest/workbench/v1/getUserInfoBycallId (For example, the domain name is service.besclouds.com.)

Request Description

Table 1 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

X-APP-Key

String

No

App key, which is the user ID

2

Authorization

String

Yes

Authentication field. The format is Bearer {Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.)
Table 2 Request body parameters

No.

Parameter

Type

Mandatory or Not

Description

1

callId

String

Yes

Call ID

2

userId

String

Yes

User ID. The value is a string of 1 to 32 characters.

3

tenantId

String

Yes

Tenant ID

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1

userNickname

String

Yes

Name

2

userId

String

Yes

User ID

3

userAvatar

String

No

User avatar

4

channel

String

Yes

Channel name, for example, WEB, WECHAT, or FACEBOOK

5

createTime

String

Yes

Creation time

6

channelConfigId

String

Yes

Channel configuration ID

7

userAgent

String

No

User proxy

8

clientIp

String

No

Client IP address

9

osName

String

No

Operating system name

10

borderType

String

No

Operating system version
  • Status code: 400

    Incorrect request. Check the request path and parameters.

  • Status code: 401

    Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.

  • Status code: 404

    The requested content is not found. Check the request path.

  • Status code: 500

    Business failure. Check the values of parameters in the request.

Error Codes

None

Example

None