这里会显示出您选择的修订版和当前版本之间的差别。
两侧同时换到之前的修订记录 前一修订版 | |||
短信:old_api [2017/12/12 02:21] admin |
— (当前版本) | ||
---|---|---|---|
行 1: | 行 1: | ||
- | <html><span style="color:red;font-size:18px;font-weight:bold">本接口已不再维护,本文仅适合老客户维护老接口。</span></html> | ||
- | |||
- | ======对接接口 ====== | ||
- | |||
- | <html><p style=" color:red ;">注意: 为了确保数据隐私和安全, REST API须通过HTTPS方式请求</html> | ||
- | **URL格式** \\ | ||
- | <html><span style="color:red;">https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/{function}/{operation}?sig={SigParameter}</span></html>\\ | ||
- | |||
- | **URL参数属性说明**\\ | ||
- | ^属性 ^ ^说明 ^ | ||
- | |SoftVersion | |云之讯REST API版本号,当前版本号为:2014-06-30 | | ||
- | |Account | |此参数为默认固定值 | | ||
- | |accountSid | | 注册云之讯官网,在控制台中即可获取此参数 | | ||
- | |function | | 业务功能 | | ||
- | |operation | | 业务操作,业务功能的各类具体操作分支 | | ||
- | |SigParameter | | 请求URL必须带有此参数 | | ||
- | |||
- | **HTTP标准包头字段(必填)** \\ | ||
- | ^属性 ^ ^说明 ^ | ||
- | |Accept | |客户端响应接收数据格式:application/xml、application/json | | ||
- | |Content-Type | |类型:application/xml;charset=utf-8、application/json;charset=utf-8 | | ||
- | |Authorization | |验证信息 | | ||
- | |Content-Length | |包体长度 | | ||
- | |||
- | **关键点**\\ | ||
- | <code> | ||
- | SigParameter是REST API 验证参数: | ||
- | 1、URL后必须带有sig参数,sig= MD5(账户Id + 账户授权令牌 + 时间戳),共32位(注:转成大写) | ||
- | 2、使用MD5加密(账户Id + 账户授权令牌 + 时间戳),共32位 | ||
- | 3、时间戳是当前系统时间(24小时制),格式“yyyyMMddHHmmss”。时间戳有效时间为50分钟 | ||
- | </code> | ||
- | <code> | ||
- | Authorization是包头验证信息: | ||
- | 1、使用Base64编码(账户Id + 冒号 + 时间戳) | ||
- | 2、冒号为英文冒号 | ||
- | 3、时间戳是当前系统时间(24小时制),格式“yyyyMMddHHmmss”,需与SigParameter中时间戳相同 | ||
- | </code> | ||
- | |||
- | **开发者信息说明** | ||
- | 1.开发者账号ID--Account Sid | ||
- | a.开发者在UcPaaS平台的唯一标示,在SDK登录、REST请求中使用; | ||
- | b.开发者账号ID在网站注册后,系统自动生成,不可以更改 | ||
- | 2.账户授权令牌--Auth Token | ||
- | a.相当于开发者账号ID(Account Sid)的密码,在SDK登录、REST请求中使用; | ||
- | b.系统自动生成;如果出现开发者Token泄露的情况,系统支持开发者Token重置。 | ||
- | c.需要注册手机进行验证后方可查看 | ||
- | |||
- | ===1 短信发送接口=== | ||
- | 1.appId:创建应用时系统分配的唯一标示,在“应用列表”中可以查询 \\ | ||
- | 2.templateId:创建短信模板时系统分配的唯一标示,在“短信管理”中可以查询\\ | ||
- | 3. to:需要下发短信的手机号码,支持国际号码,需要加国家码。 \\ | ||
- | 4.param:模板中的替换参数,如果有多个参数则需要写在同一个字符串中,以逗号分隔. | ||
- | <html><span style="color:red;">(如:param=“a,b,c”)</span></html> | ||
- | |||
- | <html><span style="color:red;">应用未上线只可以用【应用测试】绑定的号码测试。(点击“【应用测试】进行号码绑定”)</span></html> | ||
- | |||
- | ---- | ||
- | <hidden JSON 请求示例> | ||
- | <code json> | ||
- | POST/2014-06-30/Accounts/e03bc9106c6ed0eaebfce8c368fdcd48/Messages/templateSMS?sig=769190B9A223549407D2164CAE92152E | ||
- | Host:api.ucpaas.com | ||
- | Accept:application/json | ||
- | Content-Type:application/json;charset=utf-8 | ||
- | Authorization:ZTAzYmM5MTA2YzZlZDBlYWViZmNlOGMzNjhmZGNkNDg6MjAxNDA2MjMxODUwMjE= | ||
- | { | ||
- | "templateSMS" : { | ||
- | "appId" : "e462aba25bc6498fa5ada7eefe1401b7", | ||
- | "param" : "0000", | ||
- | "templateId" : "1", | ||
- | "to" : "18612345678" | ||
- | } | ||
- | } | ||
- | </code> | ||
- | </hidden> | ||
- | ---- | ||
- | |||
- | ---- | ||
- | <hidden JSON 响应示例> | ||
- | <code json> | ||
- | { | ||
- | "resp" : { | ||
- | "respCode" : "000000", | ||
- | "failure" : 1, | ||
- | "templateSMS" : { | ||
- | "createDate" : 20140623185016, | ||
- | "smsId" : "f96f79240e372587e9284cd580d8f953" | ||
- | } | ||
- | } | ||
- | } | ||
- | </code> | ||
- | </hidden> | ||
- | ---- | ||
- | |||
- | ---- | ||
- | <hidden XML 请求示例> | ||
- | <code xml> | ||
- | POST/2014-06-30/Accounts/e03bc9106c6ed0eaebfce8c368fdcd48/Messages/templateSMS?sig=7A685B0216D1CA6839C00C2BB18A109D | ||
- | Host:api.ucpaas.com | ||
- | Accept:application/xml | ||
- | Content-Type:application/xml; | ||
- | charset=utf-8 Authorization:ZTAzYmM5MTA2YzZlZDBlYWViZmNlOGMzNjhmZGNkNDg6MjAxNDA2MjMxODQ4NDI= | ||
- | <?xml version="1.0" encoding="UTF-8" standalone="yes"?> | ||
- | <templateSMS> | ||
- | <appId>e462aba25bc6498fa5ada7eefe1401b7</appId> | ||
- | <templateId>1</templateId> | ||
- | <to>18612345678</to> | ||
- | <param>0000</param> | ||
- | </templateSMS> | ||
- | </code> | ||
- | </hidden> | ||
- | ---- | ||
- | |||
- | ---- | ||
- | <hidden XML 响应示例> | ||
- | <code xml> | ||
- | <?xml version="1.0" encoding="UTF-8" standalone="yes"?> | ||
- | <resp> | ||
- | <respCode>000000</respCode> | ||
- | <failure>000000</failure> | ||
- | <templateSMS> | ||
- | <createDate>20140623184836</createDate> <smsId>c04162a0c6da8b241b70f8176f3a93fa</smsId> </templateSMS> | ||
- | </resp> | ||
- | </code> | ||
- | </hidden> | ||
- | ---- | ||
- | ===2 短信状态报告推送接口=== | ||
- | |||
- | 短信验证码状态报告推送接口,平台将验证码通过手机短信的形式发送到用户手机上,并将短信验证码发送状态推送到开发者服务器上(需在开发者后台自助配置接收状态报告服务器的URL地址)。 \\ | ||
- | **• 推送包体** | ||
- | |||
- | ^属性 ^类型 ^约束 ^说明| | ||
- | |type |String |必选 |1:状态报告,2:上行 | | ||
- | |smsid |String |必选 |回状态报告给客户时填充smsId | | ||
- | |status |String |必选 |0:成功;1:提交失败,4:失败,5:关键字(keys),6:黑/白名单,7:超频(overrate),8:unknown | | ||
- | |reportTime |String |必选 |状态报告返回时间 | | ||
- | |desc |String |必选 | | | ||
- | |||
- | **• XML推送示例** | ||
- | <code java> | ||
- | POST /coolweb/voiceCode HTTP/1.1 | ||
- | Host: 172.16.10.32:8080 | ||
- | Content-Type:text/xml;charset=utf-8 | ||
- | Accept:application/xml | ||
- | Content-Length: 461 | ||
- | |||
- | <?xml version="1.0"?> | ||
- | <request> | ||
- | <type>1</type> | ||
- | <smsid>******</smsid> | ||
- | <status>******</status> | ||
- | <reportTime>******</reportTime> | ||
- | <desc>******</desc> | ||
- | </request> | ||
- | </code> | ||
- | |||
- | **• 响应包体** | ||
- | |||
- | ^属性 ^类型 ^约束 ^说明| | ||
- | |retcode |int |必选 |返回错误码,0:成功,非0:失败 | | ||
- | |||
- | **• XML响应示例 ** | ||
- | <code java> | ||
- | <?xml version="1.0" encoding="UTF-8"?> | ||
- | <response> | ||
- | <retcode>0</retcode> | ||
- | </response> | ||
- | </code> | ||