Android接入指南

接入说明：
任何需要调用企业微信API的应用，都需要先在企业微信管理后台创建一个应用，设置完成后，即可使用对应的功能。
不允许跨企业使用，即仅支持企业自己的app使用。

创建应用

1. 管理员登录企业微信管理后台，选择企业应用
   
2. 选择已有应用或添加应用，进入应用详情页面。
   
3. 选择“企业微信授权登录”，在设置界面填写Android的 App的签名&包名，设置完成后系统自动生成应用程序schema。
   

   企业微信分享的设置，复用企业微信授权登录的设置，设置以后登录、分享任何一个都可以使用。

   
   
4. 下载企业微信终端开发工具包
   lib_wwapi-3.0.0.6.aar
   

   SDK名称：企业微信登录/分享SDK
   版本号：3.0.0.6
   主要功能：通过企业微信登录/分享SDK，企业可在自建的app引入sdk，从而可使用企业微信账号登录app，并且在app中分享消息到企业微信。
   使用说明：详见本接入指南
   开发者：深圳市腾讯计算机系统有限公司
   隐私政策：请接入企业微信登录/分享 SDK的开发者，认真阅读《企业微信登录/分享SDK个人信息保护规则》，并确保对企业微信登录/分享SDK的接入使用情况符合上述规则的相关要求。

每个第三方应用必须要导入该sdk库，用于实现与企业微信的通信。Android 11 系统策略更新，请开发者及时适配

5. 搭建开发环境
   在你需要使用企业微信终端API的文件中导入相应的类。
   import com.tencent.wework.api.model.WWMediaText;
6. 在代码中使用开发工具包
   • 注册到企业微信
     要使你的程序启动后企业微信终端能响应你的程序，必须在代码中向企业微信终端注册你的id。可以在程序入口Activity的onCreate回调函数处，或其他合适的地方将你的应用schema注册到企业微信。
     

     	private static final String APPID = "WW1e933be11645237c";
     	private static final String AGENTID = "1000012";
     	private static final String SCHEMA = "wwauth1e933be11645237c000012";
     
     	@Override
     	protected void onCreate(Bundle savedInstanceState) {
     		super.onCreate(savedInstanceState);
     		setContentView(R.layout.activity_main);
     		stringId = getApplicationInfo().labelRes;
     		iwwapi = WWAPIFactory.createWWAPI(this);
     		iwwapi.registerApp(SCHEMA);
     		}

   • 发送请求和接收返回值
     现在，你的程序要发送请求到企业微信终端，可以通过IWWAPI的sendMessage方法来实现。
     boolean sendMessage(BaseMessage msg);
     sendMessage是第三方app主动发送消息给企业微信，发送完成之后会切回到第三方app界面。
     boolean sendMessage(BaseMessage req, IWWAPIEventHandler callback)
     带回调的sendMessage是第三方app向企业微信请求数据，企业微信回应数据之后会切回到第三方app界面。
     sendMessage的实现示例，如下所示：
     

     WWMediaText txt = new WWMediaText(((EditText) findViewById(R.id.et3)).getText().toString());
     txt.appPkg = getPackageName();
     txt.appName = getString(stringId);
     txt.appId = APPID;
     txt.agentId = AGENTID;
     iwwapi.sendMessage(txt);

     
     带回调的sendMessage的实现，如下所示：
     

     final WWAuthMessage.Req req = new WWAuthMessage.Req();
     req.sch = SCHEMA;
     req.appId = APPID;
     req.agentId = AGENTID;
     req.state = "dd";
     iwwapi.sendMessage(req, new IWWAPIEventHandler() {
     	@Override
     	public void handleResp(BaseMessage resp) {
     		if (resp instanceof WWAuthMessage.Resp) {
     			WWAuthMessage.Resp rsp = (WWAuthMessage.Resp) resp;
     			if (rsp.errCode == WWAuthMessage.ERR_CANCEL) {
     			Toast.makeText(MainActivity.this, "登录取消", Toast.LENGTH_SHORT).show();
     			}else if (rsp.errCode == WWAuthMessage.ERR_FAIL) {
     			Toast.makeText(MainActivity.this, "登录失败", Toast.LENGTH_SHORT).show();
     			} else if (rsp.errCode == WWAuthMessage.ERR_OK) {
     			Toast.makeText(MainActivity.this, "登录成功：" + rsp.code,
     			Toast.LENGTH_SHORT).show();
     			}
     		}
     	}
     });

     
     具体要发送的内容由第三方app开发者定义，具体可参考微信开发工具包中的SDK apitest源码。
     注意
     如果需要混淆代码，为了保证sdk的正常使用，需要在proguard.cfg加上下面两行配置：
     

     -keep class com.tencent.wework.api.** {
        *;
     }

     
     至此，你已经能使用企业微信Android开发工具包的API内容了。如果想更详细了解每个API函数的用法，请查阅 Android 平台参考手册 或自行下载阅读企业微信apitest源码。

授权登录接入

开发者需要配合使用企业微信提供的SDK进行授权登录请求接入。正确接入SDK后开发者移动应用会在终端本地拉起企业微信应用进行授权登录，企业微信用户确认后企业微信将回调授权临时票据（code），同时返回开发者移动应用。
Android平台应用授权登录接入代码示例（请参考Android接入指南）：

final WWAuthMessage.Req req = new WWAuthMessage.Req();
req.sch = SCHEMA;
req.appId = APPID;
req.agentId = AGENTID;
req.state = "dd";
iwwapi.sendMessage(req, new IWWAPIEventHandler() {
	@Override
	public void handleResp(BaseMessage resp) {
		if (resp instanceof WWAuthMessage.Resp) {
			WWAuthMessage.Resp rsp = (WWAuthMessage.Resp) resp;
			if (rsp.errCode == WWAuthMessage.ERR_CANCEL) {
			Toast.makeText(MainActivity.this, "登录取消", Toast.LENGTH_SHORT).show();
			}else if (rsp.errCode == WWAuthMessage.ERR_FAIL) {
			Toast.makeText(MainActivity.this, "登录失败", Toast.LENGTH_SHORT).show();
			} else if (rsp.errCode == WWAuthMessage.ERR_OK) {
			Toast.makeText(MainActivity.this, "登录成功：" + rsp.code,
			Toast.LENGTH_SHORT).show();
			}
		}
	}
});

参数说明

参数示例：
appid: WW1e933be11645237c
agentid: 1000012
sch：wwauth1e933be11645237c000012
state: wwapitest

可拉起企业微信打开授权登录页：
返回说明
用户点击授权后，企业微信客户端会被拉起，跳转至授权界面，用户在该界面点击允许或取消，SDK通过回调返回数据给调用方。
返回值
说明

errCode
ERR_OK = 0(用户同意)
ERR_FAIL = 1（授权失败）
ERR_CANCEL = -1（用户取消）

code
用户换取access_token的code，仅在ErrCode为0时有效
state
第三方程序发送时用来标识其请求的唯一性的标志，由第三方程序调用sendMessage时传入，由企业微信终端回传，state字符串长度不能超过1K

通过code获取用户信息

请求方式：GET（HTTPS）
请求地址：https://qyapi.weixin.qq.com/cgi-bin/user/getuserinfo?access_token=ACCESS_TOKEN&code=CODE

参数说明：

权限说明：
跳转的域名须完全匹配企业内任一应用的可信域名。

返回结果：

{
   "UserId":"USERID"
}

出错返回示例：

{
   "errcode": 40029,
   "errmsg": "invalid code"
}

Android 11 系统策略更新，请开发者及时适配

Android 11 版本为加强用户隐私保护引入较多变更，第三方应用需要适配有变更：
软件包可见性变更，会导致第三方应用通过 sdk 接口拉起企业微信受限，从而影响分享消息到企业微信、登陆等功能的正常使用（该变更只对升级targetSdkVersion=30 的应用产生影响）
软件可见性适配方案
1、根据 Android 官方给出的适配方案，在主工程的AndroidManifest.xml 中增加 标签，即可解决以上影响，示例代码如下：

<manifest package="com.example.app">
      ...
      // 在应用的AndroidManifest.xml添加如下<queries>标签
    <queries>
        <package android:name="com.tencent.wework" />   // 指定企业微信包名
    </queries>
      ...
</manifest>

2、添加以上标签之后，需要开发者升级编译工具，否则会出现编译错误。

• Android Studio 需要升级至 3.3 及以上，建议升级至 4.0 及以上版本；
• Android SDK Build-Tools 需要升级至 30 及以上版本；
• com.android.tools.build:gradle 需要升级至 3.6.0 版本，建议升级至最新的 3.6.4 版本。