Callbot API batchExportCall

callbot-api

v1.0.0

Base URLs:

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

aibot External API v3.0/Order Operation

Authentication Method

Please refer to the documentation for authentication:https://github.com/nxtele/http-api-document/wiki/Callbot-API-authorization

POST Batch - List Call Orders

POST /callcentre/api/v3/exportBatchCall

Export the numbers from the previous batch.

Response Code Enumeration

Response Code	Error Reason
0	Success
1	General Error
2	Missing Parameters
3	Parameter Format Error
4	Invalid Parameter Value
4001	Parameter Content Capacity Error (Too many array elements)
5	Server Maintenance
5001	Internal Server Error
6	Incorrect Signature
6001	Missing Signature Error
6001	Missing Signature Error
6002	Account Does Not Exist
6003	User Does Not Have Permission
7	System Busy

Request Body

{
  "productID": "string",
  "userTaskID": "string"
}

Request Parameters

Name	Position	Type	Required	Description
requestID	header	string	Yes	Unique request ID
uuid	header	string	Yes	UUID, please log in to the platform, click on Developer Authorization
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
Accept-Encoding	header	string	No	If "gzip" is specified, the response body will be compressed and returned.
body	body	object	No	none
productID	body	string	Yes	Fixed value: "callbot"
» userTaskID	body	string	Yes	Task ID generated by the requester (ensure uniqueness, recommended to use UUID)

Example Response

200 Response

{
  "retCode": 0,
  "retMsg": "string",
  "responseID": "string",
  "totalCount": 0,
  "batchID": "string",
  "callList": [
    {
      "orderID": "string",
      "userPhone": "string",
      "other": "string",
      "callID": "string",
      "callStatus": 0,
      "callStartTs": 0,
      "intents": [
        {
          "intentID": "string",
          "intentTag": "string",
          "intentName": "string",
          "intentLevel": 0
        }
      ]
    }
  ]
}

Response

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. If the response body is compressed, it needs to be decompressed before verifying the signature.
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
» retMsg	string	true	none	Response message
» responseID	string	true	none	Response ID
» totalCount	integer	true	none	Total count
» batchID	string	true	none	Batch ID
» callList	[object]	true	none	Call List
»» orderID	string	false	none	Order ID
»» userPhone	string	false	none	Phone number
»» other	string	false	none	Additional field
»» callID	string	false	none	Call ID
»» callStatus	integer	false	none	Call status
»» callStartTs	integer	false	none	Call start timestamp
»» intents	[object]	false	none	Intents
»»» intentID	string	false	none	Intent tag ID
»»» intentTag	string	false	none	Intent tag
»»» intentName	string	false	none	Intent tag name
»»» intentLevel	integer	true	none	Intent tag level