Updated on 2025-11-13 GMT+08:00

Interface for Writing Back Outbound Call Results

Scenario

This interface is invoked to write call results to the database.

Method

Post

URI

https://Domain name/rest/isales/v1/openapi/obs/business/call/result. An example of the domain name is service.besclouds.com.

Request Description

Table 1 Request header parameters

No.

Parameter

Value Type

Mandatory or Not

Description

1

Authorization

String

Yes

Authentication token.

2

Content-Type

String

No

The value is application/json.

Table 2 Request body parameters

No.

Parameter

Mandatory or Not

Value Type

Description

1

subCCNo

Yes

Integer

ID of a call center.

2

vdnId

Yes

Integer

ID of a VCC.

3

uniqueId

Yes

String

Unique ID of outbound call data.

4

serviceId

Yes

String

Keyword of an outbound call task.

5

status

No

String

Status of an outbound call result.

6

deviceType

No

Integer

Type of an outbound device.

7

phoneNumber

No

String

Called number.

8

failCode

No

String

Call failure cause code returned by the platform.

9

asrResult

No

String

Call failure type classification result returned by intelligent outbound call detection.

10

fetchTime

No

String

Time when call data is obtained.

11

writeStartTime

No

String

Time when a call starts.

12

endCallTime

No

String

Time when a call ends.

13

callId

No

String

Call ID.

Response Description

  • Response status code: 200
    Table 3 Response body parameter

    No.

    Parameter

    Value Type

    Description

    1

    result

    String

    Error code. The options are as follows:

    0: success

    Other values: failure

Error Codes

  • Response status code: 400

    Incorrect request. Check the request path and parameters.

  • Response status code: 401

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

  • Response status code: 403

    Authentication failed.

  • Response status code: 404

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

  • Response status code: 500

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

Example

  • Request header:
Authorization:Bearer e3fca9398eaa5cef4b57b523b9c75fae
Content-Type:application/json

  • Request message:
{
	"subCCNo": 1,
	"vdnId": 88,
	"uniqueId": "21713676089219765504",
	"serviceId": "1251250797",
	"status": "",
	"deviceType": 2,
	"phoneNumber": "88889156",
	"failCode": "",
	"asrResult": "",
	"fetchTime": "",
	"writeStartTime": "",
	"endCallTime": "",
	"callId": ""
}

  • Response message:
    {
    "result":0, // 0: success; other values: failure
    }