测试账号联系博主

接口说明：客户接口部分提供http 和 WebService（目前只支持提交短信）方式的接口，客户可以根据需求选择相应接口，接口编码方式默认采用UTF-8

注：国际短信与国内短信状态与上行获取地址一致，如果有国际与国内短信业务的需要，建议开多个账号，否则状态与上行会在同一个地址获取

第一章短信发送接口

1.1 请求地址

请求地址是客户接口程序调用时请求的url地址，采用的是http post 接口，地址是

https://dx.ipyy.net/I18NSms.aspx 对应国际短信的发送地址

入口地址一般不会发生变化，当发生变化的时候，会通知接口用户

1.2参数说明

参数名称	含义	说明
userid	企业id	企业ID(不验证)
account	发送用户帐号	用户帐号，由系统管理员
password	发送接口密码	用md5加密方式，md5采用32位大写如abc123加密后为 E99A18C428CB38D5F260853678922E03
mobile	全部被叫号码	短信发送的目的号码.多个号码之间用半角逗号隔开。号码格式：国家区号+手机号码例：8613800138000，86为国家区号，13800138000为手机号码
code	编码方式	短信编码，0或8 ，默认为8，可选 8是中韩日俄等双字节文字（UNICODE编码），0是英文（ASII编码）注： 1.UNICODE使用Big Endian 字节顺序， 2.目前仅支持8（UNICODE）编码
content	短信内容	短信的内容，格式：内容+【签名】。短信内容按照code编码后，需要转成16进制HEX字符串短信计费条数：普通短信70字，长短信67字
sendTime	定时发送时间	为空表示立即发送，定时发送格式2010-10-24 09:08:10
action	发送任务命令	设置为固定的:send
extno	扩展子号	请先询问配置的通道是否支持扩展子号，如果不支持，请填空。子号只能为数字，且最多5位数。

示例：

发送ascii(英文)，短信内容：test message[HuaXin]

code 参数为0，内容ascii编码后转为16进制HEX字符串为：00740065007300740020006D006500730073006100670065005B00480075006100580069006E005D

http地址为：

https://dx.ipyy.net/I18Nsms.aspx?action=send&userid=&account=qq&password=123456&mobile=m1,m2&code=0&content=00740065007300740020006D006500730073006100670065005B00480075006100580069006E005D&sendTime=&extno=

发送UNICODE（中日韩文等），短信内容：测试【华信】

code 参数为8，内容unicode编码（使用Big Endian 字节顺序）后转为16进制HEX字符串为：

6D4B8BD53010534E4FE13011

http地址为： https://dx.ipyy.net/I18Nsms.aspx?action=send&userid=&account=qq&password=123456&mobile=m1,m2&code=8&content=6D4B8BD53010534E4FE13011&sendTime=&extno=

注：以上是Get方式提交，如果用POST 请将参数放入包体提交，建议使用post方式提交

1.3 国际短信返回值

<?xml version="1.0" encoding="utf-8" ?>

<returnstatus>status</returnstatus> ---------- 返回状态值：成功返回Success 失败返回：Faild

<message>message</message> ---------- 相关的错误描述

<balance> balance</balance> ---------- 返回余额

<taskID>taskID</taskID> ----------- 返回本次任务的序列ID

<BillingAmount> BillingAmount </ BillingAmount > ---------- 返回本次扣费金额

<successCounts>successCounts</successCounts> --成功短信数：当成功后返回提交成功短信数

</returnsms>

第二章余额查询接口

2.1 请求地址

请求地址是客户接口程序调用的时候请求的url地址，采用的是http post接口，地址是

https://dx.ipyy.net/ I18NSms.aspx 国际短信余额查询地址

入口地址一般不会发生变化，当发生变化的时候，会通知接口用户

2.2 参数说明

参数名称	含义	说明
userid	企业id	企业ID
account	用户帐号	用户帐号，由系统管理员
password	接口密码	用md5加密方式，md5彩用32位大写如abc123加密后为 E99A18C428CB38D5F260853678922E03
action	任务名称	设置为固定的：overage

例如：

action=overage&userid=12&account=账号&password=密码

2.3 国际短信余额查询返回值

<?xml version="1.0" encoding="utf-8" ?>

<returnstatus>status</returnstatus>-------返回状态值：成功返回Success 失败返回：Faild

<message>message</message>--------------返回信息提示：见下表

<payinfo>payinfo</payinfo>--------------返回支付方式后付费，预付费

<balance>balance</balance>-------------返回余额

</returnsms>

返回信息提示	说明
操作成功	查询成功将返回相应的支付方式、账户当前余额
用户名或密码不能为空	提交的用户名或密码为空
用户名或密码错误	表示用户名或密码错误

第三章状态报告接口

3.1 请求地址

请求地址是客户接口程序调用的时候请求的url地址，采用的是http post接口，地址是

https://dx.ipyy.net/statusApi.aspx

https://dx.ipyy.net/statusJsonApi.aspx(返回值为json格式)

注：国际短信与国内短信状态获取接口一致

入口地址一般不会发生变化，当发生变化的时候，会通知接口用户

3.2参数说明

参数名称	含义	说明
userid	企业id	企业ID
account	用户帐号	用户帐号，由系统管理员
password	接口密码	用md5加密方式，md5彩用32位大写如abc123加密后为 E99A18C428CB38D5F260853678922E03
statusNum	每次取得号码数	必须为数字，默认4000，可不填
action	任务名称	设置为固定的：query
taskid	批次编号	可选项，如果传此参数，则只查询该批次的状态。

例如：

action=query&userid=12&account=账号&password=密码& taskid =1523516

3.3返回值

<?xml version="1.0" encoding="utf-8" ?>

<mobile>15023239810</mobile>-------------对应的手机号码

<taskid>1212</taskid>-------------同一批任务ID

<status>10</status>---------状态报告----10：发送成功，20：发送失败

<receivetime>2011-12-02 22:12:11</receivetime>-------------接收时间

<errorcode>DELIVRD</errorcode>-上级网关返回值，不同网关返回值不同，仅作为参考

<extno>01</extno>--子号，即自定义扩展号

</statusbox>

</statusbox>

</returnsms>

3.4错误返回值——状态报告请求错误返回格式及对应值

<?xml version="1.0" encoding="utf-8" ?>

<error>1</error>-------------错误码

<remark>用户名或密码不能为空</remark>-------------错误描述

</errorstatus>

</returnsms>

1：用户名或密码不能为空

2：用户名或密码错误

3：该用户不允许查看状态报告

4：参数不正确

3.5Json返回值

错误时：{"error":"1005","remark":"密码错了","statusbox":[]}

正确时：{"error":"1",
"remark":"成功",
"statusbox":[
    {"mobile":"15510331875",
     "taskid":"123",
     "receivetime":"2015-01-01 00:00:00",
     "errorcode":"dEv"
    },{
    "mobile":"13483728958",
    "taskid":"124",
    "receivetime":"2015-02-01 00:00:00",
    "errorcode":"back"}
    ]
}

第四章短信上行接口

4.1 请求地址

请求地址是客户接口程序调用的时候请求的url地址，采用的是http post接口，地址是

https://dx.ipyy.net/callApi.aspx

https://dx.ipyy.net/callJsonApi.aspx(返回值为json格式)

注：国际短信与国内短信上行获取接口一致,国际短信上行暂时不支持

入口地址一般不会发生变化，当发生变化的时候，会通知接口用户

4.2参数说明

参数名称	含义	说明
userid	企业id	企业ID
account	用户帐号	用户帐号，由系统管理员
password	接口密码	用md5加密方式，md5彩用32位大写如abc123加密后为 E99A18C428CB38D5F260853678922E03
action	任务名称	设置为固定的：query

例如：

action=query&userid=12&account=账号&password=密码

4.3返回值

<?xml version="1.0" encoding="utf-8" ?>

<mobile>15023239810</mobile>-------------对应的手机号码

<taskid>1212</taskid>-------------同一批任务ID

<content>你好，我不需要</content>---------上行内容

<receivetime>2011-12-02 22:12:11</receivetime>-------------接收时间

<extno>01</extno>----子号，即自定义扩展号

</callbox>

<content>你好，本次活动路线是怎么的</content>

</callbox>

</returnsms>

4.4错误返回值——回复请求错误返回格式及对应值

<?xml version="1.0" encoding="utf-8" ?>

<error>1</error>-------------错误码

<remark>用户名或密码不能为空</remark>-------------错误描述

</errorstatus>

</returnsms>

1：用户名或密码不能为空

2：用户名或密码错误

3：该用户不允许查看状态报告

4：参数不正确

4.5Json返回值

错误时: {"error":"1005","remark":"密码错了","callbox":[]}

正确时：{"error":"1",
"remark":"成功",
"callbox":[
  {"mobile":"15510331875",
  "taskid":"",
  "content":"a",
  "receivetime":"0001-01-01 00:00:00",
  "extno":"123"
  },{
  "mobile":"13483728958",
  "taskid":"",
  "content":"b",
  "receivetime":"0001-01-01 00:00:00",
  "extno":"456"
  }
]
}

第五章推送状态与上行

5.1绑定推送地址

客户需要提供一个可以在公网访问的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);

5.2状态报告请求参数值

<?xml version="1.0" encoding="utf-8" ?>

<mobile>15023239810</mobile>-------------对应的手机号码

<taskid>1212</taskid>-------------同一批任务ID

<status>10</status>---------状态报告----10：发送成功，20：发送失败

<receivetime>2011-12-02 22:12:11</receivetime>-------------接收时间

<errorcode>DELIVRD</errorcode>-上级网关返回值，不同网关返回值不同，仅作为参考

<extno>01</extno>--子号，即自定义扩展号

</statusbox>

</statusbox>

</returnsms>

5.3上行请求参数值

<?xml version="1.0" encoding="utf-8" ?>

<mobile>15023239810</mobile>-------------对应的手机号码

<taskid>1212</taskid>-------------同一批任务ID

<content>你好，我不需要</content>---------上行内容

<receivetime>2011-12-02 22:12:11</receivetime>-------------接收时间

<extno>01</extno>----子号，即自定义扩展号

</callbox>

<content>你好，本次活动路线是怎么的</content>

</callbox>

</returnsms>

5.4推送返回说明

如果客户成功接收状态或上行，请返回”1”字符串。

如果客户处理失败，请返回“error”字符串，系统将会尝试再次推送。最多尝试3次。

如果客户未返回值或返回其它值，当作成功处理。

如果调用时出现网络异常，则当作失败，继续重试。

第六章修改密码

6.1请求地址

https://dx.ipyy.net/pwd.aspx

入口地址一般不会发生变化，当发生变化的时候，会通知接口用户

6.2参数说明

参数名称	含义	说明
userid	企业id	企业ID
account	用户帐号	用户帐号，由系统管理员
password	接口密码	用户账号对应的旧密码
newpassword	新密码	要设置的新密码，最长20位

例如：

&userid=12&account=账号&password=旧密码&newpassword=新密码

6.3返回值

<?xml version="1.0" encoding="utf-8" ?>

<returnstatus>status</returnstatus>-------返回状态值：成功返回Sucess 失败返回：Faild

<message>message</message>--------------返回信息提示：见下表

</returnsms>

第七章 Web Service提交短信

请求地址是客户接口程序调用时请求的url地址，注：该方式暂不建议使用

地址是：

https://dx.ipyy.net/WebService.asmx

入口地址一般不会发生变化，当发生变化的时候，会通知接口用户

7.1 国际短信

7.1 方法名

SendI18NSms

注：国际短信的状态与上行与国内短信一致，参照第四五六章

7.2 参数说明

参数名称	含义	说明
userName	发送用户帐号	用户帐号，由系统管理员
password	发送接口密码
sms	短信参数对象	SmsObject结构，详见下面说明

SmsObject结构：

参数名称	含义	说明
Msisdns	全部被叫号码	发信发送的目的号码.多个号码之间用半角逗号隔开
SMSContent	发送内容	短信的内容
PlanSendTime	定时发送时间	为空表示立即发送，定时发送格式2010-10-24 09:08:10
ExtNumber	扩展子号	请先询问配置的通道是否支持扩展子号，如果不支持，请填空。子号只能为数字，且最多5位数。

7.3 返回值

返回一个SendResultBase结构，具体含义如下：

参数名称	含义	说明
StatusCode	发送的状态代码	OK表示成功，其它为失败，参见最后的错误代码表。
Description	发送说明	发送结果状态操作说明
MsgId	任务ID	提交短信的任务批次，与状态报告对应
Balance	当前账户可用余额	当前账户的可用余额
BillingAmount	本次发送支付的金额	本次发送支付的金额
BillingCount	消费的条数	消费的条数值
Errors	错误描述	本次发送中，相关的错误描述

7.2 国内国际混合短信

7.1 方法名

SendHybridSms

注：国际短信的状态与上行与国内短信一致，参照第四五六章

7.2 参数说明

参数名称	含义	说明
userName	发送用户帐号	用户帐号，由系统管理员
password	发送接口密码
sms	短信参数对象	SmsObject结构，详见下面说明

SmsObject结构：

参数名称	含义	说明
Msisdns	全部被叫号码	发信发送的目的号码.多个号码之间用半角逗号隔开号码格式：国家区号+手机号码例：8613800138000，86为国家区号，13800138000为手机号码
SMSContent	发送内容	短信的内容
PlanSendTime	定时发送时间	为空表示立即发送，定时发送格式2010-10-24 09:08:10
ExtNumber	扩展子号	请先询问配置的通道是否支持扩展子号，如果不支持，请填空。子号只能为数字，且最多5位数。

7.3 返回值

返回一个SendResultBase结构，具体含义如下：

参数名称	含义	说明
StatusCode	发送的状态代码	OK表示成功，其它为失败，参见最后的错误代码表。
Description	发送说明	发送结果状态操作说明
MsgId	任务ID	提交短信的任务批次，与状态报告对应
Balance	当前账户可用余额	当前账户的可用余额
BillingAmount	本次发送支付的金额	本次发送支付的金额
BillingCount	消费的条数	消费的条数值
Errors	错误描述	本次发送中，相关的错误描述

ResultCode定义

错误代码	定义	说明
1	OK	操作成功
1001	ParamError	参数错误
1002	UserNameEmpty	用户名为空
1003	PasswordEmpty	密码为空
1004	UserNameError	用户名错误
1005	PasswordError	密码错误
1006	BindIpError	IP绑定错误
1007	UserStop	帐户已停用
1008	UserIdError	UserId参数错误，该值必需要是数字，由供应商提供。
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	系统内部错误

华信国际短信接口文档相关推荐

国际短信接口文档-json
接口说明短信接入注意事项: 1. API账号.密码参数由我方统一提供 2. 如需推送状态报告,请提供回调地址给我方运营人员绑定(群发接口目前不支持状态推送) 3. 仅支持HTTP POST请求方式 ...
php短信接口加密_PHP短信接口、PHP短信验证码接口源码
PHP短信接口.PHP短信验证码接口源码时间:2016-06-13 11:53 来源:原创作者:admin PHP短信接口文档源码,PHP发短信接口,PHP在线发短信,PHP微信发短信接口 /* ...
php短信接代码,php短信接口代码
今天有空看了下以前的短信对接的代码,重构了下,官方的短信接口文档: 'https://sms-api.luosimao.com/v1/send.json', 'send_batch' => 'h ...
C# 阿里云短信接口调用（不使用SDK，单文件完成）
虽然阿里云短信接口,提供了很多种语言的SKD,但是对应C#而言,如果使用阿里云SDK,你的项目中需要引入一大堆的dll,像这样: 我只需要发个短信,没必要引入这么多dll吧.于是,根据阿里云官方文档, ...
新版阿里云短信接口调用
最新介绍在这个博文阿里云视频点播接口有介绍今天项目需要用到阿里云的短信接口,看了文档,感觉文档说的不详细,demo也是有点乱,找了资料,发现说是今年新改版的,费了点劲,弄好了,阿里的这个短信接口 ...
短信接口在本地调试正常_Pivotal实践：腾讯云短信小应用
最近登录了一下腾讯云控制台,发现账户下居然每月有100条免费短信可以使用.结合一下最近成都阴晴不定的天气,女友上班老是忘记带伞的现状,于是决定开发一款天气短信提醒小应用,每天早上定时给女友发送天气状况 ...
一信通短信接口对接_短信接口对接
{"moduleinfo":{"card_count":[{"count_phone":1,"count":1}],&q ...
一信通短信接口对接_如何对接短信接口
{"moduleinfo":{"card_count":[{"count_phone":1,"count":1}],&q ...
一信通短信接口对接_对接阿里通信短信接口
{"moduleinfo":{"card_count":[{"count_phone":1,"count":1}],&q ...

华信国际短信接口文档

测试账号联系博主

第一章短信发送接口

1.1 请求地址

1.2参数说明

1.3 国际短信返回值

第二章余额查询接口

2.1 请求地址

2.2 参数说明

2.3 国际短信余额查询返回值

第三章状态报告接口

3.1 请求地址

3.2参数说明

3.3返回值

3.4错误返回值——状态报告请求错误返回格式及对应值

3.5Json返回值

第四章短信上行接口

4.1 请求地址

4.2参数说明

4.3返回值

4.4错误返回值——回复请求错误返回格式及对应值

4.5Json返回值

第五章推送状态与上行

5.1绑定推送地址

5.2状态报告请求参数值

5.3上行请求参数值

5.4推送返回说明

第六章修改密码

6.1请求地址

6.2参数说明

6.3返回值

第七章 Web Service提交短信

7.1 国际短信

7.2 国内国际混合短信

ResultCode定义

华信国际短信接口文档相关推荐

最新文章

热门文章

华信国际短信接口文档

测试账号联系博主

第一章 短信发送接口

1.1 请求地址

1.2参数说明

1.3 国际短信返回值

第二章 余额查询接口

2.1 请求地址

2.2 参数说明

2.3 国际短信余额查询返回值

第三章 状态报告接口

3.1 请求地址

3.2参数说明

3.3返回值

3.4错误返回值——状态报告请求错误返回格式及对应值

3.5Json返回值

第四章 短信上行接口

4.1 请求地址

4.2参数说明

4.3返回值

4.4错误返回值——回复请求错误返回格式及对应值

4.5Json返回值

第五章 推送状态与上行

5.1绑定推送地址

5.2状态报告请求参数值

5.3上行请求参数值

5.4推送返回说明

第六章 修改密码

6.1请求地址

6.2参数说明

6.3返回值

第七章 Web Service提交短信

7.1 国际短信

7.2 国内国际混合短信

ResultCode定义

华信国际短信接口文档相关推荐

最新文章

热门文章

第一章短信发送接口

第二章余额查询接口

第三章状态报告接口

第四章短信上行接口

第五章推送状态与上行

第六章修改密码