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

Querying Call Information (queryCallInfoByCallId)

Scenario

This interface is invoked to query call information.

Method

POST

URI

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

4

agentId

String

Yes

Agent ID.

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1

caller

Number

No

Calling number.

2

called

Number

No

Called number.

3

mediaAbility

Number

No

Media type.

4

calldata

String

No

Call-associated data.

5

callId

String

No

Call ID.

6

callSkillId

Number

No

Call skill ID.

7

callSkill

String

No

Call skill description.

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",
        "agentId": "109",
}

Response parameters:

{
	"caller": 70004,
	"called": 60015,
	"mediaAbility": 1,
	"calldata": "1",
	"callId": "1652317325-339",
	"callSkillId": 1,
	"callSkill": "voice",
	"callType": 0
}