Help Center/ Cognitive Engagement Center/ API Reference/ Agent Workbench Interface Reference/ Agent Bidirectional Calls/ Querying Contact Records (queryUserContactLimit)
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Querying Contact Records (queryUserContactLimit)

Scenario

This interface is invoked to query contact records.

Method

POST

URI

https://Domain name/apiaccess/rest/workbench/v1/queryUserContactLimit (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.

3

tenantId

String

Yes

Tenant ID.

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1

callSerialno

String

No

Call SN.

2

countId

String

No

Account.

3

callId

String

No

Call ID.

4

mediaAbility

Number

No

Media type. The options are 1 (voice) and 2 (video).

5

channelType

Number

No

Multimedia channel.

6

talkReason

String

No

Session reason ID.

7

beginTime

Timestamp

No

Start time.

8

callType

Number

No

Call type.
  • 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

Request header:

x-app-key:9******************************3  
Authorization:Bearer 9******************************7

Request parameters:

{
	"callId": "1652317325-339",
	"userId": "1652268429538866153",
	"tenantId": "202205116084"
}

Response parameters:

{
	"callSerialno": "1243353389979684865",
	"countId": "1652268429538866153",
	"callId": "1652317325-339",
	"mediaAbility": 1,
	"channelType": 1,
	"talkReason": "1300404704098042886,1300404506395329541",
	"beginTime": "2022-05-12 01:01:33",
	"callType": 1
}