HTTP接口使用方式
基本参数说明
平台地址:http://www.yt106.com
接口编码:utf-8 提交方式:POST
MD5 校验:123456 加密后 E10ADC3949BA59ABBE56E057F20F883E
Appkey:接口账户的唯一标识
AppSecret:接口账户提交的密钥,主要用来生成 Sign 校验符用
一、提交短信
接口地址:/Interface/Ipost.aspx
提交参数
参数名 | 类型 | 说明 |
Appkey | String | (必选)接口账户的唯一标识 |
Timespan | Double | (必选)时间戳 |
Sign | String | (必选)校验符号,算法组织字符串(Appkey=@Appkey& AppSecret=@AppSecret&Timespan=@Timespan)然后 MD5 加密 |
Mobile | String | (必选)提交短信号码,多个以英文逗号分隔 |
Content | String | (必选)提交的短信内容 |
Channel | String | (可选)提交短信的通道编号,如果有设置通道,设置免审就直接放行,如果没有传递,账户设置免审也 需要审核,由系统客服调整通道下发。 |
Sendtime | String | (可选)提交短信的定时时间 |
Exno | String | (可选)扩展短码,通道支持的情况下可用 |
返回参数:JSON格式
成功代码:{"code":"0","msg":"提交成功","taskid":"1900000000"},taskid 为任务编号,在返回上行和状态的时候会附带任务编号。
失败代码:{"code":"1001","msg":"校验错误"}
详细错误代码详见六
二、获取状态
接口地址:/Interface/IReport.aspx
提交参数
参数名 | 类型 | 说明 |
Appkey | String | (必选)接口账户的唯一标识 |
Timespan | Double | (必选)时间戳 |
Sign | String | (必选)校验符号,算法组织字符串( Appkey=@Appkey& AppSecret=@AppSecret&Timespan=@Timespan) 然后 MD5 加密 |
返回参数:JSON格式
成功代码:{ "code": "0", "msg": "获取成功", "data": [{ "taskid": "100000", "mobile": "151688611686", "status": "DELIVRD", "rdate": "2018-06-12 10:30:20" }, { }] }
失败代码:{"code":"1001","msg":"校验错误"}
详细错误代码详见六
三、获取上行
接口地址:/Interface/IReceive.aspx
提交参数
参数名 | 类型 | 说明 |
Appkey | String | (必选)接口账户的唯一标识 |
Timespan | Double | (必选)时间戳 |
Sign | String | (必选)校验符号,算法组织字符串( Appkey=@Appkey& AppSecret=@AppSecret&Timespan=@Timespan)然后 MD5 加密 |
返回参数:JSON格式
{ "code": "0", "msg": "获取成功", "data": [{ "taskid": "100000", "mobile": "151688611686", "msg": "上行内容", "rdate": "2018-06-12 10:30:20" }, { }] } "taskid": "100000", "mobile": "151688611686", "msg": "上行内容", "rdate": "2018-06-12 10:30:20" }] }
失败代码:{"code":"1001","msg":"校验错误"}
详细错误代码详见六
四、获取余额
接口地址:/Interface/IBlance.aspx
提交参数
参数 | 类型 | 说明 |
Appkey | String | (必选)接口账户的唯一标识 |
Timespan | Double | (必选)时间戳 |
Sign | String | (必选)校验符号,算法组织字符串( Appkey=@Appkey& AppSecret=@AppSecret&Timespan=@Timespan)然后 MD5 加密 |
返回参数:JSON格式
{ "code": "0", "msg": "获取成功", "blance": "888.88 元" }
失败代码:{"code":"1001","msg":"校验错误"}
详细错误代码详见六
五、屏蔽词检测
接口地址:/Interface/ICommon.aspx
提交参数
参数 | 类型 | 说明 |
Appkey | String | (必选)接口账户的唯一标识 |
Timespan | Double | (必选)时间戳 |
Sign | String | (必选)校验符号,算法组织字符串( Appkey=@Appkey& AppSecret=@AppSecret&Timespan=@Timespan)然后 MD5 加密 |
Content | String | 要检测的关键词 |
Channel | Double | 要检测的通道编号 |
返回参数:JSON格式
{ "code": "0", "msg": "获取成功", "data":["屏蔽词1","屏蔽词2"] }
失败代码:{"code":"1001","msg":"校验错误"}
详细错误代码详见六
六、错误代码参考
代码 | 说明 |
0 | 操作成功 |
10001 | 授权校验错误 |
10002 | 帐号被停用 |
10003 | 帐号类型不允许使用(必须是接口用户类型) |
10004 | 提交手机号码为空 |
10005 | 提交短信内容为空 |
10006 | 提交短信内容包括屏蔽词失败 |
10007 | 余额不足,不支持发送当前短信 |
10008 | 定时时间格式不对 |
10009 | 必须输入企业签名,通道要求必须带签名提交 |
10010 | 系统未知错误 |