Home > API Center > API interface guide

Brand
Get Started

Message

Voice

 

Query Task Details (Auto Recall)

POST

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

Query details of automatic redial tasks.
 
Request Parameters
Parameter Description Required Type
keyId The unique primary key for the automatic redial task process Yes Int
 
Request Example
Request URL:
    https://api.itniotech.com/voice/recallFlow/queryDetail
Request Method:
    POST
Request Headers:
    Content-Type: application/json;charset=UTF-8
    Sign: 05d7a50893e22a5c4bb3216ae3396c7c
    Timestamp: 1630468800
    Api-Key: bDqJFiq9
Request Body:
{
    "keyId": 12
}
 
Response Parameters
Parameter Description Type
status Status code, 0 for success, for other failures refer to Response Status Codes String
reason Description of failure reason String
data Details data Object
keyId The unique primary key for the automatic redial task process Int
recallInterval Recall interval, measured in minutes. Int
recallNum Number of recall attempts. Int
recallType Recall type: 0 - Recall all attempts, 1 - Recall only failed attempts. Int
status Status: 0 - Pending, 1 - In Progress, 2 - Completed, 3 - Cancelled, 4 - Execution Exception Int
nodeList Details of nodes in the redial process JSONArray
keyId Unique primary key for process nodes Int
taskId Task ID associated with process nodes Int
nodeStatus Node status: 0 - Pending, 1 - In Progress, 2 - Completed, 3 - Cancelled, 4 - Execution Exception Int
source File source: 1-Uploaded file, 2-Re-upload audio file, 3-Text to speech Int
voiceFileId Audio file ID String
uploadName Upload file name, length 5-32 characters String
text File content: TTS text, max 1000 characters String
lan Language String
speakingRate Speaking rate: 0.25 - 4.0x Double
ssmlGender Voice type: 1-Male, 2-Female. Can be empty, if multiple voices exist, system defaults to female voice Int
accent Accent, can configure language accent, e.g. English [US Accent], English [Indian Accent], etc. Detailed accents refer to the table Int
hangUpSms Trigger hang-up SMS: 0-No, 1-Yes Int
smsContent Hang-up SMS template, max 1000 characters, supports variables ${text1}-${text10} String
senderId Sender ID, max 32 characters String
feedbackPush Keypress feedback push SMS: 0-No, 1-Yes Int
feedbackValue Keypress feedback value: 0-9 String
successPush Call success push SMS: 0-No, 1-Yes Int
successPushTime How many seconds after call success to push SMS, min 1s, max 9999s Int
failedPush Call failure push SMS: 0-No, 1-Yes Int
ringPush Ring success push SMS: 0-No, 1-Yes Int
toSeat Transfer to agent: 0-No, 1-Yes Int
sipGroupId Agent group ID Int
outboundControl Outbound controller: 1-Proportional outbound Int
calloutRate Outbound rate multiplier, max 1-100 Int
toSeatType Agent transfer condition: 1-Transfer after group call ends, 2-Transfer according to keypress feedback Int
toSeatKey Transfer key String
delayTransfer Delay transfer, in seconds. Parameter takes effect when transferring to agent and by keypress transfer Int
 
Response Example
{
    "code": 0,
    "msg": "success",
    "data": {
        "records": [
            {
                "keyId": 1427,
                "taskId": 5009612,
                "nodeStatus": 2,
                "voiceFileId": "120250811103439c1901f4c53b691b419ad8a143b.wav",
                "source": 1,
                "text": null,
                "lan": null,
                "speakingRate": null,
                "hangUpSms": 0,
                "smsContent": null,
                "senderId": null,
                "feedbackValue": null,
                "feedbackPush": null,
                "successPush": null,
                "successPushTime": null,
                "failedPush": null,
                "ringPush": null,
                "toSeat": 0,
                "sipGroupId": null,
                "outboundControl": null,
                "calloutRate": null,
                "toSeatType": null,
                "toSeatKey": null,
                "delayTransfer": 0
            }
        ],
        "total": 574,
        "size": 1,
        "current": 1,
        "searchCount": true,
        "pages": 574
    }
}
 
Response Status Codes
code Status Description
0 Success
-1 Authentication error
-2 Restricted IP access
-16 Timestamp expired
-18 Port program unusual
-22 Parameter exception
Query Task List (Automatic Recall)
Edit 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