Updated on 2023-09-27 GMT+08:00

Writing Back Business Results

Scenario

This interface is invoked to write back business results to the outbound call data table t_isl_data and the outbound call data result table t_isl_data_result to record the outbound call data and the business result. If the callback result matches the business result and the retry policy based on the business result set in the outbound campaign task, the system retries the call.

Usage Description

  • Prerequisites
    • The corresponding AK/SK authentication permission is available.
    • An outbound campaign has been created, and outbound call data has been added.
    • The outbound call is successful.
    • The result of the outbound call business is added.
  • Precautions
    • After a request is received, the server needs to return a 200 response. Other responses indicate that the writeback fails.

Method

This interface supports only the POST method.

URI

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callBusiResult/{dataId}

In the URL, ip indicates the IP address of the CC-iSales server, and port indicates the HTTPS port number of the CC-iSales server.

Table 1 Parameters in the URL

No.

Parameter

Type

Mandatory or Not

Description

1

vdnId

Integer

Yes

VDN ID.

The value is an integer ranging from 1 to 9999.

2

dataId

Integer

Yes

Outbound call data ID.

Request Description

Table 2 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

Content-Type

String

Yes

The value is fixed to application/json; charset=UTF-8.

2

Authorization

String

Yes

For details about the generation mode, see C2 Monitoring, System Outbound Call, CDR, and Knowledge Base Interface Authentication.

Table 3 Request body parameters

No.

Parameter

Type

Mandatory or Not

Description

1

busiResult

String

Yes

Business result code, which can contain a maximum of 50 characters.

2

subStatus

String

No

Subbusiness status code, which can contain a maximum of 50 characters.

3

busiResultDesc

String

No

Business result description.

4

workNo

String

No

Platform work ID of the agent who makes a call.

If the same outbound call data is required, the call is always routed to the same agent. This parameter is mandatory. If this parameter is not set, the call is routed to another agent.

Response Description

Table 4 Response body parameters

No.

Parameter

Type

Description

1

resultCode

String

Error code. The value 0200000 indicates success, and other values indicate failure.

For details, see Table 5.

2

resultDesc

String

Description.

Triggered Event

None

Error Codes

Table 5 Error code description

No.

Error Code

Description

1

0200001

Parameter error. For details about the error, see resultDesc.

2

0200033

The outbound call data does not exist.

3

0200034

The substatus does not match the business result.

4

0200999

Failed to write back the business result.

5

02000001

Empty parameter.

6

02000002

The parameter contains invalid characters.

7

02000003

The parameter length cannot exceed the maximum length.

8

02000004

The parameter length cannot be less than the minimum length.

9

02000005

The parameter length must be within the specified range.

10

02000006

Incorrect parameter type.

11

02000007

Incorrect parameter value.

12

02000008

Parameter conversion error. Check the request parameters.

13

02000009

Incorrect parameter combination. Check the request parameters.

14

02000010

The hour and minute parameters must be set at the same time.

15

02000011

The number of parameters cannot exceed the specified number.

Example

  • The following provides an example of the request body of this interface:
    {
        "busiResult": "1621474513",
        "subStatus": "1048856206",
        "busiResultDesc": "1",
        "workNo": "2033"
    }
  • The following provides an example of the response body of this interface:
    {
      "resultCode": "0200000",
      "resultDesc": "The business result is written back successfully."
    }