Home > API Center > API interface guide
Redial Task
POST
https://api.laaffic.com/v3/voice/group/call/resend
Normal voice group call task recall.
Request Parameters
Basic Information
Task
| 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 |
Voice content
| Parameters | Description | Required | Type |
|---|---|---|---|
| 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 | Convert language | 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 |
Basic parameters
| Parameters | Description | Required | Type |
|---|---|---|---|
| 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 |
| maxRingingTime | Maximum ringing duration, default is 60, can be entered in 20-120 seconds | No | Integer |
| loopCount | Loop count, Default is 1 | No | Integer |
| maxCalls | Maximum call duration, with forced hang-ups n seconds after connection | No | Integer |
Call time
| Parameters | Description | Required | Type |
|---|---|---|---|
| sendTime | Scheduled call time (null for immediate calls) | No | LocalDateTime |
| allowSendTime | Allow send time 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 |
Task
| Parameters | Description | Required | Type |
|---|---|---|---|
| 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 |
| 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 |
Group call to switch seats
| Parameters | Description | Required | Type |
|---|---|---|---|
| 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 |
| 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/resend
Request Method:
POST
Request Headers:
Content-Type: application/json;charset=UTF-8
Sign: 05d7a50893e22a5c4bb3216ae3396c7c
Timestamp: 1630468800
Api-Key: bDqJFiq9
Request Body:
{
"keyId":123,
"appId": "iaAJ6COV",
"taskName": "2024-06-03 10:42:0511",
"source": 3,
"loopCount": 1,
"maxCalls": 40,
"resendType": 0,
"hangUpSms": 1,
"toSeat": 1,
"sipGroupId": 1000019,
"outboundControl": 1,
"calloutRate": 1,
"toSeatKey": 0,
"toSeatType": 2,
"numberList":["8613242926514"],
"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,
"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 |
| -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 |