wecom sdk

?If you feel this project is good, please click on the upper right corner of the project to encourage the author, thank you?.

Notice

1. The code is completely open source, please try the sample project carefully before using it.
2. If you encounter a problem that cannot be solved after a series of efforts while trying step 1, please file an issue or solve it by extending the code yourself.

?Introduction

wecom-sdk is the Java implementation of the open source enterprise WeChat open API. It is currently the most complete Java open source implementation. After nearly three years of iteration, enterprise WeChat open interfaces such as address book management, customer management, WeChat customer service, material management, message push, enterprise microbots, identity verification, application management, OA office, and enterprise payment have been implemented. Developers You can quickly and elegantly access corporate WeChat without high learning costs.

?Qiwei Robot Sample

 /**
 * 企微机器人
 *
 * @throws IOException the io exception
 */
@ Test
void webHooks () throws IOException {
        // 发 markdown
        WebhookBody markdownBody = WebhookMarkdownBody . from ( "这里为markdown消息" );
        // 发纯文本
        WebhookBody textBody = WebhookTextBody . from ( "这里为纯文本" );
        // 发图文
        WebhookArticle article = new WebhookArticle ( "这里为标题" , "这里为图文链接" )
                                   . picurl ( "这里为封面图链接" )
                                   . description ( "这里为摘要信息" );
        WebhookBody newsBody = WebhookNewsBody . from ( Collections . singletonList ( article ));
        // 从base64发图片
        String base64 = "图片base64" ;
        String md5 = "图片base64的md5" ;
        WebhookBody imageBody1 = WebhookImageBody . from ( base64 , md5 );
        // 从流发送图片
        String path = "C: \ Users \ Administrator \ Desktop \ 0.png" ;
        InputStream inputStream = Files . newInputStream ( Paths . get ( path ));
        WebhookBody imageBody2 = WebhookImageBody . from ( inputStream );
        WeComResponse weComResponse = WorkWeChatApi . webhookApi (). send ( "机器人key" , markdownBody );
        Assertions . assertTrue ( weComResponse . isSuccessful ());
        
}

See SpringBootWecomSdkTests.java for more examples

characteristic

• Support multiple enterprise WeChat configuration jobs at the same time
• Easy to integrate and suitable for various Java ecosystems
• Currently, more than 200 enterprise WeChat interfaces have been implemented, which can meet the needs of most scenarios.
• Full parameter encapsulation, parameters are highly semantically encapsulated, and you no longer have to worry about organizing parameters and parsing parameters.
• Implement unified callbacks, all callback events can be processed centrally and asynchronously, and developers only need to care about the processing of business logic
• Unified exception handling, enterprise WeChat API call exceptions are uniformly managed by WeComException
• The SDK takes over the Token life cycle, and developers do not need to care about Token management.

At present, self-built applications can be easily adapted, but service providers and agency developers are not open source for the time being.

✍️Technology stack

• Retrofit2, supports the highest version number 2.11.0
• OkHttp4, supports the highest version number 4.12.0
• Rxjava3, supports the highest version number 3.1.8
• Jackson2, supports the highest version number 2.15.2
• XStream, supports the highest version number 1.4.20

?️Maven central warehouse coordinates

• Normal version

< dependency >
    < groupId >cn.felord</ groupId >
    < artifactId >wecom-sdk</ artifactId >
    < version >1.3.2</ version >
</ dependency >

• rxjava version

< dependency >
    < groupId >cn.felord</ groupId >
    < artifactId >rx-wecom-sdk</ artifactId >
    < version >1.3.2</ version >
</ dependency >

• How to find the API you want?

Since the implementation is too complete, if you want to find the API accurately, you can do this:

 public interface TagApi {

    /**
     * 创建标签
     *
     * @param request the request
     * @return GenericResponse generic response
     * @throws WeComException the weComException
     */
    @ POST ( "tag/create" )
    GenericResponse < String > createTag ( @ Body Tag request ) throws WeComException ;
}    

First go to the Enterprise WeChat API documentation to find the API you need, such as creating a tag https://qyapi.weixin.qq.com/cgi-bin/tag/create?access_token=ACCESS_TOKEN , and intercept tag/create to search globally.

• Okhttp low version compatible dependencies

The NoSuchMethod error is reported because your project itself has introduced Okhttp, but the version is relatively low, resulting in incompatibility. You can introduce wecom-sdk through the following dependencies.

< dependency >
    < groupId >cn.felord</ groupId >
    < artifactId >wecom-sdk</ artifactId >
    < version >1.3.2</ version >
    < exclusions >
        < exclusion >
            < groupId >com.squareup.okhttp3</ groupId >
            < artifactId >okhttp</ artifactId >
        </ exclusion >
        < exclusion >
            < groupId >com.squareup.okhttp3</ groupId >
            < artifactId >logging-interceptor</ artifactId >
        </ exclusion >
    </ exclusions >
</ dependency >

< dependency >
    < groupId >com.squareup.okhttp3</ groupId >
    < artifactId >okhttp</ artifactId >
    < version >4.12.0</ version >
</ dependency >

< dependency >
    < groupId >com.squareup.okhttp3</ groupId >
    < artifactId >logging-interceptor</ artifactId >
    < version >4.12.0</ version >
</ dependency >

document

No more documentation, the code is the documentation

?Special thanks