关闭
立即体验

立即体验

立即体验
服务类型:
手机号:
验证:
短信内容:

【中昱维信】您的验证码是:****。请不要把验证码泄露给其他人。

您的验证码是:****。

【中昱维信】上海中昱维信全体成员,祝您节日快乐,财源广进!

发彩信 找维信!


发彩信 找维信!

彩信内容承载量大,形式丰富,是政府企业手机报
和会员维护的优选媒体,支持:
●图文彩信 ●音频彩信
●视频彩信 ●国际彩信
9年专业服务,品质保证,咨询热线:400-68-10658

短信验证码接口文档

38319 2019-11-14 15:48:50 中昱维信

1.发送接口

协议说明

协议类目

说明

调用地址

https://vip.veesing.com/smsApi/verifyCode

请求方式

POST(HTTPS)

编码格式

UTF-8

Content-Type

application/x-www-form-urlencoded;charset=utf-8

请求参数(Query)

参数名称

类型

是否必填

描述

示例值

appId

String

账户标识。平台分配给用户的接口调用账户标识,登录平台首页账号信息栏可查看。

2RYN7CQHL1M*****

appKey

String

账户密钥。平台分配给用户的接口调用密钥,登录平台首页账号信息栏,校验身份后可查看。

WVNA4A0*****

phone

String

接收短信的手机号码。

(只支持单个手机号)

156xxxx1090

templateId

String

验证码模板ID。需登录平台申请模板,审核通过后可用。

540

variables

String

验证码值。支持2-8位纯数字。

1234

请求示例

 1import java.io.IOException;
 2import org.apache.commons.httpclient.HttpClient;
 3import org.apache.commons.httpclient.HttpException;
 4import org.apache.commons.httpclient.NameValuePair;
 5import org.apache.commons.httpclient.methods.PostMethod;
 6import com.alibaba.fastjson.JSONObject;
 7import com.veesing.utils.Config;
 8
 9/**
10 * 短信验证码
11 * @author MWH
12 *
13 */
14public class SmsCodeTest {
15    public static void main(String[] args) {
16        // 获取连接
17        HttpClient client = new HttpClient();
18        // 短信验证码API接口地址
19        PostMethod method = new PostMethod("https://vip.veesing.com/smsApi/verifyCode");
20        // 设置编码
21        client.getParams().setContentCharset("UTF-8");
22        method.setRequestHeader("ContentType", "application/x-www-form-urlencoded;charset=utf-8");
23        // 手机号码,一次只能提交一个手机号码
24        String phone = "156xxxx1090";
25        //模板ID(如没有模板ID请先在平台上新增并提交验证码模板,审核通过即可使用)
26        String templateId = "540";
27        // 验证码变量(随机数)
28        Integer num = 1234;
29        String variables = num.toString();
30        System.out.println("验证码是:"+variables);
31        // 拼接参数
32        NameValuePair[] data = { 
33                new NameValuePair("appId", "2RYN7CQHL1M*****"), 
34                new NameValuePair("appKey", "WVNA4A0*****"),
35                new NameValuePair("phone", phone), 
36                new NameValuePair("templateId", templateId), 
37                new NameValuePair("variables", variables) };
38        method.setRequestBody(data);
39        try {
40            client.executeMethod(method);
41            String result = method.getResponseBodyAsString();
42            // 返回结果
43            System.out.println(result);
44            JSONObject jsonObject = JSONObject.parseObject(result);
45            // 返回1则发送成功(逻辑操作请根据接口文档返回参数自行判断)
46            if (jsonObject.get("returnStatus").equals("1")) {
47                System.out.println("成功!");
48            } else {
49                System.out.println("失败!");
50            }
51            // 释放连接
52            method.setRequestHeader("Connection", "close");  
53            method.releaseConnection();
54        } catch (HttpException e) {
55            e.printStackTrace();
56        } catch (IOException e) {
57            e.printStackTrace();
58        }
59    }
60}

更多语言示例,请 点击下载

正常响应示例

1{
2  "returnStatus": "1 ",     //状态码 
3  "message": "成功",          //状态提示信息
4  "remainpoint": "241",   //本次发送后,账户剩余条数
5  "taskId": "3313746",      //下发批次ID(唯一)
6  "successCounts": "1"      //成功条数
7}

异常响应示例

1{
2  "returnStatus": "0",     //状态码 
3  "message": "参数错误",   //状态提示信息
4  "remainpoint": "null",   //本次发送后,账户剩余条数
5  "taskId": "null",          //下发批次ID(唯一)
6  "successCounts": "null"    //成功条数
7}

状态码定义

状态码

状态提示信息

1

发送成功

0

账号或密码错误

0

缺少参数

0

模板不存在或者未通过

0

模板id格式不正确

0

您的账户已被锁定,请联系您的专属客服

0

余额不足

0

手机号码格式不正确

0

该号码今日发送次数已达上限

0

相同手机号码一分钟之内只可发送一次

0

当日发送量已超出最大发送限制

0

未知原因,请联系客服 


2.回执/回复推送接口

触发条件

用户回复短信后,触发回复数据推送,每回复一条,则推送一条;运营商产生短信回执后,触发回执数据推送,每产生一条回执,则推送一条。

使用说明

回执回复数据,由短信平台主动推送到用户设置的地址上,数据格式需遵循标准化数据格式。

协议说明

协议类目

说明

调用方式

主动回调

请求方式

POST(HTTPS)

编码格式

UTF-8

数据交互格式

JSON

回执数据定义

1{
2    "mobile": "1508092****",    //用户手机号码
3    "taskid": "123",                    //发送批次ID
4    "status": "1",                      //回执状态(1.发送成功 0.发送失败)
5    "receivetime": "2019-07-23 17:00:00"        //回执产生时间
6}

回复数据定义

1{
2    "mobile": "1508092****",    //用户手机号码
3    "taskid": "123",                    //发送批次ID
4    "content": "收到",                //用户回复内容
5    "receivetime": "2019-07-23 17:00:00"        //回复时间
6}


3.余额查询接口

协议说明

协议类目

说明

调用地址

https://vip.veesing.com/smsApi/group/getBalance

请求方式

POST(HTTPS)

编码格式

UTF-8

Content-Type

application/x-www-form-urlencoded;charset=utf-8

请求参数(Query)

参数名称

类型

是否必填

描述

示例值

appId

String

账户标识。平台分配给用户的接口调用账户标识,登录平台首页账号信息栏可查看。

2RYN7CQHL1M*****

appKey

String

账户密钥。平台分配给用户的接口调用密钥,登录平台首页账号信息栏,校验身份后可查看。

WVNA4A0*****

请求示例

 1OkHttpClient client = new OkHttpClient().newBuilder()
 2  .followRedirects(false)
 3  .build();
 4MediaType mediaType = MediaType.parse("text/plain");
 5RequestBody body = RequestBody.create(mediaType, "");
 6Request request = new Request.Builder()
 7  .url("https://vip.veesing.com/smsApi/group/getBalance?appId=2RYN7CQHL1M*****&appKey=WVNA4A0*****")
 8  .method("POST", body)
 9  .build();
10Response response = client.newCall(request).execute();

正常响应示例

1{
2  "returnStatus": "1 ",     //状态码 
3  "message": "成功",          //状态提示信息
4  "remainpoint": "241"   //账户剩余条数
5}

异常响应示例

1{
2  "returnStatus": "0",     //状态码 
3  "message": "参数错误",   //状态提示信息
4  "remainpoint": "null"   //账户剩余条数
5}

状态码定义

状态码

状态提示信息

1

提交成功

0

账号或密码错误

0

缺少参数

0

您的账户已被锁定,请联系您的专属客服

0

未知原因,请联系客服 

0

IP受限


客服热线:400-68-10658

企业云通讯平台有奖调研活动 icon

企业云通讯平台有奖调研活动