Help Center/ Cognitive Engagement Center/ API Reference/ Agent Workbench Interface Reference/ Agent Bidirectional Calls/ Obtaining the Information About the Destination Device of a Call (getCalledInfo)
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Obtaining the Information About the Destination Device of a Call (getCalledInfo)

Scenario

This interface is invoked to obtain call data.

Method

POST

URI

https://{Domain name}/apiaccess/CC-Management/v1/mobileAgent/getCalledInfo, where, {Domain name} can be 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

called

String

Yes

Called number.

Length limit: string (32)

1

caller

String

Yes

Calling number.

Length limit: string (32)

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

retCode

String

Yes

Return code. The value 0 indicates success and other values indicate failure.

4: The called party ID cannot be obtained.

5: The called party ID is not configured.

1.2

retMsg

String

Yes

Failure cause.

1.3

result

Object

No

Result content.

1.3.1

devType

Number

No

Device type.

0: skill queue

1: number

Length limit: number (4)

1.3.2

called

String

No

Called number.

Length limit: string (32)

1.3.3

skillId

Number

No

Skill queue.

Length limit: number (16)

1.3.4

skillName

String

No

Skill queue name.

Length limit: string(64)
  • 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

  • Scenario: example message

    Request header:

    x-app-key:9******************************3  
Authorization:Bearer 9******************************7  
Content-Type:application/json

    Request parameters:

    {
	"caller": 8888888,
	"called": 6666614
}

    Response parameters:

    {
	"retMsg": "Called is not configured",
	"retCode": "5"
}