公共参数

公共请求参数
名称 类型 是否必须 描述
appid String 应用ID
timestamp String 时间戳,格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8,例如:2015-01-01 12:00:00。API服务端允许客户端请求最大时间误差为10分钟,超过的请求即为不合法。
sign_method String 签名的摘要算法,可选值为:hmac,md5。
sign String API 输入参数签名结果,签名算法介绍见下
return_format String 可选值:xml/json,缺省是json
特别注意
令牌(appsecret),请只用于本地加密,不需要上传给服务器,请不要在请求参数中附带!!!当您觉得有可能已经泄露时,请在应用管理里随时重置
签名算法
为了防止API调用过程中被黑客恶意篡改,调用任何一个API都需要携带签名,API服务端会根据请求参数,对签名进行验证,签名不合法的请求将会被拒绝。目前支持的签名算法有两种:MD5(sign_method=md5),HMAC_MD5(sign_method=hmac),签名大体过程如下: 对所有API请求参数(包括公共参数和业务参数,但除去 sign 参数和 byte[]类型的参数),根据参数名称的ASCII码表的顺序排序。如:foo=1, bar=2, foo_bar=3, foobar=4 排序后的顺序是 bar=2, foo=1, foo_bar=3, foobar=4。 将排序好的参数名和参数值拼装在一起,根据上面的示例得到的结果为: bar2foo1foo_bar3foobar4。 把拼装好的字符串采用utf-8 编码,使用签名算法对编码后的字节流进行摘要。如果使用MD5算法,则需要在拼装的字符串前后加上用户的appsecret(令牌)后,再进行摘要, 如:md5(appsecret+bar2foo1foo_bar3foobar4+appsecret);如果使用HMAC_MD5算法,则需要用用户的appsecret(令牌)初始化摘要算法后,再进行摘要,如: hmac_md5(bar2foo1foo_bar3foobar4)。 将摘要得到的字节流结果使用十六进制表示,如:hex(“helloworld”.getBytes(“utf-8”)) = “68656C6C6F776F726C64” 说明:MD5和HMAC_MD5都是128位长度的摘要算法,用16进制表示,一个十六进制的字符能表示4个位,所以签名后的字符串长度固定为32个十六进制字符。
公共返回参数
名称 类型 是否必须 描述
transactId String 交易码,每次交易都有一个唯一的交易码
errorCode String 状态码,0 是正常
msg String 消息
错误码
错误码 错误信息
10001 账号不存在
10002 APPID不存在
10003 TOKEN错误
10004 请求时间不在合理范围内
10005 请求校验码错误
10006 APPID未绑定该产品
11001 资费代码错误
11002 余额不足
12001 请求格式错误
12002 您的请求不存在
12003 providerId格式错误
12004 请求资费代码错误
12005 请求返回错误
12006 请求URL中账号格式不正确
12007 交易ID不存在或过期
12008 没有找到相应的通道
13001 产品不存在或已过期或未订购
13002 手机号码不存在或错误
13003 不支持此手机号码
13004 产品类型错误
13005 产品单价没有定义
13006 产品未定义
13007 产品已过期
13008 产品不可用
13101 资源配置错误
30001 流量充值状态查询参数解析异常
30002 交易记录不存在
30003 交易已存在或未定义
31001 交易正在进行中
31003 交易失败
31004 没有找到合适档位的流量包
31005 流量包代码不匹配手机号
20002 请求短信列表为空或列表格式错误!
20003 请求短信模板错误!
20004 请求subid错误!
20005 请求短信内容超长!
400001 请求reqId不正确
400002 系统繁忙,请稍后重试
400004 号码没有通过审核
400005 没有返回成功
400003 产品未绑定外呼显示号码
400006 验证码必须是数字+字母
400007 密号分配错误
400008 第二被叫号格式错误
50001 部分成功

恭喜您注册成功