首頁 > API中心 > IVR群呼 > 文檔指引

快速入門-任務方式

IVR群呼

用於向批量用戶發送重要信息通知,貸款逾期催繳、信用卡還款提醒、理財產品到期通知、活動營銷等;

任務對接流程

图片

前期準備

取得API Key、API Secret和appld的值。

需登陸客戶端取得, 具體位圖如下圖所示:

图片

Sign簽名規則

使用API Key + API Secret + Timestamp當前系統時間戳(秒),生成MD5-32位字符串(不區分大小寫)作為簽名。

示例:

API Key:bDqJFiq9

API Secret:7bz1lzh9

Timestamp當前系統時間戳(秒):1630468800

MD5(bDqJFiq97bz1lzh91630468800):05d7a50893e22a5c4bb3216ae3396c7c

API對接流程

01上傳語音文件

將語音文件轉為base64編碼,並調用接口上傳語音文件

curl --location --request POST 'https://api.laaffic.com/voice/fileUpload' 
--header 'Content-Type: application/json;charset=UTF-8' 
--header 'Sign: 621862bfd0a7140dbb8fcbefe333fe9a' 
--header 'Timestamp: 1765944162' 
--header 'Api-Key: SQLHdsQFe0Gk8ckwJZqcwxfuYRm0Qu0o' 
--data-raw '{
    "fileName":"11-24.mp3",
    "file":"base64編碼的文件內容"
}'

02創建IVR群呼任務

根據需求,可參考特色功能,調用IVR群呼任務接口進行相關參數傳遞。

功能 參數 參數值 備註
轉接坐席,人工客服接聽 toSeat 1 需配置相關坐席
通話成功/失敗/按鍵反饋/響鈴成功,觸發掛機短信 hangUpSms 1 需商務配置短信應用
文本轉語音,可在文本中插入變量,例如用戶名/號碼 source 3 需配合其他參數使用
定時呼叫功能 sendTime 定時呼叫時間(立即呼叫則傳null)  
任務重呼,可選擇失敗重呼或全部重呼 recallFlow 是否重呼,需要重呼時設置,recallFlow為空時則不開啟重呼 需在請求中配置重呼相關細節
curl --location 'https://api.laaffic.com/voice/group/call/send' 
--header 'Content-Type: application/json;charset=UTF-8' 
--header 'Sign: 954169507790e95d2ffe2c19636a9f4b' 
--header 'Timestamp: 1761552496' 
--header 'Api-Key: Lh7vkyKSv0kTb5KvSPNdF7M67QZMvt2o' 
--data '{
    "appId":"cER2Ev2w",  //語音應用ID
    "taskName":"20251024123", //任務名
    "source":1,//文件來源(1-已上傳文件,2-重新上傳語音文件,3-文本轉語音)
    "voiceFileId":"12025073082f4b0d63ac5400a8320853c67341456.m4a",//語音文件ID
    "lan": "EN", //語言
    "loopCount":1,//循環播放次數1
    "maxCalls":40, //最大響鈴時長40s
    "hangUpSms":1,//推送掛機短信
    "smsAppId":"cF9u6UmT", //短信應用ID
    "smsContent": "Attention! Your loan of $1,200 is overdue. Please settle the payment by Aug 15 via  ${text1}.", //短信內容
    "feedbackPush":1, //按鍵反饋推送掛機短信
    "feedbackValue":6, //用戶按鍵6推送短信
    "successPushTime":10, //通話成功10s後推送短信,
    "failedPush":1, //通話失敗推送短信
    "numberInfoList":[{
        "calleeNumber":"9113000000001",//被叫號碼
        "text1":"https://itniotech.cn/api/voice/callSend/"   //被叫信息(作為變量插入smsContent的${text1}中)
    }
    ,{
        "calleeNumber":"9113000000002",//被叫號碼
        "text1":"https://itniotech.cn/api/voice/callSend/"   //被叫信息(作為變量插入smsContent中的${text1}.)  
    }
    ]
}
'

註釋:numberInfoList中寫入所有被叫號碼及被叫信息,calleeNumber代表被叫號碼、text1代表被叫信息,可作為變量插入短信內容smsContent中。

03狀態報告推送

當用戶在賬戶設置-語音應用管理頁面,配置了http推送地址後,平台會將http-api接入的語音,狀態報告主動推送給用戶配置地址。可登錄客戶端設置,具體位置如圖所示

图片

參考信息

常見錯誤碼速查

以下是幾個常見錯誤碼原因和處理方式,全局可看 全局狀態碼

Status Reason Description
-1 Authentication error 檢查API Key、API Secret和appId的參數值
-18 Port program unusual 檢查請求格式,請求body是否是json格式

Telegram
WhatsApp
諮詢

點擊此處開啟人工服務