Querying the Outbound Call Task List of a Tenant
Description
This interface is invoked to query the outbound call task list of a tenant and return task information.
Note: The iSales service module must be deployed for this interface.
Interface Method
The request method must be set to POST. This interface supports only the POST method.
Request URL
https://ip:port/rest/cmsapp/v1/openapi/fromisales/querytasks
In a public cloud environment, ip indicates the IP address of the CC-CMS server, and port indicates the HTTPS port number of the CC-CMS server. Contact the administrator to obtain the values.In a non–public cloud environment where the NSLB service is configured, ip indicates the IP address of the NSLB server, and port indicates the HTTPS port number of the CC-CMS service mapped on the NSLB server.
Request Description
No. |
Parameter |
Type |
Mandatory |
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. |
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|
ccId |
Integer |
No |
Call center ID. The value ranges from 1 to 65535.
|
vdn |
Integer |
Yes |
ID of a VDN. The value ranges from 1 to 5000. |
limit |
Integer |
No |
Page size. The default value is 10. A maximum of 100 records can be queried. |
offset |
Integer |
No |
Pagination start position. If this parameter is not set, the default value 0 is used. |
Response Message
Parameter |
Type |
Description |
---|---|---|
resultCode |
string |
Query result. The options are as follows:
For details about the failure causes, see Error Code Reference. |
resultDesc |
Array |
Object array in the returned result after a successful query. For details about the parameters of the response message body, see Table 4. |
Parameter |
Type |
Description |
---|---|---|
count |
Integer |
Total number of tasks. |
tasks |
JSONArray |
Task list. |
For details about the parameters of tasks, see Table 5.
Parameter |
Type |
Description |
---|---|---|
taskId |
String |
Task ID. |
taskName |
String |
Task name. |
taskType |
String |
Task type. 1: Intelligent outbound call 2: Predicted outbound calls 3: Automatic outbound call 4: Agent outbound call 5: Previewed outbound call |
beginDate |
String |
Start time, which is written by the CC-iSales frontend user. |
endDate |
String |
End time, which is written by the CC-iSales frontend user. |
status |
String |
Task status. 2: Being executed 3: Suspended 4: Completed |
Message Example
- Request header
Content-Type: application/json;charset=UTF-8 Authorization: ******************
- Request parameters
{ "ccId": "89", "vdn":92, "limit":10, "offset":0 }
- Response parameters
{ "resultCode": "0100000", "resultDesc": { "count": 14, "tasks": [ { "beginDate": "2021-02-03", "taskType": "4", "endDate": "2021-02-04", "taskName": "1", "taskId": "1088825198", "status": "1" }, { "beginDate": "2021-02-04", "taskType": "4", "endDate": "2021-02-28", "taskName": "2", "taskId": "1312452402", "status": "1" } ....... ] } }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot