Home > API Center > API interface guide

 
 

AI Agent Global Status Code

 
Response Status Code
status Description
0 success
-1 Authentication error
-2 Restricted IP access
-10 The customer's balance is insufficient
-16 Timestamp expires
-18 Port program unusual
-20 Data existing
-21 Data validation exception
-22 Parameter exception
-23 Data caps
-24 Data unexisting
-25 Out of time range
-26 Getting fee faily
-29 WorkSpace is disabled
-30 API Key is disabled
-31 IP is not in the whitelist
-32 API Key does not have permission to access the current application
-34 There is no callable number when the task was ended last time. Please start the group call task again.
-35 No number called
-37 The group call task you submitted exceeds the maximum concurrent task limit. Please complete the task before submitting again!
-38 Conversion text and language type are required
-39 Failed to obtain the text language type
-41 Task name already exists
-42 Recall is allowed only when the task is canceled or completed
-43 Editing is allowed only in the waiting and paused states
-46 The maximum number of long text-to-speech conversions per day is 5. You have used up all of them. Please contact the business department for processing.
-47 Text to speech failed
-48 File does not exist
-49 Wrong file source parameter
-50 Audio file ID is required
-51 Base64 file stream and file name are required
-52 AppId does not match API Key
-53 The trigger condition for the on-hook SMS must have one
-54 The task you submitted is wrong, please check and submit again!
-60 The AI speech template does not exist
 
Call Status Enumeration Description
Value Description
1 Connected
2 Connected Abnormal
3 Not Connected
4 Not Connected Abnormal
 
Call Description Enumeration Description
Value Description
1 Effective Call
2 Voicemail
3 Short Duration Hangup
4 No Audio
5 Caller Hangup
6 Callee Busy/Rejected
7 Out of Service
8 Timeout No Answer
10 Line Balance Announcement
 
Encoding Table
Global:
Code Intent Name Remarks
99998 Not called  
99999 Called but not connected  
Financial Collection-V1 (Code starts with 20):
Code Intent Name Remarks
201 Voicemail The user side speaking after connection is voicemail
202 No response from customer  
204 Customer repayment intent unknown  
205 Promise to pay: On time  
206 Promise to pay: Deferred  
207 Cannot pay: Subjective refusal  
208 Cannot pay: Deny loan  
209 Cannot pay: Need installment application  
2010 Customer already paid  
Financial Collection-V2 (Code starts with 20):
ID Intent Name Remarks
2012 Connected - Voicemail: Insufficient Balance  
2013 Connected - Voicemail: Marketing Robot  
2022 Connected - Voicemail: Other  
202 Connected - No Response from Customer  
2014 Connected - Repayment Intent Unknown: Harassment Claim  
2015 Connected - Repayment Intent Unknown: Inaudible/Unclear  
2016 Connected - Repayment Intent Unknown: Wrong Number  
2023 Connected - Repayment Intent Unknown: Other  
205 Connected - Promise to Pay: On Time  
206 Connected - Promise to Pay: Deferred Payment  
2017 Connected - Unable to Pay: Product Dispute  
207 Connected - Unable to Pay: Refusal to Pay  
2018 Connected - Unable to Pay: Denies Loan (Did not apply)  
2019 Connected - Unable to Pay: Denies Loan (Did not receive funds)  
2024 Connected - Unable to Pay: Denies Loan (Other)  
209 Connected - Unable to Pay: Requesting Installments  
2020 Connected - Unable to Pay: Needs Repayment Assistance  
2021 Connected - Unable to Pay: Repayment Exception  
2010 Connected - Customer Already Paid  
Financial Marketing (Code starts with 30):
Code Intent Name Remarks
301 Voicemail The user side speaking after connection is voicemail
302 No response from customer  
304 Customer intent unknown  
305 Customer clearly interested  
306 Customer clearly not interested  
Financial Collection - Emergency Contact Conveyance (Code: Starts with 40)
ID Intent Name
4012 Connected - Voicemail: Insufficient Balance
4013 Connected - Voicemail: Marketing Robot
401 Connected - Voicemail: Other
402 Connected - No Response from Other Party
403 Connected - Other Party Agrees to Convey
404 Connected - Other Party Already Informed
405 Connected - Other Party Refuses to Convey
406 Connected - Other Party Does Not Know Debtor
407 Connected - Non-Target Contact
408 Connected - Conveyance Intent Unknown: Harassment Call
409 Connected - Conveyance Intent Unknown: Inaudible
4010 Connected - Conveyance Intent Unknown: Other