天天看点

华信短信平台接口文档测试账号关注微信领取:g94263

测试账号关注微信领取:g94263

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

发送规则:

同一个号码,发送内容带有(验证码),3分钟之内只能3条,

超过3条,系统会默认为(恶意注册)

同一个号码,系统默认一天之内只能发送10条信息,超过

10条会超限失败(特殊号码、或特殊客户需要找客服处理)

注:短信计费条数跟短信的字数有关,一般的短信70个字计费一条。超过70个字就划分为长短信,67个字计费一条,例如;71字的短信就是长短信计费2条,134个字也是计费2条(67*2)。135个字计费3条,依次类推。

第一章  短信发送接口

1.1 请求地址

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

https://dx.ipyy.net/sms.aspx 对应UTF-8

https://dx.ipyy.net/smsGBK.aspx 对应GB2312

https://dx.ipyy.net/smsJson.aspx 对应UTF-8(返回值为json格式)

https://dx.ipyy.net/ensms.ashx 对应UTF-8(加密传输,使用json)

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

1.2参数说明

参数名称 含义 说明
userid 企业id 企业ID(不验证)
account 发送用户帐号 用户帐号,由系统管理员
password 发送接口密码

用md5加密方式,md5采用32位大写

如abc123加密后为

E99A18C428CB38D5F260853678922E03

mobile 全部被叫号码 短信发送的目的号码.多个号码之间用半角逗号隔开
content 发送内容 短信的内容,内容需要UTF-8编码,提交内容格式:内容+【签名】。签名是公司的名字或者公司项目名称。示例:您的验证码:1439【腾飞】。【】是签名的标识符。请按照正规的格式提交内容测试,请用正规内容下发,最好不要当成是测试,就当是正式使用在给自己的客户发信息,签名字数3-8个字
sendTime 定时发送时间 为空表示立即发送,定时发送格式2018-02-02 09:08:10(可选)
action 发送任务命令 设置为固定的:send
extno 扩展子号 请先询问配置的通道是否支持扩展子号,如果不支持,请填空。子号只能为数字,且最多5位数。(可选)

例如:

https://dx.ipyy.net/sms.aspx?action=send&userid=&account=账号&password=密码&mobile=15023239810,13527576163&content=内容&sendTime=&extno=

1.3返回值

在接收到客户端发送的http请求后,返回以xml的方式返回处理结果。格式为:

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

<returnsms>

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

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

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

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

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

</returnsms>

1.4 Json返回值

{"returnstatus":"Success", ---------- 返回状态值:成功返回Success 失败返回:Fail

"message":"操作成功",---------- 相关的错误描述

"remainpoint":"-4",----------- 返回余额

"taskID":"1504080852350206",-----------  返回本次任务的序列ID

"successCounts":"1"}---------------成功短信数:当提交成功后返回的短信数

1.5 加密传输

参数名称 含义 说明
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。
           
D0 3A 8A 1A 6F 4C 5A 7B 05 33 6C 25 60 45 BA E5 55 F2 94 1C 49 18 18 AE 67 33 F9 75 3A 75 00 B7 4A ED 06 93 83 1D 1C 47 91 9F B6 49 E3 88 D2 41 39 DE 3A B5 D2 69 FB A2 77 39 80 28 BA 41 01 38 A9 5F B0 4C 53 68 56 02 ED 7E 75 E0 FC 8B 0B E3 6B C2 10 CB 29 83 AF 14 06 FB 80 1A 3E 76 A9 2C 96 F5 49 92 5C F8 AA 6E FF 81 41 EB 1C 04 F6 77 B8 44 71 0C 61 0C C0 FE 22 3F 0D 23 2D 64 BC 7A 94 DE 7A 19 4E A8 E5 0B 53 DA 68 56 32 EB 38 9F 06 BE 4D 0F E5 78 50 AD 31 33 BB 1C 17 F6 AF 7D 52 96 FF 49 35 EA AA 95 CC 30 C9 A1 C4 64 4F 3D 23 AA FB 49 61 FA 35 96 2B 88 DB E8 76 7D 19 0A
           

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 错误描述 本次发送中,相关的错误描述

1.6 点对点发送

1.6.1 请求地址

          https://dx.ipyy.net/BatchSms.ashx  对应UTF-8的点对点发送,只支持post方式的提交 (Zip压缩内容)

         1.6.2 参数说明

参数名称 含义 说明
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为分隔符
    1. 手机号+分隔符(,)+内容+结尾标识(\r\n) + 手机号+分隔符(,)+内容+结尾标识(\r\n)
    2. 例:13800138000,验证码:1234【华信】\r\n13800138000,验证码:4567【华信】

注:同一批任务中不允许出现重复的手机号码,如果短信内容中有\r\n符号需要进行转义

2)  将\r\n组合后的内容进行GZip压缩,将压缩后的byte数组进行base64编码,然后url编码作为content参数

1.6.3返回值

在接收到客户端发送的http请求后,返回以xml的方式返回处理结果。格式为:

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

<returnsms>

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

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

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

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

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

</returnsms>

第二章  彩信发送接口

2.1 请求地址

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

https://dx.ipyy.net/mms.aspx 对应UTF-8

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

2.2参数说明

参数名称 含义 说明
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://dx.ipyy.net/mms.aspx?action=send&userid=&account=账号&password=密码&mobile=15023239810,13527576163&subject=彩信主题&content=base64编码&sendTime=&extno=

2.3返回值

        返回值与短信相同。

第三章 余额及已发送量查询接口

3.1 请求地址

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

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

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

https://dx.ipyy.net/mms.aspx 彩信余额地址,查询彩信余额,使用该地址。

https://dx.ipyy.net/smsJson.aspx 对应UTF-8(返回值为json格式)

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

3.2参数说明

参数名称 含义 说明
userid 企业id 企业ID
account 用户帐号 用户帐号,由系统管理员
password 帐号密码

用md5加密方式,md5彩用32位大写

如abc123加密后为

E99A18C428CB38D5F260853678922E03

action 任务名称 设置为固定的:overage

例如:

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

3.3返回值

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

<returnsms>

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

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

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

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

<sendTotal>sendTotal</sendTotal>----返回总点数  当支付方式为预付费是返回总充值点数

</returnsms>

3.4Json返回值

{"returnstatus":"Success","message":"操作成功",

"payinfo":"后付","overage":"-4","sendTotal":"0"}
           
返回信息提示 说明
操作成功

查询成功

将返回相应的支付方式、账户使用条数、总充值点数

用户名或密码不能为空 提交的用户名或密码为空
用户名或密码错误 表示用户名或密码错误

第四章 状态报告接口

4.1 请求地址

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

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

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

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

4.2参数说明

参数名称 含义 说明
userid 企业id 企业ID
account 用户帐号 用户帐号,由系统管理员
password 帐号密码

用md5加密方式,md5彩用32位大写

如abc123加密后为

E99A18C428CB38D5F260853678922E03

statusNum 每次取得号码数 必须为数字,默认1000,可不填
action 任务名称 设置为固定的:query
taskid 批次编号 可选项,如果传此参数,则只查询该批次的状态。

例如:

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

4.3返回值

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

<returnsms>

<statusbox>

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

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

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

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

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

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

</statusbox>

<statusbox>

<mobile>15023239811</mobile>

<taskid>1212</taskid>

<status>20</status>

<receivetime>2018-02-02 22:12:11</receivetime>

<errorcode>2</errorcode>

<extno></extno>

</statusbox>

</returnsms>

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

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

<returnsms>

<errorstatus>

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

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

</errorstatus>

</returnsms>

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

2:用户名或密码错误

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

4:参数不正确

4.5Json返回值

错误时:{"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"}

    ]

}

第五章 短信上行接口

5.1 请求地址

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

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

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

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

5.2参数说明

参数名称 含义 说明
userid 企业id 企业ID
account 用户帐号 用户帐号,由系统管理员
password 帐号密码

用md5加密方式,md5彩用32位大写

如abc123加密后为

E99A18C428CB38D5F260853678922E03

action 任务名称 设置为固定的:query

例如:

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

5.3返回值

<?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>

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

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

<returnsms>

<errorstatus>

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

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

</errorstatus>

</returnsms>

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

2:用户名或密码错误

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

4:参数不正确

5.5Json返回值

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

"remark":"成功",

"callbox":[

  {"mobile":"15510331875",

   "content":"a",

  "receivetime":"0001-01-01 00:00:00",

  "extno":"123"

  },{

  "mobile":"13483728958",

    "content":"b",

  "receivetime":"0001-01-01 00:00:00",

  "extno":"456"

  }

 ]

}
           

第六章 推送状态与上行

6.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);

6.2状态报告请求参数值

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

<returnsms>

<statusbox>

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

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

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

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

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

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

</statusbox>

<statusbox>

<mobile>15023239811</mobile>

<taskid>1212</taskid>

<status>20</status>

<receivetime>2018-02-02 22:12:11</receivetime>

<errorcode>2</errorcode>

<extno></extno>

</statusbox>

</returnsms>

6.3上行请求参数值

<?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>

6.4推送返回说明

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

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

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

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

第七章 修改密码

7.1请求地址

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

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

7.2参数说明

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

例如:

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

7.3返回值

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

<returnsms>

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

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

</returnsms>

第八章 Web Service提交短信

8.1 请求地址

        请求地址是客户接口程序调用时请求的url地址,

        地址是:

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

    方法名为SendSms

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

8.2参数说明

参数名称 含义 说明
userName 发送用户帐号 用户帐号,由系统管理员
password 发送帐号密码
sms 短信参数对象 SmsObject结构,详见下面说明
参数名称 含义 说明
Msisdns 全部被叫号码 发信发送的目的号码.多个号码之间用半角逗号隔开
SMSContent 发送内容 短信的内容,内容需要UTF-8编码,提交内容格式:内容+【签名】。签名是公司的名字或者公司项目名称。示例:您的验证码:1439【腾飞】。【】是签名的标识符。请按照正规的格式提交内容测试,请用正规内容下发,最好不要当成是测试,就当是正式使用在给自己的客户发信息,签名字数3-8个字
PlanSendTime 定时发送时间 为空表示立即发送,定时发送格式2018-02-02T09:08:10
ExtNumber 扩展子号 请先询问配置的通道是否支持扩展子号,如果不支持,请填空。子号只能为数字,且最多5位数。

8.3返回值

     返回一个SendResult结构,具体含义如下:
           
参数名称 含义 说明
StatusCode 发送的状态代码 OK表示成功,其它为失败,参见最后的错误代码表。
Description 发送说明 发送结果状态操作说明
MsgId 任务ID 提交短信的任务批次
Amount 当前余额 当前账户的余额
SuccessCounts 成功的号码数量 成功的号码数量
BillingCount 消费的条数 消费的条数值
Errors 错误描述 本次发送中,相关的错误描述

第九章 报备模板接口

        接口模板报备,需要账户开通接口报备功能!

         9.1模板报备

  1. 请求地址:

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

https://dx.ipyy.net/freeTemplate.aspx (对应utf-8的编码方式)

已参数的形式发起请求,例:

http:// dx.ipyy.net /freeTemplate.aspx?action=Add&account=qq&password=qq&template=验证码@【华信】

  1. 参数说明
参数名称 含义 说明
userid 企业id 企业ID,不验证
account 用户帐号 用户帐号,由系统管理员分配
password 帐号密码

用md5加密方式,md5采用32位大写

如abc123加密后为

E99A18C428CB38D5F260853678922E03

template 报备模板 内容中用@替换20个字符以内的可变内容,@ 可多次出现,连续的@最多允许出现5次
action 任务名称 设置为固定的:Add
  1. 返回值说明:

返回json字符串,客户需要解析json字符串

{

"Status":"Faild",

"StatusCode":"1119",

"Description":"未启用该功能",

"TemplateId":""

}

参数名称 含义 说明
Status 状态描述 成功返回Success,失败返回Faild
StatusCode 状态码

状态码,1成功,其他失败,

参见ResltCode定义

Description 描述信息 错误描述
TemplateId 模板id 模板id,报备成功后,返回该模板的唯一标识符,查询模板状态时使用,查询失败,此处为空

         9.2报备内容查询

  1. 请求地址:

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

https://dx.ipyy.net/freeTemplate.aspx (对应utf-8编码方式)

已参数的形式发起请求,例:

http://dx.ipyy.net/freeTemplate.aspx?action=query&account=qq&password=qq&templateid=123

  1. 参数说明
参数名称 含义 说明
userid 企业id 企业ID,不验证
account 用户帐号 用户帐号,由系统管理员分配
password 帐号密码

用md5加密方式,md5采用32位大写

如abc123加密后为

E99A18C428CB38D5F260853678922E03

templateid 报备模板id 报备模板成功时返回的模板唯一标识符
action 任务名称 设置为固定的:query
  1. 返回值说明:

返回json字符串,客户需要解析json字符串

{

"Status":"Success",

"StatusCode":"1",

"Description":"操作成功",

"TemplateList":[

{"TemplateId":"1611293848530529",

"Status":3,

"Template":"您的验证码:@【华信】"}

]

}

参数名称 含义 说明
Status 状态描述 成功返回Success,失败返回Faild
StatusCode 状态码

状态码,1成功,其他失败,

参见ResltCode定义

Description 描述信息 错误描述
TemplateList 模板集合

通过模板查询到的数组集合,查询失败,集合为空

TemplateId ,模板id,添加报备内容时,返回的唯一标识符

Status,状态,1启用 2禁用 3审核 4退回

Template,模板内容,报备的模板内容

9.3修改报备内容

                注:报备内容修改后,会重新进入审核,已审

  1. 请求地址:

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

https://dx.ipyy.net/freeTemplate.aspx (对应utf-8编码方式)

已参数的形式发起请求,例:

http://dx.ipyy.net/freeTemplate.aspx?action=update&account=qq&password=qq&templateid=123& [email protected]【华信】

  1. 参数说明
参数名称 含义 说明
userid 企业id 企业ID,不验证
account 用户帐号 用户帐号,由系统管理员分配
password 帐号密码

用md5加密方式,md5采用32位大写

如abc123加密后为

E99A18C428CB38D5F260853678922E03

templateid 报备模板id 报备模板成功时返回的模板唯一标识符
template 报备模板 内容中用@替换20个字符以内的可变内容,@ 可多次出现,连续的@最多允许出现5次
action 任务名称 设置为固定的:update
  1. 返回值说明:

返回json字符串,客户需要解析json字符串

{

"Status":"Success",

"StatusCode":"1",

"Description":"操作成功"

}

参数名称 含义 说明
Status 状态描述 成功返回Success,失败返回Faild
StatusCode 状态吗

状态码,1成功,其他失败,

参见ResltCode定义

Description 状态描述 错误描述

9.4删除报备内容

  1. 请求地址:

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

https://dx.ipyy.net/freeTemplate.aspx (对应utf-8编码方式)

已参数的形式发起请求,例:

http://dx.ipyy.net/freeTemplate.aspx?action=del&account=qq&password=qq&templateid=123

  1. 参数说明
参数名称 含义 说明
userid 企业id 企业ID,不验证
account 用户帐号 用户帐号,由系统管理员分配
password 帐号密码

用md5加密方式,md5采用32位大写

如abc123加密后为

E99A18C428CB38D5F260853678922E03

templateid 报备模板id 报备模板成功时返回的模板唯一标识符
action 任务名称 设置为固定的:del
  1. 返回值说明:

返回json字符串,客户需要解析json字符串

{

"Status":"Success",

"StatusCode":"1",

"Description":"操作成功"

}

参数名称 含义 说明
Status 状态描述 成功返回Success,失败返回Faild
StatusCode 状态吗

状态码,1成功,其他失败,

参见ResltCode定义

Description 状态描述 错误描述

第十章 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 系统内部错误

继续阅读