tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

API（Java）

最后更新时间：2024-01-17 14:26:44

    SDK 说明

    本 SDK 提供移动推送服务端接口的 Java 封装，与移动推送后台通信。使用时引用 XingeApp 包即可，本 SDK 封装的主要是 V3 推送相关接口。

    集成方式

    Maven 依赖引用方式：
    <dependency>
                    <groupId>io.github.tpnsPush</groupId>
                    <artifactId>xinge</artifactId>
                    <version>1.2.4.11</version>
    </dependency>
    注意：
    groupId从1.2.4.11版本起有变更。

    使用方法

    XingeApp 接口说明

    该类提供与移动推送后台交互的接口。由 XingeApp.Builder 进行构建，对应参数如下
    参数名
    类型
    必需
    默认值
    参数描述
    appId
    String
    是
    无
    推送目标 AccessID，可在 产品管理 页面获取。
    secretKey
    String
    是
    无
    推送密钥，可在 产品管理 > 应用配置页面获取。
    proxy
    Proxy
    否
    Proxy.NO_PROXY
    如果需要设置代理可以设定该参数。
    connectTimeOut
    Integer
    否
    10s
    链接超时时间设置。
    readTimeOut
    Integer
    否
    10s
    请求超时时间设置。
    domainUrl
    String
    否
    https://openapi.xg.qq.com/
    请求接口服务域名地址，默认为请求信鸽平台的接口地址。使用时需要根据您产品的服务接入点选择 请求服务地址。

    示例

    XingeApp xingeApp = new XingeApp.Builder()
            .appId(appid)
            .secretKey(secretKey)
            .domainUrl(“https://api.tpns.tencent.com/”)    
            .build();
    
    PushAppRequest pushAppRequest = new PushAppRequest();
    //完善PushAppRequest  消息
    ... 
    JSONObject ret =  xingeApp.pushApp(pushAppRequest );

    pushAppRequest 接口说明

    该类提供封装好的推送消息体，各参数说明及使用方法可参考 推送接口说明。

    示例

    说明：
    XingeAppSimple 中包含推送、绑定、解绑等接口的示例。

    Android 单设备推送示例

    public JSONObject pushTokenAndroid() {
            PushAppRequest pushAppRequest = new PushAppRequest();
            pushAppRequest.setAudience_type(AudienceType.token);
            pushAppRequest.setMessage_type(MessageType.notify);
            Message message = new Message();
            message.setTitle("title");
            message.setContent("content");
            pushAppRequest.setMessage(message);
            MessageAndroid messageAndroid = new MessageAndroid();
            message.setAndroid(messageAndroid);
            ArrayList<String> tokenList = new ArrayList();
            tokenList.add("04cac74a714f61bf089********63d880993");
            pushAppRequest.setToken_list(tokenList);
            return this.xingeApp.pushApp(pushAppRequest);
        }

    Android 单账号推送示例

    public JSONObject pushAccountAndroid() {
            PushAppRequest pushAppRequest = new PushAppRequest();
            pushAppRequest.setAudience_type(AudienceType.account);
            pushAppRequest.setPlatform(Platform.android);
            pushAppRequest.setMessage_type(MessageType.notify);
            pushAppRequest.setAccount_push_type(1);
            Message message = new Message();
            message.setTitle("title");
            message.setContent("content");
            MessageAndroid messageAndroid = new MessageAndroid();
            message.setAndroid(messageAndroid);
            pushAppRequest.setMessage(message);
            ArrayList<String> accountList = new ArrayList();
            accountList.add("123");
            pushAppRequest.setAccount_list(accountList);
            return this.xingeApp.pushApp(pushAppRequest);
        }

    Android 标签推送示例

    public JSONObject pushTagAndroid() {
            PushAppRequest pushAppRequest = new PushAppRequest();
            pushAppRequest.setAudience_type(AudienceType.tag);
            pushAppRequest.setPlatform(Platform.android);
            pushAppRequest.setMessage_type(MessageType.notify);
            Message message = new Message();
            message.setTitle("title");
            message.setContent("content");
            MessageAndroid messageAndroid = new MessageAndroid();
            message.setAndroid(messageAndroid);
            pushAppRequest.setMessage(message);
            ArrayList<String> tagList = new ArrayList();
            tagList.add("tag");
            TagListObject tagListObject = new TagListObject();
            tagListObject.setTags(tagList);
            tagListObject.setOp(OpType.OR);
            pushAppRequest.setTag_list(tagListObject);
            return this.xingeApp.pushApp(pushAppRequest);
        }

    Android 全部设备推送示例

    public JSONObject pushAllAndroid() {
            PushAppRequest pushAppRequest = new PushAppRequest();
            pushAppRequest.setAudience_type(AudienceType.all);
            pushAppRequest.setPlatform(Platform.android);
            pushAppRequest.setMessage_type(MessageType.notify);
            Message message = new Message();
            message.setTitle("title");
            message.setContent("content");
            MessageAndroid messageAndroid = new MessageAndroid();
            message.setAndroid(messageAndroid);
            pushAppRequest.setMessage(message);
            return this.xingeApp.pushApp(pushAppRequest);
        }

    iOS 单设备推送示例

    public JSONObject pushTokenIos(){
            PushAppRequest pushAppRequest = new PushAppRequest();
            pushAppRequest.setAudience_type(AudienceType.token);
            pushAppRequest.setEnvironment(Environment.valueOf("dev"));
            pushAppRequest.setMessage_type(MessageType.notify);
            Message message = new Message();
            message.setTitle("title");
            message.setContent("content");
            MessageIOS messageIOS = new MessageIOS();
            Alert alert = new Alert();
            Aps aps = new Aps();
            aps.setAlert(alert);
            messageIOS.setAps(aps);
            message.setIos(messageIOS);
            pushAppRequest.setMessage(message);
            ArrayList<String> tokenList = new ArrayList<String>();
            tokenList.add("0250df875c93c55********536b54fc1c49f");
            pushAppRequest.setToken_list(tokenList);
            return this.xingeApp.pushApp(pushAppRequest);
        }
    

    iOS 单账号推送示例

     public JSONObject pushAccountIos() {
            PushAppRequest pushAppRequest = new PushAppRequest();
            pushAppRequest.setAudience_type(AudienceType.account);
            pushAppRequest.setEnvironment(Environment.valueOf("dev"));
            pushAppRequest.setMessage_type(MessageType.notify);
            Message message = new Message();
            message.setTitle("账号推送");
            message.setContent("content");
            MessageIOS messageIOS = new MessageIOS();
            Alert alert = new Alert();
            Aps aps = new Aps();
            aps.setAlert(alert);
            messageIOS.setAps(aps);
            message.setIos(messageIOS);
            pushAppRequest.setMessage(message);
            ArrayList<String> accountList = new ArrayList();
            accountList.add("1122");
            pushAppRequest.setAccount_list(accountList);
            return this.xingeApp.pushApp(pushAppRequest);
        }
    

    iOS 标签推送示例

    public JSONObject pushTagIos() {
            PushAppRequest pushAppRequest = new PushAppRequest();
            pushAppRequest.setAudience_type(AudienceType.tag);
            pushAppRequest.setEnvironment(Environment.valueOf("dev"));
            pushAppRequest.setMessage_type(MessageType.notify);
            Message message = new Message();
            message.setTitle("标签推送");
            message.setContent("content");
            MessageIOS messageIOS = new MessageIOS();
            Alert alert = new Alert();
            Aps aps = new Aps();
            aps.setAlert(alert);
            messageIOS.setAps(aps);
            message.setIos(messageIOS);
            pushAppRequest.setMessage(message);
            ArrayList<String> tagList = new ArrayList();
            tagList.add("1122");
            TagListObject tagListObject = new TagListObject();
            tagListObject.setTags(tagList);
            tagListObject.setOp(OpType.OR);
            pushAppRequest.setMessage(message);
            pushAppRequest.setTag_list(tagListObject);
            return this.xingeApp.pushApp(pushAppRequest);
        }
    

    iOS 全部设备推送示例

    public JSONObject pushAllIos() {
            PushAppRequest pushAppRequest = new PushAppRequest();
            pushAppRequest.setAudience_type(AudienceType.all);
            pushAppRequest.setEnvironment(Environment.valueOf("dev"));
            pushAppRequest.setMessage_type(MessageType.notify);
            Message message = new Message();
            message.setTitle("全量推送");
            message.setContent("content");
            MessageIOS messageIOS = new MessageIOS();
            Alert alert = new Alert();
            Aps aps = new Aps();
            aps.setAlert(alert);
            messageIOS.setAps(aps);
            message.setIos(messageIOS);
            pushAppRequest.setMessage(message);
            return this.xingeApp.pushApp(pushAppRequest);
        }
    
    

    推送应答示例

    {"result":"{}","environment":"","push_id":"1328245138690125824","err_msg":"NO_ERROR","err_msg_zh":"","ret_code":0,"seq":0}

    服务端返回码

    ret_code 含义可参考 服务端错误码。

    常见问题

    接口返回错误码10101或403是什么原因，如何解决？

    请检查应用 AccessID 与 SecretKey 是否匹配，domainUrl 与产品 服务接入点 是否匹配。

    接口返回错误码1008007，参数校验失败如何解决？

    请参考 推送示例，检查参数填写是否缺失或字段类型填写有误。

    是否有其它开发语言的 SDK ？

    更多服务端 SDK 可前往 SDK 下载 页面获取。

    推送接口返回Peer certificate cannot be authenticated with given CA certificates，如何解决？

    此问题原因是ca证书过期，进入证书目录，通过 openssl 命令进行查看到期时间：
    # openssl x509 -in signed.crt -noout -dates
    signed.crt 修改为您自己服务端上的证书名称。
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款