易约规范短信平台需实现接口

为了支持各种各样的接口来自动对接易约相关软件,我们特此指定以下接口标准,只要按照标准开发即可完美接入

 

通用说明

1.UserKey:为您系统内部自动生成的一个加密key,在请求过程不传输,只用来计算md5,建议用guid或者随机字符,一定要注意不同用户不要重复,且不能容易被猜解

2.每个请求一定要注意验签(判断sign是否为约定好的加密结果),不要被别人猜到了接口地址而利用了

3.如果遇到中文不管是请求还是返回都用utf8编码

 

 

1.获取手机号

http://xxxx.com/GetPhone?UserNo=xxxx&Sign=xxxx&Type=x&NotPrefix=170|171

请求类型:Get

参数说明:

1.1userNo:双方定义好的用户编号,可以是数字或者任意字符

1.2Sign=md5( UserNo+Type+NotPrefix+UserKey) ,只要value 不要key名称,比如100011111333333dffdfdfd4224这样的内容 进行md5加密

1.3Type:0 [所有运营商]，1 [移动]，2 [联通]，3 [电信] 

1.4NotPrefix:不要的号段,以|为分割

返回结果:

1.5请求成功请直接返回 手机号, eg:13800001342 ,如果是国外手机号需要返回区号的请返回手机号|区号的形式,如898966|1 这样的格式

1.6请求失败请返回Err:失败原因,比如密钥错误,没有可用手机号 失败原因用中文utf8返回

 

2.获取指定号码最新的一条短信内容

http://xxxx.com/GetMessage?UserNo=xxxx&Sign=xxxx&Phone=xxx&KeyWord=xxxx

请求类型:Get

参数说明:

2.1userNo:双方定义好的用户编号,可以是数字或者任意字符

2.2Sign=md5(UserNo+Phone+UserKey) ,只要value 不要key名称,比如100011111333333dffdfdfd4224这样的内容 进行md5加密

2.3Phone:需要获取短信的手机号 

2.4KeyWord:短信关键词,如果不为空请只返回包含此关键词的短信

eg: KeyWord=腾讯 的时候,如果有以下2条短信则要返回2.4.1,而不是最新的2.4.2里面的内容

2.4.1换绑密保手机号验证码是123456,欢迎使用腾讯服务.

2.4.2您申请注册易约系统,请输入验证码876543

 

返回结果:

2.4请求成功请直接返回最新的一条短信内容,如果没有短信则返回空字符串即可

2.5请求失败请返回Err:失败原因,比如密钥错误 失败原因用中文utf8返回

 

 

3.用指定号码发送短信

http://xxxx.com/SendMessage?UserNo=xxxx&Sign=xxxx&Phone=xxx&Msg=xxx&TargetNo=xxxx

请求类型:Get

参数说明:

3.1userNo:双方定义好的用户编号,可以是数字或者任意字符

3.2Sign=md5(UserNo+Phone+TargetNo+UserKey) ,只要value 不要key名称,比如100011111333333dffdfdfd4224这样的内容 进行md5加密

3.3Phone:用来发送短信的手机号

3.4Msg:发送的短信内容,注意接收到以后请用utf8解码

3.5TargetNo:目标号码,即短信要发到哪里去

返回结果:

3.4请求成功请直接返回OK(大小写无所谓)

3.5请求失败请返回Err:失败原因,比如密钥错误 失败原因用中文utf8返回

 

4. 拉黑指定号码,表示此号码不可用

http://xxxx.com/AddBlack?UserNo=xxxx&Sign=xxxx&Phone=xxx

请求类型:Get

参数说明:

4.1userNo:双方定义好的用户编号,可以是数字或者任意字符

4.2Sign=md5(UserNo+Phone+UserKey) ,只要value 不要key名称,比如100011111333333dffdfdfd4224这样的内容 进行md5加密

4.3Phone:要拉黑的手机号 

返回结果:

4.4请求成功请直接返回OK(大小写无所谓)

4.5请求失败请返回Err:失败原因,比如密钥错误 失败原因用中文utf8返回