普通語音群呼任務創建

POST

https://api.laaffic.com/v3/voice/group/call/send

普通語音群呼任務創建。
 
請求參數
參數 説明 是否必填 類型
appId 應用id String
displayNum 顯示號碼0-20比特數位,允許為空 String
taskName 任務名長度2-64,不可重複 String
numberInfoList 被叫號碼,最大20w個手機號,多個手機號以逗號隔開,每個手機號碼為:國碼+手機號組成的6-18位數。 List<Object>
calleeNumber 被叫號碼,國碼+手機號組成的6-18比特數位 String
text1 被叫資訊:Text1。可用於替換掛機簡訊範本中的變數${text1},如果掛機簡訊範本中有${text1}時該參數傳值不能為null,欄位長度不超過30字串否則將截取 String
text2 被叫資訊:Text2。可用於替換掛機簡訊範本中的變數${text2},如果掛機簡訊範本中有${text2}時該參數傳值不能為null,欄位長度不超過30字串否則將截取 String
text3 被叫資訊: Text3。可用於替換掛機簡訊範本中的變數${text3},如果掛機簡訊範本中有${text3}時該參數傳值不能為null,欄位長度不超過30字串否則將截取 String
text4 被叫資訊:Text4。可用於替換掛機簡訊範本中的變數${text4},如果掛機簡訊範本中有${text4}時該參數傳值不能為null,欄位長度不超過30字串否則將截取 String
text5 被叫資訊:Text5。可用於替換掛機簡訊範本中的變數${text5},如果掛機簡訊範本中有${text5}時該參數傳值不能為null,欄位長度不超過30字串否則將截取 String
text6 被叫資訊:Text6。可用於替換掛機簡訊範本中的變數${text6},如果掛機簡訊範本中有${text6}時該參數傳值不能為null,欄位長度不超過30字串否則將截取 String
text7 被叫資訊:Text7。可用於替換掛機簡訊範本中的變數${text7},如果掛機簡訊範本中有${text7}時該參數傳值不能為null,欄位長度不超過30字串否則將截取 String
text8 被叫資訊:Text8。可用於替換掛機簡訊範本中的變數${text8},如果掛機簡訊範本中有${text8}時該參數傳值不能為null,欄位長度不超過30字串否則將截取 String
text9 被叫資訊:Text9。可用於替換掛機簡訊範本中的變數${text9},如果掛機簡訊範本中有${text9}時該參數傳值不能為null,欄位長度不超過30字串否則將截取 String
text10 被叫資訊:Text10。可用於替換掛機簡訊範本中的變數${text10},如果掛機簡訊範本中有${text10}時該參數傳值不能為null,欄位長度不超過30字串否則將截取 String
source 檔案來源(1-已上傳文件,2-重新上傳語音檔案,3-文字轉語音) Integer
voiceFileId 語音檔案ID 當source=1時必填 String
uploadName 上傳文件名稱,長度5-32字元 當source=2時必填 String
baseFile base64檔案流 當source=2時必填 String
text 檔案內容:tts文字最大1000 當source=3時必填 String
lan 語種,語種詳細內容請查詢表格 source=3,必填 String
speakingRate 語速:0.25 - 4倍 Double
ssmlGender 音色:1 男 2女。允許為空,存在多種音色時系統預設使用女聲 Integer
accent 口音,可配置語種口音,如英語[美國口音]、英語[印度口音] 等,口音詳細內容請查詢表格 String
sendTime 定時呼叫時間(立即呼叫則傳null) LocalDateTime
loopCount 迴圈播報次數:默認1次最大9次 Integer
maxCalls 最長通話時長,接通後n秒強制掛斷最大999秒 Integer
hangUpSms 觸發掛機簡訊0-否,1-是 Integer
smsAppId 簡訊應用ID 當hangUpSms=1時必填 String
smsContent 掛機簡訊簡訊範本,最大1000字元。支持變數替換功能,變數${text1}-${text10} 當hangUpSms=1時必填 String
senderId 發送者ID最大32字元 String
feedbackPush 按鍵迴響推送簡訊:0-否,1-是 hangUpSms=1,(feedbackPush,successPush,failedPush,ringPush)必填有一個傳值為1 Integer
feedbackValue 按鍵迴響值:0-9 當feedbackPush=1時必填 String
successPush 通話成功推送送簡訊:0-否,1-是 hangUpSms=1,(feedbackPush,successPush,failedPush,ringPush)必填有一個傳值為1 Integer
successPushTime 通話成功後多少秒推送簡訊最少0s最大9999 當successPush=1時必填 Integer
failedPush 通話失敗推送送簡訊:0-否,1-是 hangUpSms=1,(feedbackPush,successPush,failedPush,ringPush)必填有一個傳值為1 Integer
ringPush 響鈴成功推送送簡訊:0-否,1-是 hangUpSms=1,(feedbackPush,successPush,failedPush,ringPush)必填有一個傳值為1 Integer
toSeat 是否轉坐席:0-否,1-是 Integer
sipGroupId 坐席組id 當toSeat=1時必填 Integer
outboundControl 外呼控制器,1-比例式外呼 當toSeat=1時必填 Integer
calloutRate 外呼倍率,最多1-100 當toSeat=1時必填 Integer
toSeatType 轉坐席條件,1群呼結束後轉接,2根據按鍵迴響轉接 當toSeat=1時必填 Integer
toSeatKey 轉接按鍵 當toSeat=1並且toSeatType=2時必填 Integer
allowSendTime 可發送時間段最多添加3個 List
strTime 開始時間HH:SS String
endTime 結束時間HH:SS String
maxRingingTime 最大響鈴時長,預設60,可輸入20-120秒 Integer
delayPlay 延遲播放,預設0,可輸入0-999秒 Integer
delayHangup 延遲掛斷,預設0,可輸入0-999秒 Integer
delayTransfer 延遲轉接,單位秒。需轉坐席且按鍵轉接時參數生效 當toSeat=1且toSeatType=2時參數生效 Integer
recallFlow 是否重呼,需要重呼時設置,recallFlow為空時則不開啟重呼 Object
recallInterval 重呼間隔,單位分鐘,可輸入1-1440分鐘 Int
recallNum 重呼次數,可輸入1-10 Int
recallType 重呼類型,每次重呼都基於上次任務結果進行重呼,0-全部重呼,1-失敗重呼 Int
nodeList 自動重呼節點,當為空時,自動重呼將基於當前創建的任務配置進行重呼,您也可以進行個性化設置,只是如果需要個性化設置時數組節點數量需要與【重呼次數】保持一致 Array
source 文件來源(1-已上傳文件,2-重新上傳語音文件,3-文字轉語音) Int
voiceFileId 語音檔案ID source=1必填 String
uploadName 上傳檔案名稱,長度5-32字元 source=2必填 String
baseFile base64文件流 source=2必填 String
text 文件內容:tts文本最大1000 source=3 必填 String
lan 語種,語種詳細內容請查詢表格 source=3 必填 String
speakingRate 語速:0.25 - 4倍 Double
ssmlGender 音色:1 男 2女。允許為空,存在多種音色時系統預設使用女聲 Int
accent 口音,可配置語種口音,如英語[美國口音]、英語[印度口音] 等,口音詳細內容請查詢表格 Int
hangUpSms 觸發掛機簡訊 0-否,1-是 Int
smsAppId 簡訊應用ID hangUpSms=1,必填 String
smsContent 掛機簡訊簡訊模板,最大1000字元。支援變數替換功能,變數${text1}-${text10} hangUpSms=1,必填 String
senderId 發送者ID,最大32字元 String
feedbackPush 按鍵回饋推送簡訊: 0-否,1-是 hangUpSms=1,(feedbackPush,successPush,failedPush,ringPush)必填有一個傳值為1。支援多選,至少選擇其中一個 Int
feedbackValue 按鍵回饋值:0-9 feedbackPush =1,必填 String
successPush 通話成功推送送簡訊: 0-否,1-是 hangUpSms=1,(feedbackPush,successPush,failedPush,ringPush)必填有一個傳值為1。支援多選,至少選擇其中一個 Int
successPushTime 通話成功後多少秒推送短信,最少1s,最大9999s successPush=1,必填 Int
failedPush 通話失敗推送送簡訊: 0-否, 1-是 hangUpSms=1,(feedbackPush,successPush,failedPush,ringPush)必填有一個傳值為1。支援多選,至少選擇其中一個 Int
ringPush 響鈴成功推送送簡訊: 0-否, 1-是 hangUpSms=1,(feedbackPush,successPush,failedPush,ringPush)必填有一個傳值為1 Int
toSeat 是否轉坐席:0-否,1-是 Int
sipGroupId 坐席組id 當toSeat=1時必填 Int
outboundControl 外呼控制器,1-比例式外呼 當toSeat=1時必填 Int
calloutRate 外呼倍率,最多1-100 當toSeat=1時必填 Int
toSeatType 轉坐席條件,1群呼結束後轉接,2根據按鍵回饋轉接 當toSeat=1時必填 Int
toSeatKey 轉接按鍵 當toSeat=1且toSeatType=2時必填 String
delayTransfer 延遲轉接,單位秒。需轉坐席且按鍵轉接時參數生效 當toSeat=1且toSeatType=2時參數生效 Int
 
請求示例
Request URL:
    https://api.laaffic.com/v3/voice/group/call/send
Request Method:
    POST
Request Headers:
    Content-Type: application/json;charset=UTF-8
    Sign: 05d7a50893e22a5c4bb3216ae3396c7c
    Timestamp: 1630468800
    Api-Key: bDqJFiq9
Request Body:
{
    "appId": "iaAJ6COV",
    "taskName": "2024-06-03 10:42:0511",
    "source": 3,
    "loopCount": 1,
    "maxCalls": 40,
    "hangUpSms": 1,
    "toSeat": 1,
    "sipGroupId": 1000019,
    "outboundControl": 1,
    "calloutRate": 1,
    "toSeatKey": 0,
    "toSeatType": 2,
    "numberInfoList":[{
        "calleeNumber":"8613000000001",
        "text1":"tom",
        "text2":"$12451.12",
        "text3":"2025-3-21"
    }],
    "sendTime": "2024-06-21 00:00:00",
    "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,
    "allowSendTime": [
        {
            "strTime": "18:28",
            "endTime": "19:28"
        }
    ],
    "delayPlay":0,
    "delayHangup":0,
    "delayTransfer":30,
    "recallFlow":{
        "recallInterval":15,
        "recallNum":2,
        "recallType":1,
        "nodeList":[
            {
                "source":"1",
                "voiceFileId":"1202508052abe59ba0b6948a5b41c93d9ad844493.mp3",
                "toSeat":1,
                "sipGroupId":"1000007",
                "outboundControl":1,
                "calloutRate":10,
                "toSeatType":"2",
                "toSeatKey":"3",
                "delayTransfer":888
            },
            {
                "source":3,
                "text":"Halo, apa yang bisa saya bantu dan saya bisa memesan layanan antar", 
                "lan": "ID",
                "speakingRate":"1.5",
                "ssmlGender":"1",
                "accent":"62",
                "hangUpSms":"1",
                "smsAppId":"oTOiEpA4",
                "smsContent":"測試自動重呼掛機簡訊",
                "senderId":"測試自動重呼掛機簡訊123456",
                "feedbackPush":1,
                "feedbackValue":9,
                "successPush":0,
                "successPushTime":3,
                "failedPush":0,
                "ringPush":0
            }
        ]
    }
}
 
響應參數
參數 説明 類型
code 狀態碼,0成功,其他失敗參見接口響應碼。 String
msg 失敗原因說明 String
data 該方法返回keyId Integer
 
響應示例
{
    "code":"0",
    "msg":"success",
    "data":123123
}
 
響應狀態碼
狀態碼 説明
0 成功
-1 帳號認證異常
-2 ip限制
-10 餘額不足
-16 時間戳過期
-18 系統異常
-20 數據已存在
-21 數據校驗異常
-22 參數異常
-23 數據上限
-24 數據不存在
-26 獲取費率失敗
-35 沒有被叫號碼
-37 您提交的群呼任務超過最大併發任務限制,請完成任務後再提交!
-38 轉換文字和語言類型必填
-39 獲取文字語言類型失敗
-41 任務名稱已經存在
-46 長文字轉語音每天最大5次,您已使用完,請聯系商務處理
-53 掛機簡訊觸發條件必須有一個

Telegram
WhatsApp
諮詢

點擊此處開啟人工服務