Callbot API ping

callbot-api

v1.0.0

Base URLs:

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

aibot External API v3.0/Ping

Authentication Method

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

POST Ping

POST /callcentre/api/v3/ping

Request Body Parameters

{
  "data": "string"
}

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	Yes	none
» data	body	string	Yes	Transparent fields

Response Example

200 Response

{
  "data": "string",
  "timestamp": 0,
  "code": 0,
  "msg": "string",
  "reqId": "string"
}

Response Result

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
» data	string	true	none	Transparent fields
» timestamp	integer	true	none	Current second level timestamp, indicating the time of inspection
» code	integer	true	none	Response code, 0 for success, others for failure
» msg	string	true	none	Response message
» reqId	string	true	none	Random unique ID used for request tracking, needed to locate the request when troubleshooting issues