Creating an External Result

Scenario

This interface is invoked to create an external result. It is provided for the retry policy interface to create non-retry policies.

Usage Description

Prerequisites
- The corresponding AK/SK authentication permission is available.
- You have applied for a developer account.

Method

This interface supports only the POST method.

URI

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

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	resultCode	String	No	Result definition code. The value can contain fewer than eight characters.
2	displayResult	String	Yes	External result code.
3	obsCodes	List <String>	Yes	Result code definition list. The list can be obtained using the interface for querying OBS outbound call result codes.

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.
3	defId	String	ID of the created external result.
4	returnCode	String	Error code. The value 0200000 indicates success, and other values indicate failure. For details, see Table 5.
5	returnDesc	String	Description.

Error Codes

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

Example

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

{"resultCode":"007", "displayResult":"7: The call is not answered.", "obsCodes":["00602","00606"]}

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

{
  "defId": "1645244637",
  "returnCode": "0200000",
  "resultCode": "0200000",
  "resultDesc": "createObResult Success!",
  "returnDesc": "createObResult Success!"
}

Parent topic: Outbound Call External Result Definition Interfaces

Previous topic: Querying OBS Outbound Call Result Codes

Next topic: Modifying an External Result