Callbot API orderCallback

callbot-api

v1.0.0

Base URLs:

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

aibot External API v3.0/Callback

Authentication Method

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

POST Order Callback (aibot->customer)

POST /api/v3/orderCallback

Body Request Parameters

{
  "callbackType": "1",
  "orderID": "string",
  "userPhone": "string",
  "userName": "string",
  "sceneID": "string",
  "userTaskID": "string",
  "taskID": "string",
  "finish": true,
  "other": "string",
  "callInfoDetail": {
    "callID": "string",
    "callStatus": 1,
    "callStartTs": 0,
    "callAnswerTs": 0,
    "callEndTs": 0,
    "callDuration": 0,
    "callAudioUrl": "string",
    "hangupCause": "string",
    "termSipCode": "string",
    "intents": [
      {
        "intentID": "string",
        "intentTag": "string",
        "intentName": "string",
        "intentLevel": 0
      }
    ],
    "sms": [
      {
        "smsSendTs": 0,
        "sysMessageID": "string",
        "smsContent": "string"
      }
    ],
    "agent": {
      "agentName": "string",
      "agentGroup": "string",
      "agentCallStatus": 1,
      "agentCallElapsed": 0,
      "agentLabel": "string",
      "manualCallStart": 0,
      "manualCallAnswer": 0,
      "manualCallEnd": 0,
      "manualHangupBy": 0
    },
    "params": [
      {
        "name": "string",
        "value": "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(Signature algorithm can be found in the backend -> Developer section)
body	body	object	No
» callbackType	body	string	Yes
» orderID	body	string	Yes	Order ID
» userPhone	body	string	Yes	Phone number
» userName	body	string	Yes	User name
» sceneID	body	string	Yes	Script template ID
» userTaskID	body	string	Yes	User task ID
» taskID	body	string	Yes	Task ID
» finish	body	boolean	Yes	Order completion
» other	body	string	Yes	Transmitted field
» callInfoDetail	body	object	Yes	Call details
»» callID	body	string	Yes	Call ID
»» callingNumber	body	string	Yes	Calling number
»» lineAddress	body	string	Yes	Line IP
»» callStatus	body	integer	Yes	Call status
»» callStartTs	body	integer	Yes	Call start timestamp
»» callAnswerTs	body	integer	Yes	The presence of an answer timestamp does not necessarily mean the call was answered. Please refer to callStatus to determine the call status.
»» callEndTs	body	integer	Yes	Call end timestamp
»» callDuration	body	integer	Yes	Call duration (in seconds)
»» callAudioUrl	body	string	Yes	Call recording URL (valid for 3 months), in WAV format, e.g., https://xxxx.wav
»» hangupCause	body	string	Yes	hangup cause
»» termSipCode	body	string	Yes	sip code
»» intents	body	[object]	Yes	Intents can be obtained by querying the intent labels set in the script template to which the task belongs
»»» intentID	body	string	Yes	Intent label ID
»»» intentTag	body	string	Yes	Intents can be obtained by querying the intent labels set in the script template to which the task belongs
»»» intentName	body	string	Yes	Intent label name
»» sms	body	[object]	No	SMS
»»» smsSendTs	body	integer	Yes	SMS send timestamp
»»» sysMessageID	body	string	Yes	SMS send ID
»»» smsContent	body	string	Yes	SMS content
»» agent	body	object	No	Agent-related information
»»» agentName	body	string	Yes	Agent name
»»» agentGroup	body	string	Yes	Agent group
»»» agentCallStatus	body	integer	Yes	Agent call status
»»» agentCallElapsed	body	integer	Yes	Agent call duration
»»» agentLabel	body	string	Yes	Agent label
»»» manualCallStart	body	integer	Yes	Manual call start timestamp
»»» manualCallAnswer	body	integer	Yes	Manual call answer timestamp
»»» manualHangupBy	body	integer	Yes	Abandoning who hung up 0: none, 1: Agent hung up, 2: User hung up
»»» manualCallEnd	body	integer	Yes	Manual call end timestamp
»» params	body	[object]	No	Variables
»»» name	body	string	Yes	Variable name
»»» value	body	string	Yes	Variable value

Enumerated Values

Attribute	Value	Description
» callbackType	1	Task callback
» callbackType	2	Order callback
» callbackType	3	Call callback
»» callStatus	1	Call preparation
»» callStatus	2	Call scheduling
»» callStatus	3	Call dialing
»» callStatus	4	Ringing
»» callStatus	5	In call
»» callStatus	6	Call ended - Completed call
»» callStatus	8	Call ended - Invalid number
»» callStatus	9	Call ended - Temporarily unavailable
»» callStatus	10	Call ended - User busy
»» callStatus	11	Call ended - User busy and rejected
»» callStatus	12	Call ended - User rejected
»» callStatus	13	Call ended - User rejected
»» callStatus	15	Call ended - TTS synthesis failed
»» callStatus	16	Call ended - Unknown reason
»» callStatus	17	Call ended - Blacklisted number
»» callStatus	18	Call ended - User interrupted
»» callStatus	21	Call ended - Invalid number (number illegal, does not meet local segment)
»» callStatus	22	Call ended - Ring missed
»» callStatus	23	Call ended - No response to call
»» callStatus	24	Call ended - Morning Media - Voice Mail
»» callStatus	25	Call ended - Ring too long
»»» smsSendTs	0	Not sent
»»» smsSendTs	1	Sent
»»» smsSendTs	2	Send successful
»»» smsSendTs	3	Send failed
»»» smsSendTs	4	Click successful
»»» agentCallStatus	1	Call dialing
»»» agentCallStatus	2	Ringing
»»» agentCallStatus	3	Connected
»»» agentCallStatus	4	Call completed
»»» agentCallStatus	10	Call completed - Agent busy
»»» agentCallStatus	12	Call completed - User rejected

Response Example

200 Response

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

Response Result

Status Code	Meaning	Description	Data Model
200	OK	Success	Inline

Response Data Structure

Status Code 200

Name	Type	Required	Constraints	Description
» retCode	integer	true	none	0 for success, others for failure
» retMsg	string	true	none	Response message
» responseID	string	true	none	Random unique ID used for request tracking. Provide the response ID for troubleshooting.