AI Agent Task ‐ Query Call Records

Query Call Records

Query detailed call records generated by AI Agent outbound tasks.

---

API Information

• URL: https://api-hk.nxlink.ai/openapi/aiagent/call/list
• Method: POST
• Content-Type: application/json
• Authentication Required: Yes

---

🌐 Service Endpoints

NXLink is deployed across multiple global regions. Please choose the appropriate service endpoint based on your business location. Website domains and API gateways vary by region.

Code	Region	NXLink Website	API Gateway
APAC	Hong Kong	https://app.nxlink.ai	https://api-hk.nxlink.ai
AMER	Americas	https://chl-nxlink.nxcloud.com	https://chl-api.nxlink.ai
APAC (IDN)	Indonesia	https://idn.nxlink.ai	https://api-idn.nxlink.ai

---

Request Parameters

Header Parameters

Parameter	Type	Required	Example Value	Description
accessKey	String	Yes	AK-6230339248928541113-2133	User access key
ts	String	Yes	1655710885431	Request timestamp in milliseconds. Maximum allowed time drift is 60 seconds
bizType	String	Yes	100	Business type, fixed value: 100
action	String	Yes	nxai	Business action, fixed value: nxai
sign	String	Yes	6e9506557d1f289501d333ee2c365826	API request signature (see common authentication rules) , Signature Algorithm

---

Body Parameters

Parameter	Type	Required	Example	Description
taskId	String	Yes	"52145b00-abc9-4a87-94c2-ed1e1e42ec1c"	Task ID (returned by AI Agent outbound task APIs)
startTs	Integer	No	1736215928	Start timestamp (seconds)
endTs	Integer	No	1746583929	End timestamp (seconds)
callId	String	No	"call_2023112501234"	Call ID
phone	String	No	"1380xxxxx"	Phone number
callResult	Integer	No	1	Call result code
userIntent	String	No	"Interested"	Conversation tag (available when callResult is 1, 3, 17, or 21)
pageNumber	Integer	Yes	1	Page number
pageSize	Integer	Yes	10	Page size
minElapsed	Long	No	60	Minimum call duration (seconds)
maxElapsed	Long	No	300	Maximum call duration (seconds)

---

Request Example

{
  "taskId": "8bdf2a84-fc89-483e-ba1e-35a54285c7d0",
  "startTs": 1736238951,
  "endTs": 1746606952,
  "callId": "",
  "phone": "",
  "callResult": "",
  "userIntent": "",
  "pageNumber": 1,
  "pageSize": 10,
  "minElapsed": 0,
  "maxElapsed": 3000
}

Response Parameters

Field	Type	Description
code	Integer	Result code
message	String	Result message
traceId	String	Trace ID for request tracking
data	Object	Response payload

---

data Object

Field	Type	Description
total	Integer	Total number of records
pageNumber	Integer	Current page number
pageSize	Integer	Page size
list	Array	Call record list

---

list Element (Call Record)

Field	Type	Description
id	Long	Record ID
taskId	String	Task ID
contactId	String	Contact list ID
autoFlowId	Long	AI agent / bot ID
orderHead	Integer	First-call flag: 0 = no, 1 = yes
orderTail	Integer	Last-call flag: 0 = no, 1 = yes
callerPhone	String	Caller number
calleePhone	String	Callee number
realPhone	String	Real phone number
callId	String	Call ID
callStatus	Integer	Call status (see Call Status (callStatus) Reference)
callResult	Integer	Call result (see Call Result (callResult) Reference)
createTs	Long	Created timestamp (seconds)
opTs	Integer	Operation timestamp (seconds)
callStart	Long	Call start timestamp (seconds)
callAnswer	Long	Call answered timestamp (seconds)
callEnd	Long	Call end timestamp (seconds)
callRingTime	Long	Ring time duration
callElapsed	Long	Call duration (seconds)
lineId	String	Line ID selected for the call
routeId	String	Route ID selected for the call
callAudioUrl	String	Call recording URL
userIntent	String	User intent / tag
callSummary	String	Call summary
turnTime	Integer	Dialogue turn count
manualCallStart	Integer	Manual call start timestamp (seconds)
manualCallAnswer	Integer	Manual call answered timestamp (seconds)
manualCallEnd	Integer	Manual call end timestamp (seconds)
manualCallStatus	Integer	Manual call status
manualElapsed	Integer	Manual call duration (seconds)
agentName	String	Agent account name
agentId	String	Agent account ID
agentGroupName	String	Agent group name
agentGroupId	String	Agent group ID
callCallbackUrl	String	Callback URL after call ends
orderCallbackUrl	String	Callback URL after order ends
sipAddr	String	SIP address
sipCode	String	SIP code
hangupReason	String	Hang-up reason
attributes	Array	Variable list (see attributes Element (ParamsInfo))
autoFlowName	String	AI agent name

---

attributes Element (ParamsInfo)

Field	Type	Description
name	String	Parameter display name
key	String	Parameter key
value	String	Parameter value

---

Call Status (callStatus) Reference

Value	Description
1	Pending
2	Scheduling
3	Dialing
4	Ringing
5	In Call
6	TTS Synthesizing
7	Paused
10	Completed
11	Invalid Number
12	Unreachable
13	User Busy
14	User Busy and Rejected
15	User Rejected
16	Scheduling Error
17	TTS Synthesis Failed
18	Unknown Reason
19	Blacklisted Number
20	Stopped (manual stop or insufficient balance)
21	Insufficient Customer Balance
22	Invalid Number Direction
23	Invalid Number
24	Ringing No Answer
25	No Response When Dialing
26	Early Media - Voicemail
27	Ringing Too Long
28	No Available Route Lines
29	Line Service Unavailable

---

Call Result (callResult) Reference

Value	Description
1	Normal End - Connected / Communicated
2	Human Voice Detected
3	Normal End - AI Agent Hung Up
6	Outbound Not Answered - Agent Quick Hang-up
7	Outbound Not Answered - User Quick Hang-up
8	Outbound Not Answered - User Rejected While Ringing
9	Outbound Not Answered - Timeout No Answer
10	Outbound Not Answered - Blacklisted Number
11	Outbound Not Answered - Restricted Number
12	Unreachable - Unreachable
13	Unreachable - Call Rejected
14	Unreachable - Temporarily Unreachable
15	Unreachable - Line Busy
16	Unreachable - Call Exception
17	Normal End - User Hung Up
18	Voicemail
19	Normal End - Early Media Voicemail
20	Silence
21	System Exception

---

Response Example

Success Example

{
  "code": 0,
  "message": "success",
  "traceId": null,
  "data": {
    "total": 4,
    "pageNumber": 1,
    "pageSize": 10,
    "list": [
      {
        "id": 125279,
        "taskId": "972e65ad-bfa5-4f35-845f-1867009b2c34",
        "contactId": "fde45ccd-9902-43a4-8e2e-ca4dba5a93e0",
        "autoFlowId": 207,
        "orderHead": 1,
        "orderTail": 1,
        "callerPhone": "00000",
        "calleePhone": "852385xxxx",
        "realPhone": "85xxxx",
        "callId": "fe90a9af-e14c-4330-8faa-2631e761124a",
        "callStatus": 10,
        "callResult": 17,
        "createTs": 1742378329,
        "opTs": 1742378340,
        "callStart": 1742378340,
        "callAnswer": 1742378343,
        "callEnd": 1742378480,
        "callRingTime": 3,
        "callElapsed": 137,
        "lineId": "lineID",
        "routeId": "routeID",
        "callAudioUrl": "https://nxai-gz-1259196162.cos.ap-guangzhou.myqcloud.com/20250319/xxxxxx.wav",
        "userIntent": "",
        "callSummary": "",
        "turnTime": 0,
        "manualCallStart": 0,
        "manualCallAnswer": 0,
        "manualCallEnd": 0,
        "manualCallStatus": 0,
        "manualElapsed": 0,
        "agentName": "",
        "agentId": "",
        "agentGroupName": "",
        "agentGroupId": "",
        "callCallbackUrl": "",
        "orderCallbackUrl": "",
        "sipAddr": "xxxxx",
        "sipCode": "200",
        "hangupReason": "NORMAL_CLEARING",
        "attributes": [
          { "name": "Name", "key": "sys.name", "value": "haier" },
          { "name": "Phone Number", "key": "sys.phoneNumber", "value": "85238531065" }
        ],
        "autoFlowName": "test-ai agent"
      }
    ]
  }
}

Error Codes

Code	Description
1001	Authentication failed (missing public parameters)
1002	Authentication failed (parameter error)
1003	Authentication failed (invalid signature)
1004	Authentication failed (timestamp expired)
1005	Authentication failed (insufficient authority)
20000	Business Error