Help Center/ Cognitive Engagement Center/ API Reference/ Telemarketing Outbound Call Interface Reference/ Outbound Campaign Management Interfaces/ Setting the Retry Policy of an Outbound Campaign
Updated on 2023-09-27 GMT+08:00
View PDF

Setting the Retry Policy of an Outbound Campaign

Prerequisites

  • You have applied for a developer account.
  • For intelligent outbound calls, the customer needs to develop the IVR. For details, see Configuring Intelligent IVR.

Scenario

This interface is invoked to set the retry policy of a specified outbound campaign.

Method

This interface supports only the POST method.

URI

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

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

campaignId

Integer

Yes

ID of an outbound campaign.

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

Description

1

policyJson

String

JSON string of the policy.

For details about the parameters of this object, see Table 4.

2

policyType

Integer

Retry policy type.

  • 0: global policy
  • 1: number type matching policy
Table 4 Parameter description of policyJson

No.

Parameter

Type

Mandatory or Not

Description

1.1

dataType

String

-

Number type.

1.2

policy

String

-

JSON string of the policy that is matched based on the result.

For details about the parameters of this object, see Table 5.

1.3

retryDay

Integer

-

Number of call attempt days in a common policy.

1.4

retryTimes

Integer

-

Number of call attempts per day in a common policy.

1.5

type

Integer

-

Retry logic policy type.

  • 0: common policy
  • 1: result policy

1.6

noRetryPolicy

List <String>

No (This parameter cannot be set when policyType is set to 1.)

Result codes for which no retry policy is configured. The result codes come from the resultCode field in the data attribute of the interface for querying the definitions of outbound call results.
Table 5 Parameter description of policy

No.

Parameter

Type

Mandatory or Not

Description

1.2.1

callInterval

Integer

-

Delay time.

1.2.2

result

Integer

-

Result type.

1.2.3

retryNumber

Integer

-

Number of retry times.

Response Description

Table 6 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 7.

2

resultDesc

String

Description.

3

returnCode

String

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

For details, see Table 7.

4

returnDesc

String

Description.

Triggered Event

None

Error Codes

Table 7 Error code description

No.

Error Code

Description

1

0200001

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

2

0200-01

The outbound campaign does not exist.

3

02000001

Empty parameter.

4

02000002

The parameter contains invalid characters.

5

02000003

The parameter length cannot exceed the maximum length.

6

02000004

The parameter length cannot be less than the minimum length.

7

02000005

The parameter length must be within the specified range.

8

02000006

Incorrect parameter type.

9

02000007

Incorrect parameter value.

10

02000008

Parameter conversion error. Check the request parameters.

11

02000009

Incorrect parameter combination. Check the request parameters.

12

02000010

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

13

02000011

The number of parameters cannot exceed the specified number.

Example

  • The following provides examples of the request body of this interface:

    You can select different policy combinations based on business requirements.

    1. Global policy+normal policy (policyType=0; type=0)
      {
	"policyJson":"[{'type':0,'retryTimes':1,'retryDay':1}]",
	"policyType": 0
}
    2. Global policy+result policy (policyType=0; type=1)
      {
	"policyJson":"[{'type':1,'policy':[{'result':4,'retryNumber':3,'callInterval':60}]}]",
	"policyType": 0
}
    3. Number type matching policy+common policy (policyType=1; type=0)
      {
	"policyJson" : "[{'dataType':'ST','type':0,''policy':{'retryTimes':2,'retryDay':1}}]",
	"policyType": 1
}
    4. Number type matching policy+result policy (policyType=1; type=1)
      {
	"policyJson":"[{'dataType':'ST','type':1,'policy':[{'result':4,'retryNumber':3,'callInterval':60}]}]",
	"policyType": 1
}
  • The following provides an example of the response body of this interface:
    {
    "resultCode": "0200000",
    "resultDesc": "",
    "returnCode": "0200000",
    "returnDesc": ""
}