语音发送

名称	说明
接口名称	语音通知发送
协议	HTTPS POST
URL	https://api.253.com/open/voice/v2/notify/batch-voice-notify
编码格式	UTF-8
Content-Type	application/json
返回类型	application/json

请求头参数

请求头参数以及生成规则，可参考文档中的通用请求头：通用请求头

请求参数

请求参数 Body 以 application/json（JSON Body）方式提交

参数名	参数类型	是否必传	说明
mobile	String	是	被叫号码，模版无变量多个则以英文半角分号“;”分割；模板带变量，多个号码以英文分号“;”分割，号码和变量以英文逗号“,”隔开，多个变量以竖线“\|”隔开，如 130XXXXXXXX,123\|456;186XXXXXXXX,321\|654 （批量号码上限10000个）。如果带短信变量，则用“#”隔开,多个短信变量以竖线“\|”隔开，如，130XXXXXXXX#123\|456;186XXXXXXXX#321\|654，如果语音变量和短信变量都有，则：130XXXXXXXX,123\|456#321\|654;150XXXXXXXX,123\|456#321\|654
templateId	String	是	文字模版 Id，官网控制台创建后产生，且已审核通过
billUrl	String	否	话单推送回调地址（最大长度250）
transData	String	否	透传数据(话单推送回调时返回最大长度50)
displayNum	String	否	主叫号码，由运营提供，未提供的则不需要传
isNotifyFileId	String	否	模版类型，0:TTS模版，1:录音文件模版，默认为0
smsHangupStatus	String	否	挂机短信开启标识 0：关闭，1：开启，默认：关闭
smsSendType	int	否	挂机短信发送方式：0:接通后发送，1:全部群发，2:未接通发送，3:按接通时长发送，默认:0
smsSendLimit	int	否	当挂机短信方式为3时必填，单位秒，输入时间规则为大于等于x后发送挂机短信（整数输入大于等于1）
smsTemplateId	String	否	挂机短信模板id
sendType	Integer	否	任务发送类型 1-定时任务2-即时任务,不传为即时任务
taskStartTime	String	否	任务开始时间，yyyyMMddHHmmss，eg:20200902170000
taskEndTime	String	否	任务结束时间，yyyyMMddHHmmss，eg:20200902235959
maxRecallCount	Integer	否	最大重拨次数，只能0或1，0不重拨，默认：1 重拨1次
recallInterval	Integer	是	重拨间隔时长（分钟），只能1-2880，默认值60，最大重拨次数大于0时必传(注意：recallInterval的“llI”分别是小写的LL和大写的i
noConnected	boolean	否	重拨策略：被叫无法接通,true:重拨;false:不重拨,默认值:true
noAnswer	boolean	否	重拨策略：被叫无人接听,true:重拨;false:不重拨,默认值:true
taskName	String	否	任务名称
fmsStatus	String	否	闪信状态：0关闭，1开启
fmsTemplateId	String	否	闪信模版Id

请求示例

{
  "mobile": "130XXXXXXXX;186XXXXXXXX",
  "templateId": "123",
  "sendType": 2,
  "recallInterval": 60,
  "mobileType": 0,
  "smsHangupStatus": "1",
  "smsTemplateId": "4123***1",
  "smsSendType": 0
}

返回参数

参数名	数据类型	参数说明
code	String	返回状态码，仅使用 OM 标准 code 码，详细列表请参考：统一错误码
msg	String	响应消息
requestId	String	请求ID，由网关生成，用于问题排查
data	Object	响应数据，失败时为 null
data>>callId	String	呼叫唯一标识Id

返回数据示例（成功）

{
  "code": "000000",
  "msg": "success",
  "requestId": "017839319530001xxxxx",
  "data": {
    "callId": "YYYX931******64224"
  }
}

产品中心

热门搜索

中国站

国际站

语音发送

语音发送

请求头参数

请求参数

请求示例

返回参数

返回数据示例（成功）