Querying Details About an Outbound Campaign

Prerequisites

You have applied for a developer account.
An outbound campaign has been created.

Scenario

This interface is invoked to query the configuration details about a specified outbound campaign.

Method

This interface supports only the GET method.

URI

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/{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.

No request body exists.

Response Description

**Table 3** 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 21.
2	resultDesc	String	Description.
3	returnCode	String	Error code. The value 0200000 indicates success, and other values indicate failure. For details, see Table 21.
4	returnDesc	String	Description.
5	returnObject	Object	For details, see Table 4.

**Table 4** Parameter description of returnObject
No.	Parameter	Type	Description
5.1	name	String	Name of an outbound campaign.
5.2	description	String	Description of an outbound campaign.
5.3	status	Integer	Status of an outbound campaign. The options are as follows: 2: started 3: suspended 4: completed
5.4	strBeginTime	String	Time when an outbound campaign starts.
5.5	strEndTime	String	Time when an outbound campaign ends.
5.6	deviceType	Integer	Type of an outbound device. The options are as follows: 1: IVR in intelligent outbound calls (available in the SaaS environment when the intelligent feature is enabled) 2: skill queue in predicted outbound calls 3: IVR in automatic outbound calls 5: skill queue in previewed outbound calls 6: skill queue in preempted outbound calls
5.7	callerNo	String	Calling number. Number displayed on the phone of a customer after a call is connected.
5.8	maxAlertingTime	Integer	Maximum ringing duration for no answer. If the ringing duration exceeds the value of this parameter, the call is released.
5.9	scheduleParam	Object	Outbound call time segment. For details about the parameters of this object, see Table 5.
5.10	ivrParam	Object	This parameter is mandatory when deviceType is set to 1 or 3 (IVR). For details about the parameters of this object, see Table 6.
5.11	skillParam	Object	This parameter is mandatory when deviceType is set to 2, 5, or 6 (skill queue). For details about the parameters of this object, see Table 7.
5.12	callBackUrl	String	Callback notification address of the outbound call result.
5.13	retryPolicy	Object	Outbound call result policy. For details about the parameters of this object, see Table 14.
5.14	callPolicy	Object	Call policy. For details about the parameters of this object, see Table 16.

**Table 5** Parameter description of scheduleParam
No.	Parameter	Type	Description
5.9.1	workdayBeginTime1	String	Start time of outbound call time segment 1 on workdays, in HH:mm format.
5.9.2	workdayEndTime1	String	End time of outbound call time segment 1 on workdays, in HH:mm format.
5.9.3	workdayBeginTime2	String	Start time of outbound call time segment 2 on workdays, in HH:mm format.
5.9.4	workdayEndTime2	String	End time of outbound call time segment 2 on workdays, in HH:mm format.
5.9.5	workdayBeginTime3	String	Start time of outbound call time segment 3 on workdays, in HH:mm format.
5.9.6	workdayEndTime3	String	End time of outbound call time segment 3 on workdays, in HH:mm format.
5.9.7	holidayBeginTime1	String	Start time of outbound call time segment 1 on holidays, in HH:mm format.
5.9.8	holidayEndTime1	String	End time of outbound call time segment 1 on holidays, in HH:mm format.
5.9.9	holidayBeginTime2	String	Start time of outbound call time segment 2 on holidays, in HH:mm format.
5.9.10	holidayEndTime2	String	End time of outbound call time segment 2 on holidays, in HH:mm format.
5.9.11	holidayBeginTime3	String	Start time of outbound call time segment 3 on holidays, in HH:mm format.
5.9.12	holidayEndTime3	String	End time of outbound call time segment 3 on holidays, in HH:mm format.

**Table 6** Parameter description of ivrParam
No.	Parameter	Type	Description
5.10.1	deviceSign	String	Access code of an IVR flow.
5.10.2	callCount	Integer	Number of outbound calls that are made in an outbound task each time.
5.10.3	callInterval	Integer	Interval for executing an outbound campaign task, in seconds.

**Table 7** Parameter description of skillParam
No.	Parameter	Type	Description
5.11.1	skillId	Integer	ID of a skill queue.
5.11.2	skillName	String	Skill queue name.
5.11.3	outBoundType	Integer	Outbound call mode. The options are as follows: 2: predicted outbound call 5: previewed outbound call 6: preempted outbound call
5.11.4	predictParam	Object	Parameter settings for predicted outbound calls. This parameter is mandatory when outBoundType is set to 2. For details about the parameters of this object, see Table 9.
5.11.5	previewParam	Object	Parameter settings for previewed outbound calls. This parameter is mandatory when outBoundType is set to 5. For details about the parameters of this object, see Table 8.

**Table 8** Parameter description of previewParam
No.	Parameter	Type	Mandatory or Not	Description
5.11.5.1	failInterval	Integer	Yes	Outbound call interval, in seconds. The value is a positive integer.
5.11.5.2	obCallCount	Integer	Yes	Number of outbound calls each time. The value is a positive integer.
5.11.5.3	autoCallTime	Integer	Yes	Previewed automatic call duration, in seconds. The value is a positive integer.

**Table 9** Parameter description of predictParam
No.	Parameter	Type	Description
5.11.4.1	predictMethod	Integer	Algorithm for predicted outbound calls. The options are as follows: 1: Algorithm for empirical prediction 2: Algorithm for agent usage prediction 3: Algorithm for predicting the outbound call completion rate 5: Algorithm for off-hook rate prediction
5.11.4.2	expPredictParam	Object	Parameter settings of the algorithm for empirical prediction. This parameter is mandatory when predictMethod is set to 1. For details about the parameters of this object, see Table 10.
5.11.4.3	agentPredictParam	Object	Parameter settings of the algorithm for agent usage prediction. This parameter is mandatory when predictMethod is set to 2. For details about the parameters of this object, see Table 11.
5.11.4.4	connectPredictParam	Object	Parameter settings of the algorithm for predicting the outbound call completion rate. This parameter is mandatory when predictMethod is set to 3. For details about the parameters of this object, see Table 12.
5.11.4.5	offhookPredictParam	Object	Parameter settings of the algorithm for off-hook rate prediction. This parameter is mandatory when predictMethod is set to 5. For details about the parameters of this object, see Table 13.

**Table 10** Parameter description of expPredictParam
No.	Parameter	Type	Description
5.11.4.2.1	maxAvgCallTime	Integer	Maximum average call duration, in seconds.
5.11.4.2.2	mimAvgCallTime	Integer	Minimum average call duration, in seconds.
5.11.4.2.3	outBoundRate	Integer	Outbound call rate.

**Table 11** Parameter description of agentPredictParam
No.	Parameter	Type	Description
5.11.4.3.1	maxAvgCallTime	Integer	Maximum average call duration, in seconds.
5.11.4.3.2	mimAvgCallTime	Integer	Minimum average call duration, in seconds.
5.11.4.3.3	lossRate	Integer	Minimum call loss rate.
5.11.4.3.4	utilRate	Integer	Agent usage.
5.11.4.3.5	utilRateMethod	Integer	Algorithm for agent usage. The options are as follows: 1: Agent usage = Total call duration/Total login duration 2: Agent usage = (Total call duration + Work state duration)/Total login duration

**Table 12** Parameter description of connectPredictParam
No.	Parameter	Type	Description
5.11.4.4.1	maxAvgCallTime	Integer	Maximum average call duration, in seconds.
5.11.4.4.2	mimAvgCallTime	Integer	Minimum average call duration, in seconds.
5.11.4.4.3	lossRate	Integer	Minimum call loss rate.
5.11.4.4.4	waitTime	Integer	Called party's waiting time, in seconds.
5.11.4.4.5	connRate	Integer	Outbound call connection rate.

**Table 13** Parameter description of offhookPredictParam
No.	Parameter	Type	Description
5.11.4.5.1	offHookRate	Integer	Off-hook rate.

**Table 14** Parameter description of retryPolicy
No.	Parameter	Type	Description
5.13.1	retryPolicyId	String	Retry policy ID.
5.13.2	policyType	Integer	Retry policy type. 0: global policy; 1: number type matching policy.
5.13.3	retryDay	Integer	Maximum number of days for call attempts. This parameter is mandatory for common policies under the global policy.
5.13.4	retryTimes	Integer	Maximum number of call attempts per day. This parameter is mandatory for common policies under the global policy.
5.13.5	callInterval	Integer	Outbound call interval, in seconds. This parameter is mandatory for common policies under the global policy.
5.13.6	resultRetry	String	JSON string of the result policy. This parameter is mandatory for result policies under the global policy. For details about the parameters of this object, see Table 15.
5.13.7	policyJson	String	JSON string of the number type matching policy. This parameter is mandatory for number type matching policies. For details about the parameters of this object, see Table 19.
5.13.8	busiPolicy	String	JSON string of the business result policy. For details about the parameters of this object, see Table 18.
5.13.9	noRetryPolicy	String	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 15** Parameter description of resultRetry
No.	Parameter	Type	Description
5.13.6.1	result	Integer	Result type. This parameter is mandatory for result policies under the global policy.
5.13.6.2	callInterval	Integer	Outbound call interval, in seconds. This parameter is mandatory for result policies under the global policy.
5.13.6.3	retryNumber	Integer	Number of retry times. This parameter is mandatory for result policies under the global policy.

**Table 16** Parameter description of callPolicy
No.	Parameter	Type	Description
5.14.1	callPolicyId	String	ID of a call policy.
5.14.2	callType	Integer	Call mode. 0: by sequence; 1: by round. The default value is 0.
5.14.3	chooseType	Integer	Round mode. 0: by number category; 1: by number sequence. This parameter is mandatory when the call mode is by round.
5.14.4	turns	String	Round information in JSON format. This parameter is mandatory when the call mode is by round. For details about the parameters of this object, see Table 17.

**Table 17** Parameter description of turns
No.	Parameter	Type	Description
5.14.4.1	turnType	String	Number type. This parameter is mandatory when the round mode is by number category.
5.14.4.2	turnOrder	Integer	Number sequence. This parameter is mandatory when the round mode is by number sequence.
5.14.4.3	orderNo	Integer	Round number.

**Table 18** Parameter description of busiPolicy
No.	Parameter	Type	Description
5.13.8.1	busiResultCode	String	Business result code.
5.13.8.2	busiResultSubCode	String	Business result subcode. (This parameter is associated with the business result code.)
5.13.8.3	busiResultPolicy	Integer	Call policy for a business result. 0: Stop calling. 1: Call the next number. 2: Call the current number.
5.13.8.4	callInterval	Integer	Outbound call interval, in seconds. For call policies, set this parameter to 0 or leave it empty. For others, set this parameter to another value.

**Table 19** Parameter description of policyJson
No.	Parameter	Type	Description
5.13.7.1	dataType	String	Number type.
5.13.7.2	type	Integer	Retry logic policy type. 0: common policy 1: result policy
5.13.7.3	policy	String	Policy configuration information. For details about the parameters of this object, see Table 20.

**Table 20** Parameter description of policy
No.	Parameter	Type	Description
5.13.7.3.1	retryDay	Integer	Maximum number of days for call attempts. This parameter is mandatory for common policies that are matched based on the number type.
5.13.7.3.2	retryTimes	Integer	Maximum number of call attempts per day. This parameter is mandatory for common policies that are matched based on the number type.
5.13.7.3.3	result	Integer	Result type. This parameter is mandatory for result policies that are matched based on the number type.
5.13.7.3.4	callInterval	Integer	Outbound call interval, in seconds. This parameter is mandatory for result policies that are matched based on the number type.
5.13.7.3.5	retryNumber	Integer	Number of retry times. This parameter is mandatory for result policies that are matched based on the number type.

Triggered Event

None

Error Codes

**Table 21** Error code description
No.	Error Code	Description
1	0200001	Parameter error. For details about the error, see resultDesc.
2	0200006	Database operation error.
3	0200007	The outbound campaign does not exist.
4	02000001	Empty parameter.
5	02000002	The parameter contains invalid characters.
6	02000003	The parameter length cannot exceed the maximum length.
7	02000004	The parameter length cannot be less than the minimum length.
8	02000005	The parameter length must be within the specified range.
9	02000006	Incorrect parameter type.
10	02000007	Incorrect parameter value.
11	02000008	Parameter conversion error. Check the request parameters.
12	02000009	Incorrect parameter combination. Check the request parameters.
13	02000010	The hour and minute parameters must be set at the same time.
14	02000011	The number of parameters cannot exceed the specified number.

Example

The following provides an example of the request body of this interface:
None

The following provides an example of the response body of this interface:

{
    "resultCode": "0200000",
    "resultDesc": "",
    "returnCode": "0200000",
    "returnDesc": "",
    "returnObject": {
        "id": 146,
        "name": "lizhan_test",
        "description": null,
        "status": 2,
        "strBeginTime": "2018-12-01",
        "strEndTime": "2018-12-02",
        "deviceType": 2,
        "callerNo": "10086",
        "maxAlertingTime": 20,
        "scheduleParam": {
            "workdayBeginTime1": "08:00",
            "workdayEndTime1": "12:00",
            "workdayBeginTime2": "13:30",
            "workdayEndTime2": "17:30",
            "workdayBeginTime3": null,
            "workdayEndTime3": null,
            "holidayBeginTime1": "09:00",
            "holidayEndTime1": "12:00",
            "holidayBeginTime2": "14:00",
            "holidayEndTime2": "17:00",
            "holidayBeginTime3": null,
            "holidayEndTime3": null
        },
        "ivrParam": null,
        "skillParam": {
            "skillId": 1,
            "skillName": "Voice Skill Queue",
            "outBoundType": 2,
            "predictParam": {
                "predictMethod": 5,
                "expPredictParam": null,
                "agentPredictParam": null,
                "connectPredictParam": null,
                "offhookPredictParam": {
                    "offHookRate": 100
                }
            },
            "previewParam": null
        },
        "callBackUrl": "http://www.baidu.com"
    }
}

Parent topic: Outbound Campaign Management Interfaces

Previous topic: Deleting an Outbound Campaign

Next topic: Querying All Outbound Campaigns