Creating a Reserved Outbound Call Task

Prerequisites

You have applied for a developer account.

Scenario

This interface is invoked to create a reserved outbound call task.

Method

This interface supports only the POST method.

URL

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

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** Parameter in the URL
No.	Parameter	Value Type	Mandatory	Description
1	vdnId	Integer	Yes	VCC ID. The value is an integer ranging from 1 to 9999.

Request Description

**Table 2** Request header parameters
No.	Parameter	Value Type	Mandatory	Description
1	Content-Type	String	Yes	The value is fixed at 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	Value Type	Mandatory	Description
1	callType	Integer	Yes	Reservation for manual outbound calls Reservation for automatic outbound calls
2	calledNo	String	Yes	Number for which a call needs to be reserved.
3	userAccount	String	No	Business account of an agent. This parameter is mandatory in scenarios other than the OP independent deployment scenario.
4	workNo	String	No	Agent ID. This parameter is mandatory in the OP independent deployment scenario.
5	taskId	String	Yes	ID of an outbound call task.
6	appointTime	TimeStamp	Yes	Time when a reserved outbound call is made. An automatic outbound call is made 5 minutes in advance.
7	callData	String	No	Call-associated data. The value can contain a maximum number of 1024 characters and is in JSON format. This parameter is used only for reserved automatic outbound calls. CAUTION: If an automatic outbound call involves an intelligent IVR flow, the value of this parameter must be in JSON format. The intelligent IVR flow invokes the JSON Data Invoking diagram element to parse and assign values to the call-associated data in JSON format. For details about the implementation and usage of the diagram element, see JSON Data Invoking (Expired and Not Recommended). The following is a JSON format example. Customize the information in italics and retain other information. "callData":"{\\\"fullName\\\":\\\"Lin Zihang\\\",\\\"date\\\":\\\"March 31, 2022\\\",\\\"riskName\\\":\\\"Compulsory traffic insurance\\\"}"
8	remark	String	No	Remarks of a reservation task.

Response Description

**Table 4** Response body parameters
No.	Parameter	Value 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.
5	returnObject	Object	For details, see Table 5.

**Table 5** Parameter description of returnObject
No.	Parameter	Value Type	Description
1	appointId	String	ID of a reserved outbound call.

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	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	04000001	Incorrect time.
8	04000002	Incorrect call number. The value can contain a maximum of 24 characters, including only digits, asterisks (*), and number signs (#).
9	04000003	The reserved number is a blocklisted number.

Example

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

{
    "callType": "1",
    "calledNo": "66660001",
    "userAccount": "testName",
    "taskId": "1106025109",
    "appointTime": 1748858400000,
    "remark": "Remarks"
}

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

{
    "returnCode": "0200000",
    "returnObject": {
        "id": "174712034211433247704877116507"
    },
    "resultCode": "0200000",
    "resultDesc": "success",
    "returnDesc": "success"
}

Parent topic: Reserved Outbound Call Interfaces

Previous topic: Reserved Outbound Call Interfaces

Next topic: Modifying a Reserved Outbound Call Task