请求地址是客户接口程序调用时请求的url地址，采用的是https post 接口，地址是
https://api.hvo.net.cn/sms.aspx 对应UTF-8
https://api.hvo.net.cn/smsGBK.aspx 对应GB2312
https://api.hvo.net.cn/smsJson.aspx 对应UTF-8(返回值为json格式)
https://api.hvo.net.cn/ensms.ashx 对应UTF-8(加密传输,使用json)
入口地址一般不会发生变化，当发生变化的时候，会通知接口用户
| 参数名称 | 含义 | 说明 |
|---|---|---|
| userid | 企业id | 企业ID(不验证) |
| account | 发送用户帐号 | 用户帐号，由系统管理员 |
| password | 发送接口密码 | 用md5加密方式，md5采用32位大写 如abc123加密后为 E99A18C428CB38D5F260853678922E03 |
| mobile | 全部被叫号码 | 短信发送的目的号码.多个号码之间用半角逗号隔开 |
| content | 发送内容 | 短信的内容，内容需要UTF-8编码，提交内容格式：内容+【签名】。签名是公司的名字或者公司项目名称。示例：您的验证码：1439【中联信达】。【】是签名的标识符。请按照正规的格式提交内容测试，请用正规内容下发，最好不要当成是测试，就当是正式使用在给自己的客户发信息，签名字数3-8个字 如果内容里带 # 字符的，需要把内容urlencode一下 |
| sendTime | 定时发送时间 | 为空表示立即发送，定时发送格式 2018-02-02 09:08:10（可选） |
| action | 发送任务命令 | 设置为固定的:send |
| extno | 扩展子号 | 请先询问配置的通道是否支持扩展子号，如果不支持，请填空。子号只能为数字，且最多5位数。（可选） |
例如:
https://api.hvo.net.cn/sms.aspx?action=send&userid=&account=账号&password=密码&mobile=15023239810,13527576163&content=内容&sendTime=&extno=
在接收到客户端发送的http请求后，返回以xml的方式返回处理结果。格式为：
数据示例:
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<returnstatus>status</returnstatus>
<message>message</message>
<remainpoint> remainpoint</remainpoint>
<taskID>taskID</taskID>
<successCounts>successCounts</successCounts>
</returnsms>
返回参数:
| 字段名 | 描述 |
|---|---|
| returnstatus | 成功返回：Success 失败返回：Fail |
| message | 相关的错误描述 |
| remainpoint | 返回余额 |
| taskID | 返回本次任务的序列ID |
| successCounts | 成功短信数：当成功后返回提交成功短信数 |
{
"returnstatus":"Success",
"message":"操作成功",
"remainpoint":"-4",
"taskID":"1504080852350206",
"successCounts":"1"
}
| 参数名称 | 含义 | 说明 |
|---|---|---|
| UserId | 企业id | 数字类型，由供应商提供 |
| Text64 | 编码后的参数 | 详见下解 |
Text64的生成方法:
1.首先构造一个json串（包含发送的具体参数）。
Json的结构如下：
| 属性名称 | 含义 | 说明 |
|---|---|---|
| UserName | 账户名称 | 字符串类型，由供应商提供 |
| Stamp | 时间戳 | 格式为MMddHHmmss误差不超过5分钟。 |
| Secret | 认证密文 | 生成方式 Md5(password+stamp)Md5为标准32位，大写 Password由供应商提供。 Stamp为上面的字段 |
| Moblie | 手机号码 | 多个用英文逗号隔开 |
| Text | 短信内容 | |
| Ext | 扩展号 | （可选项）纯数字组成，如果没有，请留空 |
| SendTime | 定时时间 | （可选项）格式为yyyy-MM-dd HH:mm:ss 非定时请留空 |
示例：
{
"UserName":"test",
"Secret":"2A8D628159B0D4D3D4D58A3EB17F3082",
"Stamp":"0414174715",
"Moblie":"15510331875",
"Text":"我的验证码是：7890。【中联信达】",
"Ext":"",
"SendTime":""
}
2.将json串用utf8转为字节数组。
上边的json转换后的结果：
7B 22 55 73 65 72 4E 61 6D 65 22 3A 22 74 65 73 74 22 2C 22 53 65 63 72 65 74 22 3A 22 32 41 38 44 36 32 38 31 35 39 42 30 44 34 44 33 44 34 44 35 38 41 33 45 42 31 37 46 33 30 38 32 22 2C 22 53 74 61 6D 70 22 3A 22 30 34 31 34 31 37 34 37 31 35 22 2C 22 4D 6F 62 6C 69 65 22 3A 22 31 35 35 31 30 33 33 31 38 37 35 22 2C 22 54 65 78 74 22 3A 22 E6 88 91 E7 9A 84 E9 AA 8C E8 AF 81 E7 A0 81 E6 98 AF EF BC 9A 37 38 39 30 E3 80 82 E3 80 90 E5 A5 A5 E5 88 9B E6 97 B6 E4 BB A3 E3 80 91 22 2C 22 45 78 74 22 3A 22 22 2C 22 53 65 6E 64 54 69 6D 65 22 3A 22 22 7D
3.将字节数组，用des加密。
des使用 CBC模式。Padding为PKCS7。
Key 的生成方式，将Password转为字节数组，取前8位（不足8位，右侧补字节0）
IV与key相同。
上面的字节数组加密后的结果：
Password为test，生成的key为：74 65 73 74 00 00 00 00。
7B 22 55 73 65 72 4E 61 6D 65 22 3A 22 74 65 73 74 22 2C 22 53 65 63 72 65 74 22 3A 22 32 41 38 44 36 32 38 31 35 39 42 30 44 34 44 33 44 34 44 35 38 41 33 45 42 31 37 46 33 30 38 32 22 2C 22 53 74 61 6D 70 22 3A 22 30 34 31 34 31 37 34 37 31 35 22 2C 22 4D 6F 62 6C 69 65 22 3A 22 31 35 35 31 30 33 33 31 38 37 35 22 2C 22 54 65 78 74 22 3A 22 E6 88 91 E7 9A 84 E9 AA 8C E8 AF 81 E7 A0 81 E6 98 AF EF BC 9A 37 38 39 30 E3 80 82 E3 80 90 E5 A5 A5 E5 88 9B E6 97 B6 E4 BB A3 E3 80 91 22 2C 22 45 78 74 22 3A 22 22 2C 22 53 65 6E 64 54 69 6D 65 22 3A 22 22 7D
4.将加密后的字节数组用base64方式转为字符串。即为Text64的值。
上面加密字节生成的结果：
0DqKGm9MWnsFM2wlYEW65VXylBxJGBiuZzP5dTp1ALdK7QaTgx0cR5GftknjiNJBOd46tdJp+6J3OYAoukEBOKlfsExTaFYC7X514PyLC+NrwhDLKYOvFAb7gBo+dqkslvVJklz4qm7/gUHrHAT2d7hEcQxhDMD+Ij8NIy1kvHqU3noZTqjlC1PaaFYy6zifBr5ND+V4UK0xM7scF/avfVKW/0k16qqVzDDJocRkTz0jqvtJYfo1liuI2+h2fRkK
在传输此值时，请使用urlencode
返回结果：
{
"StatusCode":1,
"Description":"操作成功",
"MsgId":"1504141655440332",
"Amount":-11,
"SuccessCounts":1",
"Errors":[]
}
| 参数名称 | 含义 | 说明 |
|---|---|---|
| StatusCode | 发送的代码状态 | 数字类型，1表示成功，其它为失败，参见最后的错误代码表。 |
| Description | 发送说明 | 发送结果状态操作说明 |
| MsgId | 任务ID | 提交短信的任务批次 |
| Amount | 当前余额 | 当前账户的余额 |
| SuccessCounts | 成功的号码数量 | 成功的号码数量 |
| Errors | 错误描述 | 本次发送中，相关的错误描述 |
请求地址
https://api.hvo.net.cn/BatchSms.ashx 对应UTF-8的点对点发送，只支持post方式的提交 （Zip压缩内容）
参数说明
| 参数名称 | 含义 | 说明 |
|---|---|---|
| userid | 企业id | 企业ID(不验证) |
| account | 发送用户帐号 | 用户帐号，由系统管理员 |
| password | 发送接口密码 | 用md5加密方式，md5采用32位大写 如abc123加密后为 E99A18C428CB38D5F260853678922E03 |
| content | 发送内容 | 点对点短信内容： url编码的base64短信内容格式：详见下解 |
| sendTime | 定时发送时间 | 为空表示立即发送，定时发送格式 2018-02-02 09:08:10（可选） |
| extno | 扩展子号 | 请先询问配置的通道是否支持扩展子号，如果不支持，请填空。子号只能为数字，且最多5位数。（可选） |
content值生成方法：
1)每条内容以手机号开头，英文逗号为分隔符，后面跟短信内容，多条内容以\r\n为分隔符
a)手机号+分隔符(,)+内容+结尾标识(\r\n) + 手机号+分隔符(,)+内容+结尾标识(\r\n)
b)例：13800138000,验证码：1234【中联信达】\r\n13800138000,验证码：4567【中联信达】
注：同一批任务中不允许出现重复的手机号码，如果短信内容中有\r\n符号需要进行转义
2)将\r\n组合后的内容进行GZip压缩，将压缩后的byte数组进行base64编码，然后url编码作为content参数
返回值
在接收到客户端发送的http请求后，返回以xml的方式返回处理结果。格式为：
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<returnstatus>status</returnstatus>
<message>message</message>
<remainpoint> remainpoint</remainpoint>
<taskID>taskID</taskID>
<successCounts>successCounts</successCounts>
</returnsms>
返回参数:
| 字段名 | 描述 |
|---|---|
| returnstatus | 成功返回：Success 失败返回：Fail |
| message | 相关的错误描述 |
| remainpoint | 返回余额 |
| taskID | 返回本次任务的序列ID |
| successCounts | 成功短信数：当成功后返回提交成功短信数 |
请求地址是客户接口程序调用时请求的url地址，采用的是https post 接口，地址是
https://api.hvo.net.cn/sms.aspx 对应UTF-8
入口地址一般不会发生变化，当发生变化的时候，会通知接口用户
| 参数名称 | 含义 | 说明 |
|---|---|---|
| userid | 企业id | 企业ID(不验证) |
| account | 发送用户帐号 | 用户帐号，由系统管理员 |
| password | 发送接口密码 | 用md5加密方式，md5采用32位大写 如abc123加密后为 E99A18C428CB38D5F260853678922E03 |
| mobile | 全部被叫号码 | 短信发送的目的号码.多个号码之间用半角逗号隔开 |
| subject | 主题 | 彩信的主题 |
| content | 发送内容 | 彩信内容，tms文件的base64编码。 Tms文件存储规格： 元素1名称（即元素1的文件名，包括文件名扩展名）+一个字符串结束符(ASCII为0)+元素1的二进制内容大小（整形）+元素1的二进制内容+元素2名称（即元素2的文件名，包括文件名扩展名）+一个字符串结束符(ASCII为0)+元素2的二进制内容大小（整形）+元素2的二进制内容+元素3名称（即元素3的文件名，包括文件名扩展名）+一个字符串结束符(ASCII为0)+元素3的二进制内容大小（整形）+元素3的二进制内容+。。。。。。。所有元素以此类推 |
| sendTime | 定时发送时间 | 为空表示立即发送，定时发送格式 2018-02-02 09:08:10（可选） |
| action | 发送任务命令 | 设置为固定的:send |
| extno | 扩展子号 | 请先询问配置的通道是否支持扩展子号，如果不支持，请填空。子号只能为数字，且最多5位数。（可选） |
https://api.hvo.net.cn/mms.aspx?action=send&userid=&account=账号&password=密码&mobile=15023239810,13527576163&subject=彩信主题&content=base64编码&sendTime=&extno=
返回值与短信相同。
请求地址是客户接口程序调用时请求的url地址，采用的是https post 接口，地址是
https://api.hvo.net.cn/sms.aspx 对应UTF-8
https://api.hvo.net.cn/smsGBK.aspx 对应GB2312
https://api.hvo.net.cn/smsJson.aspx 对应UTF-8(返回值为json格式)
https://api.hvo.net.cn/mms.aspx 彩信余额地址,查询彩信余额，使用该地址。
入口地址一般不会发生变化，当发生变化的时候，会通知接口用户
| 参数名称 | 含义 | 说明 |
|---|---|---|
| userid | 企业id | 企业ID |
| account | 发送用户帐号 | 用户帐号，由系统管理员 |
| password | 发送接口密码 | 用md5加密方式，md5采用32位大写 如abc123加密后为 E99A18C428CB38D5F260853678922E03 |
| action | 任务名称 | 设置为固定的：overage |
例如:
action=overage&userid=12&account=账号&password=密码
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<returnstatus>status</returnstatus>
<message>message</message>
<payinfo> payinfo</payinfo>
<overage>overage</overage>
<sendTotal>sendTotal</sendTotal>
</returnsms>
返回参数:
| 字段名 | 描述 |
|---|---|
| returnstatus | 成功返回：Success 失败返回：Fail |
| message | 返回信息提示：见下表 |
| payinfo | 返回支付方式 后付费，预付费 |
| overage | 返回余额 |
| sendTotal | 返回总点数：当支付方式为预付费是返回总充值点数 |
{
"returnstatus":"Success",
"message":"操作成功",
"remainpoint":"-4",
"payinfo":"后付",
"overage":"-4",
"sendTotal":"0"
}
| 返回信息提示 | 描述 |
|---|---|
| 操作成功 | 查询成功 将返回相应的支付方式、账户使用条数、总充值点数 |
| 用户名或密码不能为空 | 提交的用户名或密码为空 |
| 用户名或密码错误 | 表示用户名或密码错误 |
请求地址是客户接口程序调用时请求的url地址，采用的是https post 接口，地址是
https://api.hvo.net.cn/statusApi.aspx
https://api.hvo.net.cn/statusJsonApi.aspx(返回值为json格式)
入口地址一般不会发生变化，当发生变化的时候，会通知接口用户
| 参数名称 | 含义 | 说明 |
|---|---|---|
| userid | 企业id | 企业ID |
| account | 发送用户帐号 | 用户帐号，由系统管理员 |
| password | 发送接口密码 | 用md5加密方式，md5采用32位大写 如abc123加密后为 E99A18C428CB38D5F260853678922E03 |
| statusNum | 每次取得号码数 | 必须为数字，默认1000，可不填 |
| action | 任务名称 | 设置为固定的：query |
| taskid | 批次编号 | 可选项，如果传此参数，则只查询该批次的状态。 |
例如:
action=query&userid=12&account=账号&password=密码& taskid =1523516
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<statusbox>
<mobile>15023239810</mobile>
<taskid>1212</taskid>
<status> 10</status>
<receivetime>2018-02-02 22:12:11</receivetime>
<errorcode>DELIVRD</errorcode>
<extno>01</extno>
</statusbox>
<statusbox>
<mobile>15023239810</mobile>
<taskid>1212</taskid>
<status> 20</status>
<receivetime>2018-02-02 22:12:11</receivetime>
<errorcode>2</errorcode>
<extno></extno>
</statusbox>
</returnsms>
| 字段名 | 描述 |
|---|---|
| mobile | 对应的手机号码 |
| taskid | 同一批任务ID |
| status | 状态报告10：发送成功，20：发送失败 |
| receivetime | 接收时间 |
| errorcode | 上级网关返回值，不同网关返回值不同，仅作为参 |
| extno | 子号，即自定义扩展号 |
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<errorstatus>
<error>1</error>
<remark>用户名或密码不能为空</remark>
</errorstatus>
</returnsms>
| error | 描述 |
|---|---|
| 1 | 用户名或密码不能为空 |
| 2 | 用户名或密码错误 |
| 3 | 该用户不允许查看状态报告 |
| 4 | 参数不正确 |
错误时：
{
"error":"1005",
"remark":"密码错了",
"statusbox":[]
}
正确时：
{
"error":"1",
"remark":"成功",
"statusbox":[
"mobile":"15510331875",
"taskid":"123",
"receivetime":"2018-02-01 00:00:00",
"errorcode":"dEv"},{
"mobile":"13483728958",
"taskid":"124",
"receivetime":"2018-02-01 00:00:00",
"errorcode":"back"}
]
}
请求地址是客户接口程序调用时请求的url地址，采用的是https post 接口，地址是
https://api.hvo.net.cn/callApi.aspx
https://api.hvo.net.cn/callJsonApi.aspx(返回值为json格式)
入口地址一般不会发生变化，当发生变化的时候，会通知接口用户
| 参数名称 | 含义 | 说明 |
|---|---|---|
| userid | 企业id | 企业ID |
| account | 发送用户帐号 | 用户帐号，由系统管理员 |
| password | 发送接口密码 | 用md5加密方式，md5采用32位大写 如abc123加密后为 E99A18C428CB38D5F260853678922E03 |
| action | 任务名称 | 设置为固定的：query |
例如:
action=query&userid=12&account=账号&password=密码
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<callbox>
<mobile>15023239810</mobile>
<content>你好，我不需要</content>
<receivetime> 2018-02-02 22:12:11</receivetime>
<extno>01</extno>
</callbox>
<callbox>
<mobile>15023239811</mobile>
<content>你好，本次活动路线是怎么的</content>
<receivetime> 2018-02-02 22:12:11</receivetime>
<extno>01</extno>
</callbox>
</returnsms>
| 字段名 | 描述 |
|---|---|
| mobile | 对应的手机号码 |
| content | 上行内容 |
| receivetime | 接收时间 |
| extno | 子号，即自定义扩展号 |
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<errorstatus>
<error>1</error>
<remark>用户名或密码不能为空</remark>
</errorstatus>
</returnsms>
| error | 错误描述 |
|---|---|
| 1 | 用户名或密码不能为空 |
| 2 | 用户名或密码错误 |
| 3 | 该用户不允许查看状态报告 |
| 4 | 参数不正确 |
错误时：
{
"error":"1005",
"remark":"密码错了",
"callbox":[]
}
正确时：
{
"error":"1",
"remark":"成功",
"callbox":[
"mobile":"15510331875",
"content":"a",
"receivetime":"2018-02-01 00:00:00",
"extno":"123"},{
"mobile":"13483728958",
"content":"b",
"receivetime":"2018-02-01 00:00:00",
"extno":"456"}
]
}
客户需要提供一个可以在公网访问的http接口地址，由管理员配置到账户中。
在返回状态或上行时，系统会调用该地址，将状态或上行以xml形式，推送给客户方，客户应该获取整个post内容（而并非某个参数值），来取得xml内容。
c#取得xml内容示例：
StreamReader reader = new StreamReader(Request.InputStream, Encoding.UTF8);
String xmlContent = reader.ReadToEnd();
java取得xml内容示例：
DocumentBuilderFactory buildFactory=DocumentBuilderFactory.newInstance();
DocumentBuilder build=buildFactory.newDocumentBuilder();
Document document=build.parse(request.getInputStream());
php取得xml内容示例：
$raw_post_data = file_get_contents('php://input', 'r');
$doc = new DOMDocument();
$doc->loadXML($raw_post_data);
入口地址一般不会发生变化，当发生变化的时候，会通知接口用户
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<statusbox>
<mobile>15023239810</mobile>
<taskid>1212</taskid>
<status> 10</status>
<receivetime>2018-02-02 22:12:11</receivetime>
<errorcode>DELIVRD</errorcode>
<extno>01</extno>
</statusbox>
<statusbox>
<mobile>15023239810</mobile>
<taskid>1212</taskid>
<status> 20</status>
<receivetime>2018-02-02 22:12:11</receivetime>
<errorcode>2</errorcode>
<extno></extno>
</statusbox>
</returnsms>
| 字段名 | 描述 |
|---|---|
| mobile | 对应的手机号码 |
| taskid | 同一批任务ID |
| status | 状态报告10：发送成功，20：发送失败 |
| receivetime | 接收时间 |
| errorcode | 上级网关返回值，不同网关返回值不同，仅作为参 |
| extno | 子号，即自定义扩展号 |
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<callbox>
<mobile>15023239810</mobile>
<content>你好，我不需要</content>
<receivetime> 2018-02-02 22:12:11</receivetime>
<extno>01</extno>
</callbox>
<callbox>
<mobile>15023239811</mobile>
<content>你好，本次活动路线是怎么的</content>
<receivetime> 2018-02-02 22:12:11</receivetime>
<extno>01</extno>
</callbox>
</returnsms>
| 字段名 | 描述 |
|---|---|
| mobile | 对应的手机号码 |
| content | 上行内容 |
| receivetime | 接收时间 |
| extno | 子号，即自定义扩展号 |
如果客户成功接收状态或上行，请返回”1”字符串。
如果客户处理失败，请返回“error”字符串，系统将会尝试再次推送。最多尝试3次。
如果客户未返回值或返回其它值，当作成功处理。
如果调用时出现网络异常，则当作失败，继续重试。
请求地址是客户接口程序调用时请求的url地址，采用的是https post 接口，地址是
https://api.hvo.net.cn/pwd.asp
入口地址一般不会发生变化，当发生变化的时候，会通知接口用户
| 参数名称 | 含义 | 说明 |
|---|---|---|
| userid | 企业id | 企业ID |
| account | 用户帐号 | 用户帐号，由系统管理员 |
| password | 账号密码 | 用户账号对应的旧密码 |
| newpassword | 新密码 | 要设置的新密码，最长20位 |
例如:
&userid=12&account=账号&password=旧密码&newpassword=新密码
<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<returnstatus>status</returnstatus>
<message>message</message>
</returnsms>
| 字段名 | 描述 |
|---|---|
| returnstatus | 返回状态值：成功返回Success 失败返回：Fail |
| message | 错误提示 |
请求地址是客户接口程序调用时请求的url地址，地址是：
https://api.hvo.net.cn/WebService.asmx
方法名为SendSms
入口地址一般不会发生变化，当发生变化的时候，会通知接口用户
| 参数名称 | 含义 | 说明 |
|---|---|---|
| userName | 发送用户帐号 | 用户帐号，由系统管理员 |
| password | 发送帐号密码 | |
| sms | 短信参数对象 | SmsObject结构，详见下面说明 |
| 参数名称 | 含义 | 说明 |
|---|---|---|
| Msisdns | 全部被叫号码 | 发信发送的目的号码.多个号码之间用半角逗号隔开 |
| SMSContent | 发送内容 | 短信的内容，内容需要UTF-8编码，提交内容格式：内容+【签名】。签名是公司的名字或者公司项目名称。示例：您的验证码：1439【中联信达】。【】是签名的标识符。请按照正规的格式提交内容测试，请用正规内容下发，最好不要当成是测试，就当是正式使用在给自己的客户发信息，签名字数3-8个字 |
| PlanSendTime | 定时发送时间 | 为空表示立即发送，定时发送格式2018-02-02T09:08:10 |
| ExtNumber | 扩展子号 | 请先询问配置的通道是否支持扩展子号，如果不支持，请填空。子号只能为数字，且最多5位数。 |
返回一个SendResult结构，具体含义如下：
| 参数名称 | 含义 | 说明 |
|---|---|---|
| StatusCode | 发送的状态代码 | OK表示成功，其它为失败，参见最后的错误代码表。 |
| Description | 发送说明 | 发送结果状态操作说明 |
| MsgId | 任务ID | 提交短信的任务批次 |
| Amount | 当前余额 | 当前账户的余额 |
| SuccessCounts | 成功的号码数量 | 成功的号码数量 |
| BillingCount | 消费的条数 | 消费的条数值 |
| Errors | 错误描述 | 本次发送中，相关的错误描述 |
接口模板报备，需要账户开通接口报备功能！
1)请求地址：
请求地址是客户接口程序调用时请求的url地址，采用的是https post 接口，地址是
https://api.hvo.net.cn/freeTemplate.aspx （对应utf-8的编码方式
已参数的形式发起请求，例：
http:// api.hvo.net.cn /freeTemplate.aspx?action=Add&account=qq&password=qq&template=验证码@【中联信达】
2)参数说明：
| 参数名称 | 含义 | 说明 |
|---|---|---|
| userid | 企业id | 企业ID，不验证 |
| account | 发送用户帐号 | 用户帐号，由系统管理员 |
| password | 发送接口密码 | 用md5加密方式，md5采用32位大写 如abc123加密后为 E99A18C428CB38D5F260853678922E03 |
| template | 报备模板 | 内容中用@替换20个字符以内的可变内容，@ 可多次出现，连续的@最多允许出现5次 |
| action | 任务名称 | 设置为固定的：query |
3)返回值说明：
返回json字符串,客户需要解析json字符串
{
"Status":"Faild",
"StatusCode":"1119",
"Description":"未启用该功能",
"TemplateId":""
}
| 参数名称 | 含义 | 说明 |
|---|---|---|
| Status | 状态描述 | 成功返回Success,失败返回Faild |
| StatusCode | 状态码 | 状态码，1成功，其他失败，参见ResltCode定义 |
| Description | 描述信息 | 错误描述 |
| TemplateId | 模板id | 模板id，报备成功后，返回该模板的唯一标识符，查询模板状态时使用，查询失败，此处为空 |
1)请求地址：
请求地址是客户接口程序调用时请求的url地址，采用的是https post 接口，地址是
https://api.hvo.net.cn/freeTemplate.aspx （对应utf-8的编码方式
已参数的形式发起请求，例：
http://api.hvo.net.cn/freeTemplate.aspx?action=query&account=qq&password=qq&templateid=123
2)参数说明：
| 参数名称 | 含义 | 说明 |
|---|---|---|
| userid | 企业id | 企业ID，不验证 |
| account | 发送用户帐号 | 用户帐号，由系统管理员 |
| password | 发送接口密码 | 用md5加密方式，md5采用32位大写 如abc123加密后为 E99A18C428CB38D5F260853678922E03 |
| template | 报备模板id | 报备模板成功时返回的模板唯一标识符 |
| action | 任务名称 | 设置为固定的：query |
3)返回值说明：
返回json字符串,客户需要解析json字符串
{
"Status":"Success",
"StatusCode":"1",
"Description":"操作成功",
"TemplateList":[
{
"TemplateId":"1611293848530529",
"Status":3,
"Template":"您的验证码：@【中联信达】"
}
]
}
| 参数名称 | 含义 | 说明 |
|---|---|---|
| Status | 状态描述 | 成功返回Success,失败返回Faild |
| StatusCode | 状态码 | 状态码，1成功，其他失败，参见ResltCode定义 |
| Description | 描述信息 | 错误描述 |
| TemplateId | 模板id | 模板id，报备成功后，返回该模板的唯一标识符，查询模板状态时使用，查询失败，此处为空 TemplateId ，模板id，添加报备内容时，返回的唯一标识符 Status，状态，1启用 2禁用 3审核 4退回 Template，模板内容，报备的模板内容 |
注：报备内容修改后，会重新进入审核，已审
1)请求地址：
请求地址是客户接口程序调用时请求的url地址，采用的是https post 接口，地址是
https://api.hvo.net.cn/freeTemplate.aspx （对应utf-8的编码方式
已参数的形式发起请求，例：
http://api.hvo.net.cn/freeTemplate.aspx?action=update&account=qq&password=qq&templateid=123& template=123@【中联信达】
2)参数说明：
| 参数名称 | 含义 | 说明 |
|---|---|---|
| userid | 企业id | 企业ID，不验证 |
| account | 发送用户帐号 | 用户帐号，由系统管理员 |
| password | 发送接口密码 | 用md5加密方式，md5采用32位大写 如abc123加密后为 E99A18C428CB38D5F260853678922E03 |
| templateid | 报备模板id | 报备模板成功时返回的模板唯一标识符 |
| template | 报备模板 | 内容中用@替换20个字符以内的可变内容，@ 可多次出现，连续的@最多允许出现5次 |
| action | 任务名称 | 设置为固定的：query |
3)返回值说明：
返回json字符串,客户需要解析json字符串
{
"Status":"Success",
"StatusCode":"1",
"Description":"操作成功"
}
| 参数名称 | 含义 | 说明 |
|---|---|---|
| Status | 状态描述 | 成功返回Success,失败返回Faild |
| StatusCode | 状态码 | 状态码，1成功，其他失败，参见ResltCode定义 |
| Description | 描述信息 | 错误描述 |
1)请求地址：
请求地址是客户接口程序调用时请求的url地址，采用的是https post 接口，地址是
https://api.hvo.net.cn/freeTemplate.aspx （对应utf-8的编码方式
已参数的形式发起请求，例：
http://api.hvo.net.cn/freeTemplate.aspx?action=del&account=qq&password=qq&templateid=123
2)参数说明：
| 参数名称 | 含义 | 说明 |
|---|---|---|
| userid | 企业id | 企业ID，不验证 |
| account | 发送用户帐号 | 用户帐号，由系统管理员 |
| password | 发送接口密码 | 用md5加密方式，md5采用32位大写 如abc123加密后为 E99A18C428CB38D5F260853678922E03 |
| templateid | 报备模板id | 报备模板成功时返回的模板唯一标识符 |
| action | 任务名称 | 设置为固定的：query |
3)返回值说明：
返回json字符串,客户需要解析json字符串
{
"Status":"Success",
"StatusCode":"1",
"Description":"操作成功"
}
| 参数名称 | 含义 | 说明 |
|---|---|---|
| Status | 状态描述 | 成功返回Success,失败返回Faild |
| StatusCode | 状态码 | 状态码，1成功，其他失败，参见ResltCode定义 |
| Description | 描述信息 | 错误描述 |
| 错误代码 | 含义 | 说明 |
|---|---|---|
| 1 | OK | 操作成功 |
| 1001 | ParamError | 参数错误 |
| 1002 | UserNameEmpty | 用户名为空 |
| 1003 | PasswordEmpty | 密码为空 |
| 1004 | UserNameError | 用户名错误 |
| 1005 | PasswordError | 密码错误 |
| 1006 | BindIpError | IP绑定错误 |
| 1007 | UserStop | 账户已停用 |
| 1008 | UserIdError | serId参数错误，该值必需要是数字，由供应商提供。 |
| 1009 | Text64Error | Text64参数错误，错误的可能有：不是有效的base64编码，Des解密失败，解析json时出错。 |
| 1010 | StampError | 时间戳错误，可能是格式不对，或是时间偏差太大（应该在5分钟以内）。 |
| 2001 | ContentEmpty | 内容为空 |
| 1103 | MsisdnEmpty | 手机号码为空 |
| 1104 | ExtNumberError | 扩展错误 |
| 2105 | ContentLong | 内容太长 |
| 1106 | NoChannel | 没有发送通道 |
| 2107 | SensitiveWords | 敏感词汇 |
| 1108 | MsisdnError | 错误的手机号码 |
| 1109 | MsisdnBlack | 黑名单的手机号码 |
| 1110 | MsisdnNoChannel | 没有通道的手机号码 |
| 1111 | AmountNotEnough | 额度不足 |
| 1112 | NoProduct | 没有配置产品 |
| 2113 | RequiredSuffix | 需要签名 |
| 2114 | SuffixError | 签名错误 |
| 3001 | SubjectEmpty | 主题为空 |
| 9999 | InternalError | 系统内部错误 |
