Callbot API addBatchOrder

callbot-api

v1.0.0

Base URLs:

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

Aibot External Interface v3.0/Order Operation

Authentication Method

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

POST Add Call Order

POST /callcentre/api/v3/addBatchCall

Add an order to a specified task (task needs to be created in advance)

Body Request Parameters

{
  "productID": "callbot",
  "userTaskID": "string",
  "callInfoList": {
    "orderCallbackUrl": "string",
    "callCallbackUrl": "string",
    "callList": [
      {
        "orderID": "string",
        "userPhone": "string",
        "other": "string",
        "userName": "string",
        "customerName": "string",
        "params": [
          {
            "name": null,
            "value": null
          }
        ]
      }
    ]
  }
}

Request Parameters

Name	Location	Type	Required	Description
requestID	header	string	Yes	Unique request ID
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	Fixed value: "callbot"
» userTaskID	body	string	Yes	Task ID of the requester (generated and guaranteed to be unique by the caller), recommended to use UUID
» callInfoList	body	object	Yes
»» orderCallbackUrl	body	string	Yes	Callback URL after the call order is completed
»» callCallbackUrl	body	string	Yes	Callback URL after the call is completed
»» callList	body	[object]	Yes	Each number represents an order, and an order will go through one or more rounds of calls
»»» orderID	body	string	Yes	Generated by the caller, guaranteed to be globally unique, recommended to use UUID
»»» userPhone	body	string	Yes	User's phone number with country code, without symbols, e.g., 86156xxxxxxxx
»»» other	body	string	Yes	Transparent Field
»»» userName	body	string	Yes	User Name，Can be an empty string
»»» customerName	body	string	Yes	Customer Name，Can be an empty string
»»» params	body	[object]	Yes	If the script template contains variables, all variables need to be filled in. You can query the template name through Script Management -> Variable Settings and enter the corresponding string value according to the variable type
»»»» name	body	string	Yes	Variable Name
»»»» value	body	string	Yes	Variable Value

Response Example

200 Response

{
  "retCode": 0,
  "retMsg": "string",
  "responseID": "string",
  "totalCount": 0,
  "successCount": 0,
  "errList": [
    {
      "phone": "string",
      "errMsg": "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 and troubleshooting
» totalCount	integer	true	none	Total Count
» successCount	integer	true	none	Success Count
» errList	[object]	false	none	Error List
»» phone	string	true	none	Failed Phone
»» errMsg	string	true	none	Failure Reason