API中心/语音群呼任务创建
 

语音群呼任务创建

POST

https://api.itniotech.com/voice/group/call/send

语音群呼任务创建。
 
请求参数
参数 说明 是否必填 类型
appId 应用id 是 String
displayNum 显示号码，0-20位数字，允许为空 否 String
taskName 任务名，长度2-64，不可重复 是 String
numberList 被叫号码，最大20w个手机号，多个手机号以逗号隔开，每个手机号为：国码+手机号组成的7-15位数字。 是 List<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 转换语言。 语言代码 [ 越南语: VN, 英语: EN, 日语: JP， 阿拉伯语: ARB， 德国：DE， 印地语：IN， 意大利：IT， 韩国：KR， 俄罗斯：RU， 西班牙：ES， 葡萄牙：PT， 印尼语：IDN， 孟加拉：BD 泰语：TH ] source=3，必填 String
sendTime 定时呼叫时间（立即呼叫则传null） 否 LocalDateTime
loopCount 循环播报次数：默认1次，最大9次 是 Integer
maxCalls 最长通话时长，接通后n秒强制挂断，最大999秒 是 Integer
hangUpSms 触发挂机短信 0-否，1-是 否 Integer
smsAppId 短信应用ID hangUpSms=1，必填 String
smsContent 短信内容，最大1000字符 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，最大9999s 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
 
请求示例
Request URL:
    https://api.itniotech.com/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,
    "numberList":["8613242926514"],
    "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",
    "displayNum": "1008122211",
    "maxRingingTime": 60,
    "allowSendTime": [
        {
            "strTime": "18:28",
            "endTime": "19:28"
        }
    ]
}
 
响应参数
参数 说明 类型
code 状态码，0成功，其他失败参见响应状态码说明 String
msg 失败原因说明 String
data 该方法返回 keyId Integer
 
响应示例
{
    "code":"0",
    "msg":"success",
    "data":123123
}
 
响应状态码
status 状态说明
0 成功
-1 账号认证异常
-2 ip限制
-10 余额不足
-16 时间戳过期
-18 系统异常
-20 数据已存在
-21 数据校验异常
-22 参数异常
-23 数据上限
-24 数据不存在
-26 获取费率失败
-35 没有被叫号码
-37 您提交的群呼任务超过最大并发任务限制，请完成任务后再提交！
-38 转换文本和语言类型必填
-39 获取文本语言类型失败
-41 任务名称已经存在
-46 长文本转语音每天最大5次，您已使用完，请联系商务处理
-53 挂机短信触发条件必须有一个
语音全局状态码
查询群呼任务列表

意见反馈

文档内容是否对您有帮助?