Home > API Center > API interface guide
https://api.itniotech.com/voice/group/call/send/agent
| Parameter | Description | Required | Type |
|---|---|---|---|
| appId | Application ID | Yes | String |
| displayNum | Display number, 0-20 digits, can be empty | No | String |
| taskName | Task name, length 2-64, must be unique | Yes | String |
| numberInfoList | Callee numbers, max 200k mobile numbers. Multiple numbers separated by commas. Each number format: Country code + mobile number (6-18 digits). | Yes | List<Object> |
| calleeNumber | Callee number, 6-18 digits consisting of country code + mobile number | Yes | String |
| callInformation | Callee Info: Callee information with custom field names, key is the business field name (e.g. name, borrow_total_money). For parameter keys, see the table below. | No (For use only in financial debt collection scenarios and financial debt collection - emergency contact relay scenarios) | Map<String, String> |
| text1 | Callee Info: Text1. Used to replace variable ${text1} in the text variable template. If the template contains ${text1}, this parameter cannot be null. Length max 30 characters, otherwise truncated. | No | String |
| text2 | Callee Info: Text2. Used to replace variable ${text2} in the text variable template. If the template contains ${text2}, this parameter cannot be null. Length max 30 characters, otherwise truncated. | No | String |
| text3 | Callee Info: text3. Used to replace variable ${text3} in the text variable template. If the template contains ${text3}, this parameter cannot be null. Length max 30 characters, otherwise truncated. | No | String |
| text4 | Callee Info: Text4. Used to replace variable ${text4} in the text variable template. If the template contains ${text4}, this parameter cannot be null. Length max 30 characters, otherwise truncated. | No | String |
| text5 | Callee Info: Text5. Used to replace variable ${text5} in the text variable template. If the template contains ${text5}, this parameter cannot be null. Length max 30 characters, otherwise truncated. | No | String |
| text6 | Callee Info: Text6. Used to replace variable ${text6} in the text variable template. If the template contains ${text6}, this parameter cannot be null. Length max 30 characters, otherwise truncated. | No | String |
| text7 | Callee Info: Text7. Used to replace variable ${text7} in the text variable template. If the template contains ${text7}, this parameter cannot be null. Length max 30 characters, otherwise truncated. | No | String |
| text8 | Callee Info: Text8. Used to replace variable ${text8} in the text variable template. If the template contains ${text8}, this parameter cannot be null. Length max 30 characters, otherwise truncated. | No | String |
| text9 | Callee Info: Text9. Used to replace variable ${text9} in the text variable template. If the template contains ${text9}, this parameter cannot be null. Length max 30 characters, otherwise truncated. | No | String |
| text10 | Callee Info: Text10. Used to replace variable ${text10} in the text variable template. If the template contains ${text10}, this parameter cannot be null. Length max 30 characters, otherwise truncated. | No | String |
| sendTime | Scheduled call time (pass null for immediate call) | No | LocalDateTime |
| maxCalls | Max call duration. Forced hangup after n seconds of connection. Max 999 seconds, default 300s. | No | Integer |
| allowSendTime | Allowed sending time slots, max 3 entries | No | List |
| strTime | Start Time HH:MM | No | String |
| endTime | End Time HH:MM | No | String |
| maxRingingTime | Max ringing duration, default 60, input range 10-120 seconds | No | Integer |
| agentId | Agent ID | Yes | Integer |
| enableRecording | Enable recording, 0-No, 1-Yes, default "Yes" if empty | No | Integer |
| recallFlow | Recall Flow | No | Object |
| recallType | Recall Type: 0 Resend all, 1 Resend failed, 3 Recall by intent | No (Required if recallFlow is passed) | Integer |
| recallInterval | Recall Interval | No (Required if recallFlow is passed) | Integer |
| recallIntent | Recall Intent codes, see Encoding Table for details | No | List<String> |
| recallNum | Recall Count | No (Required if recallFlow is passed) | Integer |
| nodeList | Flow Nodes | Object | List<String> |
| agentId | Agent ID | No (Required if nodeList is passed) | Integer |
| Parameter Name | Variable | Description | [Financial Debt Collection] Scenario Intelligent Agent: Required | [Financial Debt Collection - Emergency Contact Forwarding] Scenario Intelligent Agent: Required |
|---|---|---|---|---|
| name | Text1 | Repayer | Yes | Yes |
| borrow_total_money | Text2 | Current total amount payable | Yes | Yes |
| due_date | Text3 | Due date | Yes | Yes |
| due_days | Text4 | Days overdue | No | No |
| platform | Text5 | Loan type/product | No | No |
| gender | Text6 | Gender | No | No |
| loan_date | Text7 | Loan date | No | No |
| loan_total_money | Text8 | Total loan amount | No | No |
| overdue_fee | Text9 | Current overdue fee | No | No |
| emergency_contact_name | Text10 | Emergency contact name | No | Yes |
Request URL:
https://api.itniotech.com/voice/group/call/send/agent
Request Method:
POST
Request Headers:
Content-Type: application/json;charset=UTF-8
Sign: 05d7a50893e22a5c4bb3216ae3396c7c
Timestamp: 1630468800
Api-Key: bDqJFiq9
Request Body:
{
"appId": "2Xql9RBI",
"taskName": "I want to test Agent API-16",
"displayNum": "1008122211",
"maxCalls": 300,
"maxRingingTime": 60,
"agentId": 41,
"enableRecording": 1,
"calloutRate": 1,
"allowSendTime": [
{
"strTime": "18:28",
"endTime": "19:28"
}
],
"numberInfoList": [
{
"calleeNumber": "463200000007",
"callInformation": {
"name": "Name",
"borrow_total_money": "5000",
"due_date":"2026-02-02"
}
}
],
"recallFlow": {
"recallType": 3,
"recallInterval": 1,
"recallNum": 5,
"nodeList": [
{"agentId": "41"},
{"agentId": "41"},
{"agentId": "41"},
{"agentId": "41"},
{"agentId": "41"}
],
"recallIntent": [
"99998","99999"
]
}
}| Parameter | Description | Type |
|---|---|---|
| code | Status code, 0 for success, others see Response Status Codes | String |
| msg | Failure reason description | String |
| data | This method returns keyId | Integer |
{
"code":"0",
"msg":"success",
"data":123123
}| code | Description |
|---|---|
| 0 | success |
| -1 | Authentication error |
| -2 | Restricted IP access |
| -16 | Timestamp expires |
| -18 | Port program unusual |
| -20 | Data existing |
| -21 | Data validation exception |
| -22 | Parameter exception |
| -23 | Data caps |
| -24 | Data unexisting |
| -26 | Getting fee faily |
| -34 | There is no callable number when the task was ended last time. Please start the group call task again. |
| -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 |
| -60 | The AI speech template does not exist |
| -68 | AI Agent industry intent does not match recall intent |
| Code | Intent Name | Remarks |
|---|---|---|
| 99998 | Not called | |
| 99999 | Called but not connected |
| 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 |
| 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 |
| 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 |
| 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 |
Questions about integration? Contact our technical support
ITNIO TECH API dedicated TG technical support channel, real-time response to your needs
