Updated on 2023-12-19 GMT+08:00

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

Table 1 Parameters in the request header

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.

Table 2 Parameters in the message body

Parameter

Type

Mandatory

Description

ccId

Integer

No

Call center ID. The value ranges from 1 to 65535.

  • In the integration environment, the default value is the value of Call Center ID on the Configuration Center > System Management > CMS System Configuration page after a system administrator signs in to the AICC. If this parameter is empty, the data whose sys_key is default_cc_id and sys_type is cms_system_config in the t_cms_sysparam database table is used.
  • In the independent deployment environment, the default value is the value of Default Call Center ID on the Configuration Center > System Management > Parameter Settings page after a system administrator signs in to the AICC.

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

Table 3 Parameters in the message body

Parameter

Type

Description

resultCode

string

Query result. The options are as follows:

  • 0100000: success
  • Other values: failure

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.

Table 4 Parameters in the response message body

Parameter

Type

Description

count

Integer

Total number of tasks.

tasks

JSONArray

Task list.

For details about the parameters of tasks, see Table 5.

Table 5 Parameters of tasks

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"
                }
    .......
            ]
        }
    }