Adding the Definition of an Outbound Call Business Result

Scenario

This interface is invoked to add the definition of an outbound call business result for a specified VDN ID.

Usage Description

Prerequisites
- You have applied for a developer account.
Restrictions
- After the addition, no modification interface is provided.

Method

This interface supports only the POST method.

URI

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

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.

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	name	String	Yes	Business result name. The value can contain a maximum of 50 characters, excluding special characters.
2	code	String	No	Business result code. The value can contain a maximum of 50 characters, including only digits, letters, and hyphens (-)
3	description	Sring	No	Business result description. The value can contain a maximum of 200 characters, excluding special characters.
4	children	List	No	Subbusiness result. For details about the parameters of this object, see Table 4.

**Table 4** Parameter description of children
No.	Parameter	Type	Mandatory or Not	Description
4.1	name	String	Yes	Subbusiness result name. The value can contain a maximum of 50 characters, excluding special characters.
4.2	code	String	No	Subbusiness result code. The value can contain a maximum of 50 characters, including only digits, letters, and hyphens (-)
4.3	description	String	No	Subbusiness result description. The value can contain a maximum of 200 characters, excluding special characters.

Response Description

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

Triggered Event

None

Error Codes

**Table 6** Error code description
No.	Error Code	Description
1	0200001	Parameter error. For details about the error, see resultDesc.
2	0200006	Database operation error.
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 an example of the request body of this interface:

{
	"name": "Call failure",
 "code": "123456",
	"description": "Call failure",
 "children": [
  {
			"name": "The customer directly hangs up.",
   "code": "100001",
			"description": "The customer directly hangs up."
  },
  {
			"name": "The customer turns off the phone."
   "code": "100002",
			"description": "The customer turns off the phone."
  }
 ]
}

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

{
    "resultCode": "0200000",
    "resultDesc": "addBusinessResult success",
    "returnCode": "0200000",
    "returnDesc": "addBusinessResult success"
}

Parent topic: Outbound Campaign Management Interfaces

Previous topic: Querying the Retry Policy of an Outbound Campaign

Next topic: Querying the Definitions of Outbound Call Business Results