发起呼叫任务
发起呼叫任务
curl -X POST "https://api.example.com/open/v1/voice/notify/batch" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
"bulkId": "order-notify-20261110-001",
"messages": [
{
"taskName": "Shipping Notification - Example",
"scheduling": {
"type": "IMMEDIATE"
},
"templateId": "Tpl_0001",
"destinations": [
{
"to": "<PHONE>",
"variables": [
"John",
"A12345"
]
}
]
}
]
}'业务包络:000000 受理成功;data 含 bulkId/callId/acceptedCount;失败码见平台六位码制
{
"code": "000000",
"data": {
"bulkId": "string",
"callId": "string",
"acceptedCount": 0
},
"message": "success"
}来自当前规范的响应示例,不是真实请求结果。
向一个或多个被叫发起语音通知呼叫(TTS 模板播报)。鉴权 Bearer;呼叫国家由模板推导,无需传国家编码;定时时间用 ISO 8601 含时区;错误码为平台六位码制。发起呼叫会真实外呼并产生费用。
使用 InnoPaaS AppKey 作为 Bearer Token。可在 Console 的 API 密钥页面创建或管理密钥。 查看密钥指南
授权
Authorizationstring<bearer>必填请求主体
application/jsonbulkIdstring可选客户自定义请求 ID,响应回显用于对账(非幂等键)
64messagesarray<object>必填消息列表,当前单次仅支持一条
展开子字段
fromstring可选主叫号码(E.164);不传按国家默认路由,传入须为已绑定主叫
retryobject可选重拨策略;缺省 1 次 / 60 分钟 / 未接通与未应答均重拨
展开子字段
maxCountinteger可选1最小值0最大值3noAnswerboolean可选无人接听时是否重拨,默认 true
truenoConnectedboolean可选无法接通时是否重拨,默认 true
trueintervalMinutesinteger可选60最小值1最大值360taskNamestring可选任务名称;缺省服务端生成
50hangupSmsobject可选挂机短信;对象存在即开启,不需要时省略
展开子字段
sendTypestring可选ON_CONNECTED 接通后发送(默认);ALL 全部群发;ON_UNANSWERED 未接通发送;BY_DURATION 按接通时长
ON_CONNECTEDtemplateIdstring必填挂机短信模板 ID(开启时必填)
durationLimitSecondsinteger可选接通时长阈值(秒),BY_DURATION 必填
1playTimesinteger可选播放次数;缺省取模板配置(再缺省 1)
1最大值3schedulingobject可选发送调度;缺省立即发送
展开子字段
typestring可选IMMEDIATE 立即(默认);SCHEDULED 定时(起止必填,仅定时允许携带时间)
endTimestring可选定时窗口终点,须晚于 startTime
startTimestring可选定时窗口起点,ISO 8601 含时区;须晚于当前时间;窗口 ≤8 天
templateIdstring必填已审核通过的语音模板 ID;呼叫国家由模板推导
destinationsarray<object>必填被叫目的地列表,1-1000 条
展开子字段
tostring必填被叫号码(E.164 带国家码,6-20 位纯数字)
^\d{6,20}$variablesarray<string>可选模板变量值,按序对应占位符 {1}…{n};无变量模板省略
响应
application/json业务包络:000000 受理成功;data 含 bulkId/callId/acceptedCount;失败码见平台六位码制
codestring可选dataobjectnull可选messagestring可选{
"code": "000000",
"data": {
"bulkId": "string",
"callId": "string",
"acceptedCount": 0
},
"message": "success"
}来自当前规范的响应示例,不是真实请求结果。