Home > API Center > API interface guide

AI Agent Group Call Task Creation

POST

https://api.itniotech.com/voice/group/call/send/agent

Create AI Agent voice group call tasks.

Request Parameters

Basic Information

Task

Parameters	Description	Required	Type
appId	App id	Yes	String
taskName	The task name is 2-64 in length and cannot be repeated	Yes	String
dimensionId	Strategy Template ID (when creating via strategy template, no need to additionally pass the following parameters: display number, voice content, task settings, auto-redial section)	No (appId is required)	Integer

Called number

Parameters	Description	Required	Type
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

Set up tasks

Basic parameters

Parameters	Description	Required	Type
displayNum	Display number, 0-20 digits, can be empty	No	String
agentId	Agent ID	Yes	Integer
maxCalls	Max call duration. Forced hangup after n seconds of connection. Max 999 seconds, default 300s.	No	Integer
maxRingingTime	Max ringing duration, default 60, input range 10-120 seconds	No	Integer
enableRecording	Enable recording, 0-No, 1-Yes, default "Yes" if empty	No	Integer

Call time

Parameters	Description	Required	Type
sendTime	Immediate call: Pass null or nothing; Scheduled call: Time zone: (UTC+8), format: yyyy-MM-dd HH:mm:ss, example: "2023-01-01 12:00:00"	No	LocalDateTime
allowSendTime	Allowed sending time slots, max 3 entries	No	List
strTime	Start time, time zone: (UTC+8), format: HH:mm, example: "18:28"	No	String
endTime	End time, timezone: (UTC+8), format: HH:mm, example: "19:28"	No	String
deadline	Latest execution time of the task yyyy-MM-dd HH:mm:ss	No	LocalDateTime

Automatic redial

To enable automatic redialing, set the following parameters; otherwise, automatic redialing will not be enabled.

Basic parameters(recallFlow)

Parameters	Description	Required	Type
recallFlow	Whether to make a recall attempt should be set when a recall is needed. If recallFlow is empty, no recall attempt will be initiated.	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, measured in minutes, with an input range of 1-1440 minutes.	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	Automatic Recall Node: When left empty, automatic recall will be conducted based on the currently created task configuration. You can also apply personalized settings; however, if personalized settings are required, the number of array nodes must match the ["Number of Recall Attempts"].	Object	List<String>

Node parameters(nodeList)

The automatic redial node, when empty, will perform redials based on the currently created task configuration. You can also customize this setting, but the number of nodes in the array must match the number of redials.

Parameters	Description	Required	Type
nodeList	Automatic Recall Node: When left empty, automatic recall will be conducted based on the currently created task configuration. You can also apply personalized settings; however, if personalized settings are required, the number of array nodes must match the ["Number of Recall Attempts"].	Object	List<String>
agentId	Agent ID	No (Required if nodeList is passed)	Integer

callInformation Parameter Keys

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
Text11	Text11	/	No	No

Request Example

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"
        ]
    }
}

Response Parameters

Parameter	Description	Type
code	Status code, 0 for success, others see Response Status Codes	String
msg	Failure reason description	String
data	Return to Task ID here	Integer

Response Example

{
    "code":"0",
    "msg":"success",
    "data":123123
}

Response Status Codes

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

Get The Call Recording File Address

Exclude Numbers from the Calling Queue

Was this page helpful?

Questions about integration? Contact our technical support

ITNIO TECH API dedicated TG technical support channel, real-time response to your needs

Contact via Telegram

Message

Voice

Quick Start

Voice API

Quick Start

Agent Groups API

Management Side API

Quick Start

AI Agent API

Platform API

AI Agent Group Call Task Creation

Basic Information

Task

Called number

Set up tasks

Basic parameters

Call time

Automatic redial

Basic parameters(recallFlow)

Node parameters(nodeList)

Was this page helpful?

SMS

VOICE

By Industry

By Scenario

Message

Voice

Quick Start

Voice API

Quick Start

Agent Groups API

Management Side API

Quick Start

AI Agent API

Platform API

AI Agent Group Call Task Creation

Basic Information

Task

Called number

Set up tasks

Basic parameters

Call time

Automatic redial

Basic parameters(recallFlow)

Node parameters(nodeList)

Was this page helpful?