| Parameters |
Description |
Required |
Type |
| keyId |
The primary key equals the query return jobId |
Yes |
Integer |
| displayNum |
Display number |
No |
String |
| taskName |
Task name |
Yes |
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 |
Upload file name |
source=2 Required |
String |
| baseFile |
base64 file stream |
source=2 Required |
String |
| text |
File contents: tts text |
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 |
Loop count, Default is 1 |
No |
Integer |
| maxCalls |
Maximum call duration, with forced hang-ups n seconds after connection |
No |
Integer |
| resendType |
Resend type, 0 resend all 1 resend failed |
Yes |
Integer |
| hangUpSms |
Trigger hang up SMS 0- no, 1- Yes |
No |
Integer |
| smsAppId |
SMS app primary key |
hangUpSms=1, required |
String |
| smsContent |
Text message content |
hangUpSms=1, required |
String |
| senderId |
Sender ID |
No |
String |
| feedbackPush |
Button feedback Push SMS: 0- no, 1- yes |
No |
Integer |
| feedbackValue |
Feedback value: 0-9 |
No |
String |
| successPush |
Call success Push Send SMS: 0- no, 1- yes |
No |
Integer |
| successPushTime |
Number of seconds after a successful call The default value of the push SMS message is 10s |
No |
Integer |
| failedPush |
Failed call Push SMS: 0- No, 1- yes |
No |
Integer |
| ringPush |
Ring successfully push SMS: 0- No, 1- yes |
No |
Integer |
| toSeat |
To seat 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 |
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 |
To seat key |
Required when toSeat=1 and toSeatType=2 |
Integer |
| allowSendTime |
Allow send time 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 |