所有文档

短信服务

语音服务

个人信息核验

运营商信息核验

银行信息核验

企业信息核验

车辆出行

应用开发

文字识别

数字权益

企业服务

基础知识

开发参考

文档中心 > 短信服务 > 营销短信

营销短信

产品详情

短信营销批量提交接口

1、接口描述

请求支持 POST 方法，字符编码为 utf-8。

2、请求地址

https://api.ihuyi.com/sms-yx/v1/batchSend

3、请求头说明

参数名称	参数值描述	示例	类型	必填
Content-Type	内容类型，固定值	application/json	string	是

4、请求参数说明

参数名称	参数值描述	示例	类型	必填
api_id	APIID(用户中心【文本短信】-【会员营销短信】-【产品总览】查看)	sms-yx-xxxxxxxx	string	是
signature	请求验证加密签名(非短信签名)；签名生成方式：仅公共参数以ASCII码从小到大排序值，key=value，多值以“&”隔开，拼接之后md5 32位小写；如：md5(api_id=xxxx&api_key=xxxx&request_id=xxxxxxxx&timestamp=xxxxxxx) APIKEY(用户中心【文本短信】-【会员营销短信】-【产品总览】查看) 2、动态密码(生成动态密码方式请看该文档末尾的说明)	xxxxxxxxx	string	是
timestamp	东八时区;10位时间戳，时间允许相差±60S	1623643787	int	是
request_id	请求方请求ID，建议使用唯一ID，比如使用uuid；我方系统会2小时内去重验证处理，防止网络重复攻击；	xxxxxxxxxxxx	string	是
product_id	产品ID	1001	int	是
phone	手机号数组(最多1万个号码)	["18800000000","18800000001"]	array	是
sign_name	短信签名(template_id未填写则必填)	xxxxxxxx	string	是
content	template_id为空时必填；短信内容,如:您的短信群发功能已开通,请在3个工作日之内至平台进行企业认证! 短信内容和模板ID必须传入1个;当短信内容和模板ID都传入时,传入内容生效,模板ID属性失效;	尊敬的会员您好：${name}，您的订单号是：${order_no}，拒收请回复R	string	是
template_id	模板ID(内容为空则必填)	1	int	否
template_var	选择模板时,且模板是变量模板时,可以传入变量值,需要传入json格式;	{"${name}":"张三","${order_no}":"202009041156181103"}	object	否
send_time	定时发送时间	2020-08-26 16:08:14	string	否

5、响应参数

参数名称	参数值描述	示例	类型	必返
code	状态码，OK表示发送成功，其他则是错误	OK\|ParamError	string	是
message	消息内容	请求成功\|参数错误	string	是
task_id	下发批次ID，推送回执相关会用作关联	123\|0	string	否

6、响应状态码说明

code	msg
OK	请求成功
ParamError	参数错误
AccessKeyIDNotExist	AccessKeyID不存在
UserIDNotExist	用户ID不存在
AmountError	数额错误(超出许可范围)
TimestampError	时间错误(超出许可范围)
ProductIDNotExist	产品ID不存在
TypeNotExist	类型不存在
RemarkError	备注错误
RequestIDExisted	请求ID已存在
NonceExisted	随机数已存在
SingError	签名错误
SignExpired	签名过期
BalanceNotEnough	余额不足
PackIDExisted	资源包ID已存在
SystemError	系统异常
InputDataInvalid	请求参数异常

7、GET传参示例

不支持

8、响应示例

示例（成功）

{    "code":
            "OK"
        ,        "message":
            "请求成功"
        ,        "task_id":
            "123"
            }

示例（失败）

{"code":"ParamError",}

9、PHP生成动态密码方式代码示例

$api_id = 'sms-yx-xxxxxxxx';
$api_key = 'xxxxxxxxxxxxxxxx'; //可登录用户中心查看
$request_id = 'xxxxxxxxxxxx';
$timestamp = '1623643787';
$password=md5('api_id='.$api_id.'&api_key='.$api_key.'&request_id='.$request_id.'&timestamp='.$timestamp);
$password=md5('api_id=sms-yx-xxxxxxxx&api_key=xxxxxxxxxxxxxxxx&request_id=xxxxxxxxxxxx&timestamp=1623643787');

//注意：所有字符编码统一为UTF-8

营销短信

短信营销批量提交接口

1、接口描述

2、请求地址

3、请求头说明

4、请求参数说明

5、响应参数

6、响应状态码说明

7、GET传参示例

8、响应示例

9、PHP生成动态密码方式代码示例

10、代码示例

免费体验

填写验证码后，点击“开通体验账户”自动开通体验账户。