Change History

1

Outbound Call Batch Interfaces

New

Added outbound call batch interfaces.

2

Reserved Outbound Call Interfaces

New

Added reserved outbound call interfaces.

1

Adding an Outbound Campaign (V2)

Modified

Added the callOrder field to the request parameters.

2

5.4.4-Modifying an Outbound Campaign (V2)

Modified

3

5.4.6-Querying Details About an Outbound Campaign

Modified

Added the callOrder field to the request parameters.

4

Adding Outbound Numbers (V1)

Modified

Added the priority field to the request parameters.

5

Adding Outbound Numbers (V2)

Modified

6

Importing an Outbound Call Data File from the Server

Modified

7

Importing Outbound Call Data to a Task Group

Modified

1

Adding Outbound Numbers to the Blacklist

Modified

Added request parameters validityTimeUnit, relCategoryId, typeId, and isCoverDupNo.

2

Querying Blacklisted Outbound Numbers

Modified

• Added request parameters relCategoryId and typeId.
• Added response parameters orgName, relCategoryId, relCategoryName, typeId, typeName, and remark.

3

Importing a Blacklist Data File from the Server

Modified

• Added request parameters relCategoryId, typeId, and isCoverDupNo.
• Deleted the blocklist template parameters restrictTimes and restrictPeriod.

4

Adding a Blocklist Group

New

Added the https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blackCategory/create interface for adding a blocklisted number to a blocklist group.

5

Modifying a Blocklist Group

New

Added the https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blackCategory/update interface for modifying a blocklist group.

6

Querying a Blocklist Group

New

Added the https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blackCategory/query interface for querying a blocklist group.

7

Deleting a Blocklist Group

New

Added the https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blackCategory/{categoryId} interface for deleting a blocklist group.

8

Adding a Blocklist Type

New

Added the https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blackType/create interface for adding a blocklist type.

9

Querying a Blocklist Type

New

Added the https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blackType/query interface for querying a blocklist type.

10

Modifying a Blocklist Type

New

Added the https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blackType/update interface for modifying a blocklist type.

11

Deleting a Blocklist Type

New

Added the https://ip:port/rest/ isales/v1/openapi/campaigns/{vdnId}/blackType/{typeId} interface for deleting a blocklist type.

12

Adding an Outbound Campaign (V1)

Modified

Deleted the orgId field.

13

Adding an Outbound Campaign (V2)

Modified

14

Modifying an Outbound Campaign (V1)

Modified

15

Modifying an Outbound Campaign (V2)

Modified

16

Adding the Definition of an Outbound Call Business Result

Modified

17

Setting the Retry Policy of an Outbound Campaign

Modified

Added the policy parameter description when type is 1 or 0.

1

Interface parameter usage principles

New

Description of the IP address and port number of the NSLB server in a URL is added.

2

Adding an Outbound Campaign (V1)

Adding an Outbound Campaign (V2)

Modifying an Outbound Campaign (V1)

Modifying an Outbound Campaign (V2)

Modified

Interface description is modified (changing holidays to special dates) to guarantee consistency with the AICC GUI.

1

Modifying an Outbound Campaign (V1)

Modified

The format of error code description is adjusted.

2

Modifying an Outbound Campaign (V2)

Modified

The value range of the parameter callInterval is modified.

3

Deleting an Outbound Campaign

Modified

Description of error code 0200001 is added.

4

Querying Details About an Outbound Campaign

Modified

The formats of the strBeginTime and strEndTime fields are adjusted.

5

Querying All Outbound Campaigns

Modified

The formats of the strBeginTime and strEndTime fields are adjusted.

6

Querying the Definitions of Outbound Call Business Results

Modified

Description of error code 0200001 is added.

7

Querying the Special Date List of an Outbound Campaign

Modified

Description of error code 0200001 is added.

8

Adding a Special Date of an Outbound Campaign

Modified

The returnCode and returnDesc fields are added to the response description.

9

Deleting a Special Date of an Outbound Campaign

Modified

Description of error code 0200001 is added.

10

Deleting All Special Dates of an Outbound Campaign

Modified

Description of error code 0200001 is added.

11

Adding Outbound Numbers to the Blocklist

Modified

Description of error code 0200007 is added.

12

Querying Blocklist Data File Import Results

Modified

Description of error code 0200006 is added.

13

Adding Outbound Numbers

Modified

A restriction on the customField field is added, that is, special characters are not supported.

14

Adding Outbound Numbers (V2)

Modified

A restriction on the customField field is added, that is, special characters are not supported.

15

Deleting an Outbound Number

Modified

A restriction is added: An outbound number in an ongoing task cannot be deleted.

16

Querying Outbound Numbers

Modified

Description of error code 0200007 is added.

17

Querying Outbound Call Data File Import Results

Modified

Error code description is added.

18

Querying a Single Outbound Call Result

Modified

Call record ID description is added.

19

Querying Call Records of Automatic and Intelligent Outbound Calls (V1.0.0)

Modified

Error code description is added.

Call record ID description is added.

20

Querying Call Records of Automatic and Intelligent Outbound Calls (V2.0.0)

Modified

Error code description is added.

Call record ID description is added.

21

Writing Back Business Results

Modified

Description of error code 0200999 is added.

22

Deleting a File Server

Modified

Description of error code 0200006 is added.

23

Modifying a File Server

Modified

Description of error code 0200006 is added.

24

Querying OBS Outbound Call Result Codes

Modified

Error code description is added.

25

Creating an External Result

Modified

Error code description is added.

26

Modifying an External Result

Modified

Error code description is added.

27

Deleting an External Result

Modified

Error code description is added.

28

Querying the External Result List

Modified

Error code description is added.

29

Querying a Single External Result

Modified

Error code description is added.

1

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callerNo/{campaignId}

New

Added the interface for adding calling numbers.

This interface is invoked to add calling numbers to an outbound campaign.

2

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callerNo/{campaignId}

New

Added the interface for deleting calling numbers.

This interface is invoked to delete calling numbers from an outbound campaign.

1

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callresult/{campaignId}

Modified

Modified the interface for querying outbound call results.

Added the following optional parameters:

beginTime (start time)

endTime (end time)

2

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

https://ip:port/rest/isales/v2/openapi/campaigns/{vdnId}

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

https://ip:port/rest/isales/v2/openapi/campaigns/{vdnId}/{campaignId}

Modified

Modified the value ranges of parameters.

The value range of callCount in ivrParam is as follows:

Before modification: 1–20

After modification: 1–100

The value range of callInterval in ivrParam is as follows:

Before modification: 1–9999

After modification: 1–10

Added the following description to ivrParam parameters:

For IVR outbound calls, the number of outbound calls is calculated as follows: (Value of callCount/Value callInterval) x 3, rounded up. Outbound calls are made only when the result is greater than 1. If the value of callInterval is greater than 3, 3 is used for calculation. If the value of callInterval is less than 3, the actual value is used.

3

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

New

Added the interface for querying interface invocation records.

This interface is invoked to query third-party interface invocation details. It is used in scenarios where interface invocation records need to be queried.

4

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/failcategorystatistics?campaignId={campaignId}&startDate={startDate}&endDate={endDate}

New

Added the interface for collecting outbound call exception category statistics.

This interface is invoked to query outbound call exception data on the current day.

1

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callresultdetail/{callId}

New

Added the interface for querying details about a single outbound call result.

2

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blocklist/add

Modified

Added the following optional parameters to the request of the interface for adding outbound numbers to the blocklist:

restrictTimes (maximum number of calls)

restrictPeriod (restriction period)

3

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blocklist/query

New

Added the interface for querying blocklisted outbound numbers.

4

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blackfile/uploadFileBase

New

Added the interface for importing a local blocklist data file.

5

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blackfile/uploadFileServer

New

Added the interface for importing a blocklist data file from the server.

6

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blackfile/queryDataImportTask

New

Added the interface for querying blocklist data file import results.

7

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/calldatafile/uploadFileBase/{campaignId}

New

Added the interface for importing a local outbound call data file.

8

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/calldatafile/uploadFileServer/{campaignId}

New

Added the interface for importing an outbound call data file from the server.

9

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/calldatafile/queryDataImportTask/{campaignId}

New

Added the interface for querying outbound call data file import results.

10

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callresultdetail/{callId}

New

Added the interface for querying details about a single outbound call result.

11

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/file/addServer

New

Added the interface for adding a file server.

12

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/file/{serverId}/deleteServer

New

Added the interface for deleting a file server.

13

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/file/{serverId}/updateServer

New

Added the interface for modifying a file server.

14

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/file/queryServer

New

Added the interface for querying a file server.

15

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/queryOBSResultCode?pageSize={pageSize}&pageNum={pageNum}

New

Added the interface for querying OBS outbound call result codes.

16

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

New

Added the interface for creating an external result.

17

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

New

Added the interface for modifying an external result.

18

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/{defId}/deleteObsResult

New

Added the interface for deleting an external result.

19

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/queryOBSResults?pageSize={pageSize}&pageNum={pageNum}

New

Added the interface for querying the external result list.

20

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/{defId}/queryObsResultDetail

New

Added the interface for querying a single external result.

21

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

New

Added the interface for querying call records of automatic and intelligent outbound calls (V1.0.0).

22

https://ip:port/rest/isales/v2/openapi/campaigns/{vdnId}/callRecord

New

Added the interface for querying call records of automatic and intelligent outbound calls (V2.0.0).

1

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

Modified

Added the request parameter archiveHistory.

2

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/calldata/{campaignId}/delete

Modified

Added the request parameter archiveHistory.

3

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

Modified

Changed the value range of the request parameter pageSize from 1–100 to 1–50.

1

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

Modified

Added the previewed and preempted outbound calls.

Added values 5 and 6 for deviceType. When deviceType is set to 2, 5, or 6, skillParam is mandatory. Added values 5 and 6 for outBoundType in skillParam. Added the previewParam key for the skillParam object.

2

https://ip:port/rest/isales/v2/openapi/campaigns/{vdnId}

New

Added the interface for creating outbound campaigns, including multiple calling numbers, retry policies, business result policies, and call policies.

3

https://ip:port/rest/isales/v2/openapi/campaigns/{vdnId}/{campaignId}

New

Added the interface for modifying outbound campaigns, including the modification of multiple calling numbers, retry policies, business result policies, and call policies.

4

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

Modified

Added values 5 and 6 for deviceType. When deviceType is set to 2, 5, or 6, skillParam is mandatory. Added values 5 and 6 for outBoundType in skillParam. Added the previewParam key for the skillParam object.

5

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

Modified

Supported previewed and preempted outbound call query.

6

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}?name={name}&status={status}&deviceType={deviceType}&beginTime={beginTime}&endTime={endTime}&curPage={curPage}&rowsPerPage={rowsPerPage}

Modified

Supported previewed and preempted outbound call query.

7

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

New

Added the interface for defining outbound call business results.

8

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

New

Added the interface for querying the outbound call business result definition list.

9

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callresult/{campaignId}

Modified

Added the request parameter showDetail.

1

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callresult/{campaignId}

Modified

Added the resultCode response parameter,

which indicates the external result code.

1

https://ip:port/rest/isales/{version}/openapi/campaigns/{vdnId}/calldata/{campaignId}

Modified

Added outbound call numbers. Multiple numbers can be configured for a customer. (The original interface logic is supported. That is, a customer can map multiple outbound call numbers based on the original interface logic.)

2

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callresult/{campaignId}

New

Added the interface for querying outbound call results.

3

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/retryPolicy/{campaignId}

New

Added the interface for setting the retry policy of an outbound campaign.

4

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/retryPolicy/{campaignId}

New

Added the interface for querying the retry policy of an outbound campaign.

5

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/calldata/{campaignId}/delete

Modified

Added the input parameter recycleType.

6

Outbound Callback Interface

Modified

Added the output parameters callId and recordPath.

7

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callNoType/add

New

Added the interface for creating number types.

8

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callNoType/query

New

Added the interface for querying number types.

9

All

Modified

Standardized error codes.