Callbot API updateTask

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 documentation at https://github.com/nxtele/http-api-document/wiki/Callbot-API-authorization

POST Modify Task Function

POST /callcentre/api/v3/updateTask

This interface only supports modifying tasks that are paused or not yet started.

1. The modification parameters only support taskCreateSetting and funcFlag.
2. Modifying the number encryption and SMS function parameters will not be effective for completed or imported numbers. The changes will take effect after 5 minutes.

Body Request Parameters

{
  "productID": "callbot",
  "userTaskID": "string",
  "sceneID": "string",
  "taskCreateSetting": {
    "strategyName": "",
    "startupType": 1,
    "startupAt": 0,
    "zoneSecond": 0,
    "dialAtWeekDay": "string",
    "dialAtUpHour": "string",
    "dialAtDownHour": "string",
    "maxCall": 0,
    "taskName": "string",
    "taskCallbackUrl": "string",
    "maxRingTime": 0,
    "routeID": "",
    "manualCallSetting": {
      "agentGroup": "string",
      "dispatchType": 0,
      "ratioCallRate": 0,
      "predictCallRate": 0
    }
  },
  "funcFlag": {
    "taskKeep": false,
    "roundRedial": false,
    "wholeTTS": false,
    "smsEnable": false,
    "smsFuncFlag": [
      {
        "smsID": "string",
        "intentID": [
          "string"
        ],
        "intentName": [
          "string"
        ]
      }
    ],
    "phoneEncrypt": true
  }
}

Request Parameters

Name	Position	Type	Description
requestID	header	string	Unique request ID
uuid	header	string	UUID provided by the callee
createTs	header	string	Request timestamp (in seconds)
sign	header	string	Signature
algorithm	header	string	Signature algorithm: MD5 or SHA256, default to MD5 if left blank
body	body	object	None
» productID	body	string	Fixed value "callbot"
» userTaskID	body	string	Task ID generated and guaranteed to be unique by the requester (recommended to use UUID)
» sceneID	body	string	Dialogue template ID, go to the background "Dialogue Management" -> Select the corresponding template name to view
» taskCreateSetting	body	object	Task parameter settings
»» strategyName	body	string	Strategy name; log in to the aibot platform -> "Dialogue Management" -> "Dialogue" (find the corresponding dialogue, click the dialogue name or click Edit) -> Click "Dialing Strategy" (top 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 on the aibot platform
»» startupType	body	integer	Startup Strategy
»» startupAt	body	integer	The timestamp of task startup when startupType=2
»» zoneSecond	body	integer	Task working time zone, an offset value in seconds relative to the zero time, for example, the value for GMT+8 is 8 * 3600=28800, and for GMT-8 it is -8 * 3600=-28800
»» dialAtWeekDay	body	string	For the task working time range, multiple values separated by commas, range is [1, 7], 1: Monday, ... 6: Saturday, 7: Sunday
»» dialAtUpHour	body	string	Multiple values separated by commas, for the task working time range, range is [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	body	string	Multiple values separated by commas, for the task working time range, range is [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	body	integer	Robot Quantity, Maximum number of concurrent robot calls
»» taskName	body	string	Task Name
»» taskCallbackUrl	body	string	URL type, callback when the task status changes
»» maxRingTime	body	integer	Maximum ringing duration
»» routeID	body	string	route ID
»» manualCallSetting	body	object	Settings for Transfer to Human Agent, Only used for AICC templates
»»» agentGroup	body	string	Agent Group ID
»»» dispatchType	body	integer	Dialing type, 0: none, 1: ratio-based dialing, 3: pre-test dialing 2.0
»»» ratioCallRate	body	number	Agent call rate (fill in this value for ratio-based dialing)
»»» predictCallRate	body	number	Pre-test call rate (used for pre-test outbound)
» funcFlag	body	object	Task function flags
»» taskKeep	body	boolean	When enabled, even if there are no call orders in the task, the task will not automatically end
»» roundRedial	body	boolean	When enabled, unanswered calls within a round will be automatically redialed once
»» wholeTTS	body	boolean	When enabled, sentences with variables will be treated as a whole for TTS synthesis; when there are variables, this must be enabled
»» smsEnable	body	boolean	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	body	[object]	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	body	string	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	body	[string]	After the call order ends, an SMS will be sent based on the set intention ID
»»» intentName	body	[string]	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	body	boolean	When enabled, the displayed number in the background will be shown as an encrypted number

Enumerated Values

Attribute	Value
»» startupType	1	Manual Start
»» startupType	2	Scheduled Start
»» startupType	3	Immediate Start

Example Response

200 Response

{
  "retCode": 0,
  "retMsg": "string",
  "responseID": "string",
  "taskID": "string"
}

Response Result

Status Code	Status Code Meaning	Description	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	Constraints	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, required for troubleshooting
» taskID	string	true	none	Actual task ID returned by the callee