Home > API Center > API interface guide

Brand
Get Started

Message

Voice

 

Edit Task (Auto-Recall)

POST

https://api.itniotech.com/voice/recallFlow/update

Edit AI Agent auto-recall task details, editable only when the auto-recall task status 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 voice file, 3-Text-to-speech) Yes Int
voiceFileId Voice file ID Yes if source=1 String
uploadName Uploaded file name, 5-32 characters length Yes if source=2 String
baseFile Base64 file stream Yes if source=2 String
text File content: TTS text, max 1000 characters Yes if source=3 String
lan Language, please refer to the table for detailed Language content Yes if source=3 String
speakingRate Speaking rate: 0.25 - 4x No Double
ssmlGender Voice gender: 1-Male, 2-Female. Can be empty; defaults to Female if multiple options exist No Int
accent Accent, can configure language accent, such as English [US Accent], English [Indian Accent], etc. Please refer to the table for detailed Accent content No Int
hangUpSms Trigger hang-up SMS: 0-No, 1-Yes Yes Int
smsContent Hang-up SMS template, max 1000 characters. Supports variable substitution, variables ${text1}-${text10} Yes if hangUpSms=1 String
senderId Sender ID, max 32 characters No String
feedbackPush Keypress feedback push SMS: 0-No, 1-Yes hangUpSms=1, at least one of (feedbackPush, successPush, failedPush, ringPush) must be 1
Supports multiple selection 		Int
feedbackValue Keypress feedback value: 0-9 Yes if feedbackPush=1 String
successPush Call success push SMS: 0-No, 1-Yes hangUpSms=1, at least one of (feedbackPush, successPush, failedPush, ringPush) must be 1
Supports multiple selection 		Int
successPushTime How many seconds after call success to push SMS, min 1s, max 9999s Yes if successPush=1 Int
failedPush Call failed push SMS: 0-No, 1-Yes hangUpSms=1, at least one of (feedbackPush, successPush, failedPush, ringPush) must be 1
Supports multiple selection 		Int
ringPush Ring success push SMS: 0-No, 1-Yes hangUpSms=1, at least one of (feedbackPush, successPush, failedPush, ringPush) must be 1
Supports multiple selection 		Int
toSeat Transfer to agent: 0-No, 1-Yes Yes Int
sipGroupId Agent group ID Yes if toSeat=1 Int
outboundControl Outbound controller, 1-Proportional outbound Yes if toSeat=1 Int
calloutRate Outbound multiplier, max 1-100 Yes if toSeat=1 Int
toSeatType Transfer to agent condition, 1-Transfer after group call ends, 2-Transfer based on keypress feedback Yes if toSeat=1 Int
toSeatKey Transfer key Yes if toSeat=1 and toSeatType=2 String
delayTransfer Delay transfer, in seconds. Parameter takes effect when transferring to agent and by keypress Effective if toSeat=1 and toSeatType=2 Int
 
Request Example
Request URL:
    https://api.itniotech.com/voice/recallFlow/update
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 Status code, 0 is success, for other failures see Response Status Codes String
reason Failure reason description String
data Returned data details Object
 
Response Example
{
"code": 0,
"msg": "success",
"data": null
}
 
Response Status Codes
code Status Description
0 Success
-1 Account authentication exception
-2 IP limit
-16 Timestamp expired
-18 System exception
-22 Parameter exception
Query Task Details (Auto Recall)
Cancel Task (Auto Recall)

Was this page helpful?

Questions about integration? Contact our technical support

ITNIO TECH API dedicated TG technical support channel, real-time response to your needs

Contact via Telegram