Callbot API taskList

callbot-api

v1.0.0

Base URLs:

• Production Environment: https://nxbot.nxcloud.com

aibot External API v3.0/Task Operations

Authentication Method

For authentication, please refer to the document at https://github.com/nxtele/http-api-document/wiki/Callbot-API-authorization

POST List Task Information

POST /callcentre/api/v3/listTask

List task information and task statistics.

Request Body

{
  "productID": "callbot",
  "page": 1,
  "size": 100,
  "queryConditions": {
    "taskStatus": [
      1
    ],
    "taskName": [
      "string"
    ],
    "sceneID": "string",
    "userTaskID": [
      "string"
    ],
    "startTs": 0,
    "endTs": 0
  }
}

Request Parameters

Name	Location	Type	Required	Description
requestID	header	string	Yes	Unique ID for the request
uuid	header	string	Yes	UUID provided by the callee
createTs	header	string	Yes	Request timestamp (in seconds)
sign	header	string	Yes	Signature
algorithm	header	string	No	Signature algorithm: MD5 or SHA256, default to MD5 if left blank
body	body	object	No
» productID	body	string	Yes	Product ID, Fixed value: "callbot"
» page	body	integer	Yes	Page number
» size	body	integer	Yes	Page size
» queryConditions	body	object	Yes
»» taskStatus	body	[integer]	No	Task status
»» taskName	body	[string]	No	Task name
»» sceneID	body	string	No	Script template ID. Go to Backend -> Script Management -> Select the corresponding template name to view
»» userTaskID	body	[string]	No	Caller task ID
»» startTs	body	integer	No	Task creation start timestamp
»» endTs	body	integer	No	Task creation end timestamp

Enumerated Values

Property	Value	Description
taskStatus	1	Task pending
taskStatus	2	Task in progress
taskStatus	3	Task completed
taskStatus	4	Task completed (failed)
taskStatus	5	Task paused

Response Example

200 Response

{
  "retCode": 0,
  "retMsg": "string",
  "responseID": "string",
  "taskData": [
    {
      "userTaskID": "string",
      "taskID": "string",
      "sceneID": "string",
      "taskStatus": 1,
      "createTs": 0,
      "taskStat": {
        "answerOrderCount": 0,
        "finishOrderCount": 0,
        "totalOrderCount": 0,
        "finishRate": 0,
        "totalAnswerCall": 0,
        "totalCall": 0,
        "answerRate": 0
      },
      "taskSetting": {
        "taskCreateSetting": {
          "strategyName": "string",
          "startupType": "[",
          "startupAt": 0,
          "zoneSecond": 0,
          "dialAtWeekDay": "string",
          "dialAtUpHour": "string",
          "dialAtDownHour": "string",
          "maxCall": 0,
          "taskName": "string",
          "taskCallbackUrl": "string",
          "manualCallSetting": {}
        },
        "funcFlag": {
          "taskKeep": false,
          "roundRedial": false,
          "wholeTTS": false,
          "smsEnable": false,
          "smsFuncFlag": [
            null
          ],
          "phoneEncrypt": true
        }
      }
    }
  ],
  "totalCount": 0
}

Response Result

Status Code	Status Code Meaning	Explanation	Data Model
200	OK	Success	Inline

Response header

Name	Type	Required	Description
requestID	string	Yes	Consistent with the request header
uuid	string	Yes	Consistent with the request header
createTs	string	Yes	Second level timestamp at response time
sign	string	Yes	The generation method is the same as the sign generation algorithm in the request header
algorithm	string	No	Consistent with the request header, signature algorithm: MD5 or SHA256, default to MD5 if not filled in

Response Data Structure

Status Code 200

Name	Type	Required	Constraint	Description
» retCode	integer	true	none	Response code, 0 for success, others for failure
» retMsg	string	true	none	Response message
» responseID	string	true	none	Random unique ID used for request tracking, should be provided when troubleshooting the request
» taskData	[object]	true	none
»» userTaskID	string	true	none	Caller task ID
»» taskID	string	true	none	Called task ID
»» sceneID	string	true	none	Script template ID
»» taskStatus	integer	true	none	Task status
»» createTs	integer	true	none	Task creation timestamp
»» taskStat	object	true	none	Task statistical data
»»» answerOrderCount	integer	true	none	Answered order count
»»» finishOrderCount	integer	true	none	Completed order count
»»» totalOrderCount	integer	true	none	Total order count
»»» finishRate	number(float)	true	none	Rounded to two decimal places, calculated as finishOrderCount/totalOrderCount
»»» totalAnswerCall	integer	true	none	Total answered calls
»»» totalCall	integer	true	none	Total called times
»»» answerRate	number(float)	true	none	Call answer rate
»» taskSetting	object	true	none	Task setting parameters
»»» taskCreateSetting	object	true	none	Task parameter setting
»»»» strategyName	string	true	none	Strategy name; Please log in to the aibot platform->Script management->Script (find the corresponding script, click the script name or click Edit)->Click Dialing strategy (upper right corner) to view the strategy name; This field can be used by default (default strategy); If you need to set other dialing strategies, please set a new strategy name in the aibot platform
»»»» startupType	integer	true	none	Startup strategy
»»»» startupAt	integer	true	none	When startupType=2, the timestamp when the task starts
»»»» zoneSecond	integer	true	none	Task working time zone, an offset value in seconds relative to UTC, for example, 8 * 3600 = 28800 for UTC+8, -8 * 3600 = -28800 for UTC-8
»»»» dialAtWeekDay	string	true	none	For the task working time range, multiple values are separated by commas, range [1,7], 1: Monday,...6: Saturday, 7: Sunday
»»»» dialAtUpHour	string	true	none	Multiple values separated by commas, for the task working time range, range [0,23], 0: [00:00 ~ 00:30] can be dialed, 1: [01:00 ~ 01:30] can be dialed,...23: [23:00 ~ 23:30] can be dialed
»»»» dialAtDownHour	string	true	none	Multiple values separated by commas, for the task working time range, range [0,23], 0: [00:30 ~ 01:00] can be dialed, 1: [01:30 ~ 02:00] can be dialed,...23: [23:30 ~ 24:00] can be dialed
»»»» maxCall	integer	true	none	Maximum concurrent calls
»»»» taskName	string	true	none	Task name
»»»» taskCallbackUrl	string	true	none	Task status callback URL
»»»» manualCallSetting	object	false	none	Manual call settings, Only used for AICC templates
»»»»» agentGroup	string	true	none	Agent group ID
»»»»» dispatchType	integer	true	none	Outbound type, 0: none, 1: ratio-based outbound, 3: pre-test outbound 2.0
»»»»» ratioCallRate	number(float)	true	none	Agent call rate (used for ratio-based outbound)
»»»»» predictCallRate	number(float)	true	none	Pre-test call rate (used for pre-test outbound)
»»» funcFlag	object	true	none	Task function flags
»»»» taskKeep	boolean	true	none	When enabled, even if there are no call orders in the task, the task will not automatically end
»»»» roundRedial	boolean	true	none	When enabled, unanswered calls within a round will be automatically redialed once
»»»» wholeTTS	boolean	true	none	When enabled, sentences with variables will be treated as a whole for TTS synthesis; when there are variables, this must be enabled
»»»» smsEnable	boolean	true	none	true to enable; after the task call order ends, a message will be sent based on the set intention (SMS service needs to be activated in advance, and appKey needs to be set)
»»»» smsFuncFlag	[object]	true	none	Used when smsEnable is true; fill in the relevant fields as conditions for sending SMS, please do not repeat intentID, otherwise it will be overwritten in array order
»»»»» smsID	string	true	none	The SMS template to be sent can be found through the SMS template (please contact customer service for SMS copy testing and delivery rate testing before sending the SMS template)
»»»»» intentID	[string]	true	none	After the call order ends, an SMS will be sent based on the set intention ID
»»»»» intentName	[string]	true	none	After the call order ends, an SMS will be sent based on the set intention name (the effect is the same as setting intentID)
»»»» phoneEncrypt	boolean	true	none	When enabled, the displayed number in the background will be shown as an encrypted number
» totalCount	integer	true	none	Total number of tasks

Enumerated Values

Attribute	Value	Description
taskStatus	1	Task pending start
taskStatus	2	Task in progress
taskStatus	3	Task completed
taskStatus	4	Task finished (failure)
taskStatus	5	Task paused
startupType	1	Manual startup
startupType	2	Scheduled startup
startupType	3	Immediate startup