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 Export Call

POST /callcentre/api/v3/exportBatchCall

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
1001	Batch import is in progress and import/export is not available

Request Body

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

Request Parameters

Name	Location	Type	Required	Chinese Name	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
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	Product ID	Fixed value: "callbot"
» userTaskID	body	string	Yes	Task ID	Task ID of the requester (generated and guaranteed to be unique by the caller), recommended to use UUID

Response Example

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 Result

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

Response Data Structure

Status Code 200

Name	Type	Required	Constraints	Chinese Name	Description
» retCode	integer	true	none	Response code	none
» retMsg	string	true	none	Response message	none
» responseID	string	true	none	Response ID	none
» totalCount	integer	true	none	Total calls	none
» batchID	string	true	none	Batch ID	none
» callList	[object]	true	none	Call List	none
»» orderID	string	false	none	Order id	none
»» userPhone	string	false	none	Phone number	none
»» other	string	false	none	Additional field	none
»» callID	string	false	none	Call ID	none
»» callStatus	integer	false	none	Call status	none
»» callStartTs	integer	false	none	Call start timestamp	none
»» intents	[object]	false	none	Intents	none
»»» intentID	string	false	none	Intent tag ID	none
»»» intentTag	string	false	none	Intent tag	none
»»» intentName	string	false	none	Intent tag name	none
»»» intentLevel	integer	true	none	Intent tag Level	none