首页 > API中心 > IVR群呼 > 文档指引

Brand

消息

语音

 

创建任务

POST

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

语音群呼任务创建。
 
请求参数
 

基本信息

任务

参数 说明 是否必填 类型
appId 应用id 是 String
displayNum 显示号码，0-20位数字，允许为空 否 String
taskName 任务名，长度2-64，不可重复 是 String
 

被叫号码

参数 说明 是否必填 类型
numberInfoList 号码详情，最大10万条数据 是 List<Object>
calleeNumber 被叫号码，国码+手机号组成的7-15位数字 是 String
text1 被叫信息：Text1。可用于替换文本变量模板中的变量NULL，如果文本变量模板中有NULL时该参数传值不能为null，字段长度不超过30字符串否则将截取 否 String
text2 被叫信息：Text2。可用于替换文本变量模板中的变量NULL，如果文本变量模板中有NULL时该参数传值不能为null，字段长度不超过30字符串否则将截取 否 String
text3 被叫信息：text3。可用于替换文本变量模板中的变量NULL，如果文本变量模板中有NULL时该参数传值不能为null，字段长度不超过30字符串否则将截取 否 String
text4 被叫信息：Text4。可用于替换文本变量模板中的变量NULL，如果文本变量模板中有NULL时该参数传值不能为null，字段长度不超过30字符串否则将截取 否 String
text5 被叫信息：Text5。可用于替换文本变量模板中的变量NULL，如果文本变量模板中有NULL时该参数传值不能为null，字段长度不超过30字符串否则将截取 否 String
text6 被叫信息：Text6。可用于替换文本变量模板中的变量NULL，如果文本变量模板中有NULL时该参数传值不能为null，字段长度不超过30字符串否则将截取 否 String
text7 被叫信息：Text7。可用于替换文本变量模板中的变量NULL，如果文本变量模板中有NULL时该参数传值不能为null，字段长度不超过30字符串否则将截取 否 String
text8 被叫信息：Text8。可用于替换文本变量模板中的变量NULL，如果文本变量模板中有NULL时该参数传值不能为null，字段长度不超过30字符串否则将截取 否 String
text9 被叫信息：Text9。可用于替换文本变量模板中的变量NULL，如果文本变量模板中有NULL时该参数传值不能为null，字段长度不超过30字符串否则将截取 否 String
text10 被叫信息：Text10。可用于替换文本变量模板中的变量NULL，如果文本变量模板中有NULL时该参数传值不能为null，字段长度不超过30字符串否则将截取 否 String
 

语音内容

参数 说明 是否必填 类型
source 文件来源（1-已上传文件，2-重新上传语音文件，3-文本转语音） 是 Integer
voiceFileId 语音文件ID source=1，必填 String
uploadName 上传文件名称，长度5-32字符 source=2，必填 String
baseFile base64文件流 source=2，必填 String
speakingRate 语速：0.25 - 4倍 否 Double
text 文件内容：tts文本，最大2048 source=3，必填 String
timbreCode 文本转语音，音色编码 source=3，必填 String
emotionStyleCode 文本转语音，情感风格编码（FRIENDLY-亲切友好，CONVERSATIONAL-正常对话，CALM-平静严肃，ANGRY-愤怒），仅部分音色支持。 source=3，必填 String
ttsBgmType 文本转语音，背景音类型编码（office-办公室环境音，telemarketing-电销环境音） source=3，必填 String
ttsBgmVolume 文本转语音，背景音音量，范围0.0~1.0，默认1.0。需配合 ttsBgmType 使用 source=3，必填 Double
 

设置任务

基础参数

参数 说明 是否必填 类型
delayPlay 延迟播放，默认0，可输入0-999秒 否 Integer
delayHangup 延迟挂断，默认0，可输入0-999秒 否 Integer
loopCount 循环播报次数：默认1次，最大9次 是 Integer
maxCalls 最长通话时长，接通后n秒强制挂断，最大999秒 是 Integer
maxRingingTime 最大响铃时长，默认60，可输入20-120秒 否 Integer
 

呼叫时间

参数 说明 是否必填 类型
sendTime 定时呼叫时间（立即呼叫则传null） 否 LocalDateTime
allowSendTime 可发送时间段最多添加3个 否 List
strTime 开始时间 HH:SS 否 String
endTime 结束时间 HH:SS 否 String
deadline 任务最晚执行时间 yyyy-MM-dd HH:mm:ss 否 LocalDateTime
 

挂机短信

参数 说明 是否必填 类型
hangUpSms 触发文本变量 0-否，1-是 否 Integer
smsAppId 短信应用ID hangUpSms=1，必填 String
smsContent 文本变量短信模板，最大1000字符。支持变量替换功能，变量NULL-NULL 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
delayTransfer 延迟转接，单位秒。需转坐席且按键转接时参数生效 当toSeat=1并且toSeatType=2时参数生效 Integer
 

自动重呼

需要自动重呼时设置以下参数，为空时则不开启自动重呼。

基础参数（recallFlow）

参数 说明 是否必填 类型
recallFlow 是否重呼，需要重呼时设置，recallFlow为空时则不开启重呼 否 Object
recallInterval 重呼间隔，单位分钟，可输入1-1440分钟 是 Int
recallNum 重呼次数，可输入1-10 是 Int
recallType 重呼类型，每次重呼都基于上次任务结果进行重呼，0-全部重呼，1-失败重呼 是 Int
 

节点参数（nodeList）

自动重呼节点，当为空时，自动重呼将基于当前创建的任务配置进行重呼，您也可以进行个性化设置，只是如果需要个性化设置时数组节点数量需要与【重呼次数】保持一致

参数 说明 是否必填 类型
nodeList 自动重呼节点，当为空时，自动重呼将基于当前创建的任务配置进行重呼，您也可以进行个性化设置，只是如果需要个性化设置时数组节点数量需要与【重呼次数】保持一致 否 Array
source 文件来源（1-已上传文件，2-重新上传语音文件，3-文本转语音） 是 Int
voiceFileId 语音文件ID source=1必填 String
uploadName 上传文件名称，长度5-32字符 source=2必填 String
baseFile base64文件流 source=2必填 String
speakingRate 语速：0.25 - 4倍 否 Double
timbreCode 文本转语音，音色编码 source=3，必填 String
emotionStyleCode 文本转语音，情感风格编码（FRIENDLY-亲切友好，CONVERSATIONAL-正常对话，CALM-平静严肃，ANGRY-愤怒），仅部分音色支持。 source=3，必填 String
ttsBgmType 文本转语音，背景音类型编码（office-办公室环境音，telemarketing-电销环境音） source=3，必填 String
ttsBgmVolume 文本转语音，背景音音量，范围0.0~1.0，默认1.0。需配合 ttsBgmType 使用 source=3，必填 Double
text 文件内容：tts文本 最大 2048 source=3 必填 String
hangUpSms 触发挂机短信 0-否，1-是 是 Int
smsAppId 短信应用ID hangUpSms=1，必填 String
smsContent 挂机短信短信模板，最大1000字符。支持变量替换功能，变量NULL-NULL 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,
    "timbreCode": "b7b181d01542479d8ace3637ab7cb35d",
    "emotionStyleCode": "CONVERSATIONAL",
    "speakingRate": 1.0,
    "ttsBgmType": "office",
    "ttsBgmVolume": 1.0,
    "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", 
                "timbreCode": "b7b181d01542479d8ace3637ab7cb35d",
                "emotionStyleCode": "CONVERSATIONAL",
                "speakingRate": 1.0,
                "ttsBgmType": "office",
                "ttsBgmVolume": 1.0,
                "hangUpSms":"1",
                "smsAppId":"oTOiEpA4",
                "smsContent":"测试自动重呼挂机短信",
                "senderId":"测试自动重呼挂机短信123456",
                "feedbackPush":1,
                "feedbackValue":9,
                "successPush":0,
                "successPushTime":3,
                "failedPush":0,
                "ringPush":0
            }
        ]
    }
   "deadline":"2026-04-15 00:00:00"
}
 
响应参数
参数 说明 类型
code 状态码，0成功，其他失败参见响应状态码说明 String
msg 失败原因说明 String
data 该方法返回 keyId Integer
 
响应示例
{
    "code":"0",
    "msg":"success",
    "data":123123
}
 
响应状态码
code 状态说明
0 成功
-1 账号认证异常
-2 ip限制
-10 余额不足
-16 时间戳过期
-18 系统异常
-20 数据已存在
-21 数据校验异常
-22 参数异常
-23 数据上限
-24 数据不存在
-26 获取费率失败
-35 没有被叫号码
-37 您提交的群呼任务超过最大并发任务限制，请完成任务后再提交！
-38 转换文本和语言类型必填
-39 获取文本语言类型失败
-41 任务名称已经存在
-46 长文本转语音每天最大5次，您已使用完，请联系商务处理
-53 文本变量触发条件必须有一个

此页面的内容有帮助吗？

对接有疑问？联络我们的技术支援

LAAFFIC API 专属 TG 技术对接频道，即时回应您的需求

前往Telegram联系
Telegram
WhatsApp
咨询

点击此处开启人工服务