Home > API Center > API interface guide
Edit Task (Auto Redial)
POST
https://api.laaffic.com/v3/voice/recallFlow/update
Editing details of automatic redial tasks is only permitted when the status of the automatic redial task is "Pending".
Request Parameters
| Parameter | Description | Required | Type |
|---|---|---|---|
| keyId | The unique primary key for the automatic redial task process | Yes | Int |
| recallInterval | Recall interval, measured in minutes, with an input range of 1-1440 minutes. | Yes | Int |
| recallNum | Number of recall attempts, with an input range of 1-10. | Yes | Int |
| recallType | Recall type: Each recall attempt is based on the result of the previous task. 0 - Recall all attempts, 1 - Recall only failed attempts. | Yes | Int |
| nodeList | Automatic Recall Node | No | Array |
| source | File Source (1 - Uploaded File, 2 - Re-upload Audio File, 3 - Text-to-Speech) | Yes | Int |
| voiceFileId | Voice file ID | source=1 Required | 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 | Int |
| 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 | Int |
| hangUpSms | Trigger hang up SMS 0- no, 1- Yes | Yes | Int |
| smsContent | Text message content 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 | Int |
| 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 | Int |
| successPushTime | Number of seconds after successful call push SMS message minimum 0s Maximum 9999 | successPush=1, required | Int |
| failedPush | Failed call Push SMS: 0- No, 1- yes | hangUpSms=1, (feedbackPush, successPush, failedPush, ringPush) This parameter is mandatory | Int |
| ringPush | Ring successfully push SMS: 0- No, 1- yes | hangUpSms=1, (feedbackPush, successPush, failedPush, ringPush) This parameter is mandatory | Int |
| toSeat | Toseat or not :0- no, 1- Yes | Yes | Int |
| sipGroupId | Agent group id | Required when toSeat=1 | Int |
| outboundControl | Outgoing Call controller, 1- proportional outgoing call | Required when toSeat=1 | Int |
| calloutRate | Outgoing call multiplier, up to 1-100 | Required when toSeat=1 | Int |
| toSeatType | Switch to seat condition, 1 transfer after the group call ends, 2 transfer according to key feedback | Required when toSeat=1 | Int |
| toSeatKey | Toseatkey | Required when toSeat=1 and toSeatType=2 | String |
| delayTransfer | Delayed transfer, unit is seconds. | Required when toSeat=1 and toSeatType=2 | Int |
Request Example
Request URL:
https://api.laaffic.com/v3/voice/recallFlow/queryPage
Request Method:
POST
Request Headers:
Content-Type: application/json;charset=UTF-8
Sign: 05d7a50893e22a5c4bb3216ae3396c7c
Timestamp: 1630468800
Api-Key: bDqJFiq9
Request Body:
{
"keyId": 299,
"recallType": 0,
"recallInterval": 30,
"recallNum": 1,
"nodeList": [
{
"voiceFileId": "120250811103439c1901f4c53b691b419ad8a143b.wav",
"voiceFileName": null,
"source": 1,
"text": null,
"lan": null,
"speakingRate": null,
"hangUpSms": 0,
"idxSmsAppId": null,
"smsContent": null,
"senderId": null,
"feedbackValue": null,
"feedbackPush": null,
"successPush": null,
"successPushTime": null,
"failedPush": null,
"ringPush": null,
"toSeat": 1,
"sipGroupId": 1000038,
"outboundControl": 1,
"calloutRate": 1,
"toSeatType": 1,
"toSeatKey": null,
"delayTransfer": 0
}
]
}Response Parameters
| Parameter | Description | Type |
|---|---|---|
| code | "0"means successful, others than 0 means failure, seeing Status Code description. | String |
| msg | Failure reason description | String |
| data |
Response Example
{
"code": 0,
"msg": "success",
"data": null
}Response Codes
| code | Description |
|---|---|
| 0 | success |
| -1 | Authentication error |
| -2 | Restricted IP access |
| -16 | Timestamp expires |
| -18 | Port program unusual |
| -22 | Parameter exception |
Was this page helpful?
Questions about integration? Contact our technical support
LAAFFIC API dedicated TG technical support channel, real-time response to your needs