Home > API Center > API interface guide
AI Voice Group Call Task Creation
POST
https://api.laaffic.com/v3/voice/group/call/send/ai
Create a AI voice group call task.
Request Parameters
| Parameters | Description | Required | Type |
|---|---|---|---|
| appId | App id | Yes | String |
| displayNum | Display number 0-20 digits, blank allowed | No | String |
| taskName | The task name is 2-64 in length and cannot be repeated | Yes | String |
| numberList | Called number A maximum of 20w mobile phone numbers. Multiple mobile phone numbers are separated by commas (,). Each mobile phone number consists of 6-18 digits: country code + mobile phone number. | Yes | List<String> |
| calleeNumber | The called number is a 6-18 digit number consisting of the country code and the mobile phone number. | Yes | String |
| text1 | Callee information: Text1. It can be used to replace the variable ${text1} in the text variable template. If there is ${text1} in the text variable template, the value of this parameter cannot be null. The field length does not exceed 30 characters. If the string No is not specified, it will be truncated. | No | String |
| text2 | Callee information: Text2. It can be used to replace the variable ${text2} in the text variable template. If there is ${text2} in the text variable template, the value of this parameter cannot be null. The field length does not exceed 30 characters. If the string No is not specified, it will be truncated. | No | String |
| text3 | Callee information: Text3. It can be used to replace the variable ${text3} in the text variable template. If there is ${text3} in the text variable template, the value of this parameter cannot be null. The field length does not exceed 30 characters. If the string No is not specified, it will be truncated. | No | String |
| text4 | Callee information: Text4. It can be used to replace the variable ${text4} in the text variable template. If there is ${text4} in the text variable template, the value of this parameter cannot be null. The field length does not exceed 30 characters. If the string No is not specified, it will be truncated. | No | String |
| text5 | Callee information: Text5. It can be used to replace the variable ${text5} in the text variable template. If there is ${text5} in the text variable template, the value of this parameter cannot be null. The field length does not exceed 30 characters. If the string No is not specified, it will be truncated. | No | String |
| text6 | Callee information: Text6. It can be used to replace the variable ${text6} in the text variable template. If there is ${text6} in the text variable template, the value of this parameter cannot be null. The field length does not exceed 30 characters. If the string No is not specified, it will be truncated. | No | String |
| text7 | Callee information: Text7. It can be used to replace the variable ${text7} in the text variable template. If there is ${text7} in the text variable template, the value of this parameter cannot be null. The field length does not exceed 30 characters. If the string No is not specified, it will be truncated. | No | String |
| text8 | Callee information: Text8. It can be used to replace the variable ${text8} in the text variable template. If there is ${text8} in the text variable template, the value of this parameter cannot be null. The field length does not exceed 30 characters. If the string No is not specified, it will be truncated. | No | String |
| text9 | Callee information: Text9. It can be used to replace the variable ${text9} in the text variable template. If there is ${text9} in the text variable template, the value of this parameter cannot be null. The field length does not exceed 30 characters. If the string No is not specified, it will be truncated. | No | String |
| text10 | Callee information: Text10. It can be used to replace the variable ${text10} in the text variable template. If there is ${text10} in the text variable template, the value of this parameter cannot be null. The field length does not exceed 30 characters. If the string No is not specified, it will be truncated. | No | String |
| sendTime | Scheduled call time (null for immediate calls) | No | LocalDateTime |
| maxCalls | Maximum call duration, n seconds after connection forced hang up maximum 999 seconds | Yes | Integer |
| allowSendTime | Allow sendtime 3 Add up to 3 time periods that can be sent | No | List |
| strTime | Start time HH:MM | No | String |
| endTime | End time HH:MM | No | String |
| maxRingingTime | Maximum ringing duration, default is 60, can be entered in 20-120 seconds | No | Integer |
| scriptId | The AI speech template ID | Yes | Integer |
| enableRecording | Whether to enable recording, 0-no, 1-yes. If not filled, the default is no. | No | Integer |
| calloutRate | Outbound call multiplier Default: 1 | No | Integer |
Request Sample
Request URL:
https://api.laaffic.com/v3/voice/group/call/send/ai
Request Method:
POST
Request Headers:
Content-Type: application/json;charset=UTF-8
Sign: 05d7a50893e22a5c4bb3216ae3396c7c
Timestamp: 1630468800
Api-Key: bDqJFiq9
Request Body:
{
"appId": "iaAJ6COV",
"taskName": "2024-06-03 10:42:05",
"maxCalls": 40,
"numberInfoList":[{
"calleeNumber":"8613242926514",
"text1":"12"
},{
"calleeNumber":"8613242926515",
"text1":"12"
}],
"sendTime": "2024-06-21 00:00:00",
"displayNum": "1008122211",
"maxRingingTime":60,
"scriptId":123,
"enableRecording":0,
"allowSendTime": [
{
"strTime": "18:28",
"endTime": "19:28"
}
]
}Response Parameters
| Parameters | Description | Type |
|---|---|---|
| status | "0"means successful, others than 0 means failure, seeing Status Code description. | String |
| reason | Failure reason description | String |
| data | This method returns the keyId | Integer |
Request Sample
{
"status":"0",
"reason":"success",
"data":123123
}Response Status Code
| status | 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 |
| -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 |
| -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. |
| -53 | The trigger condition for the on-hook SMS must have one |
| -60 | The AI speech template does not exist |
Was this page helpful?
Questions about integration? Contact our technical support
LAAFFIC API dedicated TG technical support channel, real-time response to your needs