Voice Group Call Task Creation

POST

https://api.laaffic.com/v3/voice/group/call/send

Create a 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
numberInfoList	Number details, maximum 100,000 records	Yes	List<Object>
calleeNumber	The called number is a 7-15 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 hang-up SMS template. If there is ${text1} in the hang-up SMS 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 hang-up SMS template. If there is ${text2} in the hang-up SMS 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 hang-up SMS template. If there is ${text3} in the hang-up SMS 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 hang-up SMS template. If there is ${text4} in the hang-up SMS 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 hang-up SMS template. If there is ${text5} in the hang-up SMS 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 hang-up SMS template. If there is ${text6} in the hang-up SMS 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 hang-up SMS template. If there is ${text7} in the hang-up SMS 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 hang-up SMS template. If there is ${text8} in the hang-up SMS 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 hang-up SMS template. If there is ${text9} in the hang-up SMS 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 hang-up SMS template. If there is ${text10} in the hang-up SMS 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
source	File source (1- uploaded file, 2- reuploaded voice file, 3- text-to-speech)	Yes	Integer
voiceFileId	Voice file ID	source=1 Must pass	String
uploadName	Name of the uploaded file, 5-32 characters in length	source=2 Required	String
baseFile	base64 file stream	source=2 Required	String
text	File contents: tts text Max 1000	source=3 Required	String
lan	Language, please check the form for language details	source=3 Required	String
speakingRate	Speech speed: 0.25 - 4 times	No	Double
ssmlGender	Voice: 1 male, 2 female. Allowed to be empty. When there are multiple voices, the system uses female voice by default.	No	Integer
accent	Accent, you can configure the language accent, such as English [American Accent], English [Indian Accent], etc. For accent details, please check the table.	No	String
sendTime	Scheduled call time (null for immediate calls)	No	LocalDateTime
loopCount	Default 1 broadcast maximum 9	Yes	Integer
maxCalls	Maximum call duration, n seconds after connection forced hang up maximum 999 seconds	Yes	Integer
hangUpSms	Trigger hang up SMS 0- no, 1- Yes	No	Integer
smsAppId	SMS App ID	hangUpSms=1, required	String
smsContent	Hang up SMS template, maximum 1000 characters. Support variable replacement function, variables ${text1}-${text10}	hangUpSms=1, required	String
senderId	Sender ID Max 32 characters	No	String
feedbackPush	Button feedback Push SMS: 0- no, 1- yes	hangUpSms=1, (feedbackPush, successPush, failedPush, ringPush) This parameter is mandatory	Integer
feedbackValue	Feedbackvalue: 0-9	feedbackPush =1, required	String
successPush	Call success Push Send SMS: 0- no, 1- yes	hangUpSms=1, (feedbackPush, successPush, failedPush, ringPush) This parameter is mandatory	Integer
successPushTime	Number of seconds after successful call push SMS message minimum 0s Maximum 9999	successPush=1, which is mandatory	Integer
failedPush	Failed call Push SMS: 0- No, 1- yes	hangUpSms=1, (feedbackPush, successPush, failedPush, ringPush) This parameter is mandatory	Integer
ringPush	Ring successfully push SMS: 0- No, 1- yes	hangUpSms=1, (feedbackPush, successPush, failedPush, ringPush) This parameter is mandatory	Integer
toSeat	Toseat or not :0- no, 1- Yes	No	Integer
sipGroupId	Agent group id	Required when toSeat=1	Integer
outboundControl	Outgoing Call controller, 1- proportional outgoing call	Required when toSeat=1	Integer
calloutRate	Outgoing call multiplier, up to 1-100	Required when toSeat=1	Integer
toSeatType	Switch to seat condition, 1 transfer after the group call ends, 2 transfer according to key feedback,	When toSeat=1, this parameter is required	Integer
toSeatKey	Toseatkey	Required when toSeat=1 and toSeatType=2	Integer
allowSendTime	Allow sendtime 3 Add up to 3 time periods that can be sent	No	List
strTime	Start time HH:SS	No	String
endTime	End time HH:SS	No	String
maxRingingTime	Maximum ringing duration, default is 60, can be entered in 20-120 seconds	No	Integer
delayPlay	Delayed playback, default is 0, can be entered in 0-999 seconds.	No	Integer
delayHangup	Delayed hang up, default is 0, can be entered in 0-999 seconds.	No	Integer
delayTransfer	Delayed transfer, unit is seconds.	Parameter takes effect when toSeat=1 and toSeatType=2	Integer

Request Sample

Request URL:
    https://api.laaffic.com/v3/voice/group/call/send
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:0511",
    "source": 3,
    "loopCount": 1,
    "maxCalls": 40,
    "hangUpSms": 1,
    "toSeat": 1,
    "sipGroupId": 1000019,
    "outboundControl": 1,
    "calloutRate": 1,
    "toSeatKey": 0,
    "toSeatType": 2,
    "numberInfoList":[{
        "calleeNumber":"8613000000001",
        "text1":"tom",
        "text2":"$12451.12",
        "text3":"2025-3-21"
    }],
    "sendTime": "2024-06-21 00:00:00",
    "text": "Mã xác nhận của bạn là 22294",
    "smsAppId": "9obbP7Nl",
    "senderId": "123",
    "smsContent": "123",
    "feedbackValue": 0,
    "successPushTime": 10,
    "feedbackPush": 0,
    "successPush": 0,
    "failedPush": 0,
    "ringPush": 1,
    "lan": "VN",
    "accent":"91",
    "ssmlGender":2,
    "speakingRate":1,
    "displayNum": "1008122211",
    "maxRingingTime": 60,
    "allowSendTime": [
        {
            "strTime": "18:28",
            "endTime": "19:28"
        }
    ],
    "delayPlay":0,
    "delayHangup":0,
    "delayTransfer":30
}

Response Parameters

Parameters	Description	Type
code	"0"means successful, others than 0 means failure, seeing Status Code description.	String
msg	Failure reason description	String
data	This method returns the keyId	Integer

Request Sample

{
    "code":"0",
    "msg":"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