企业微信接口说明

服务端方法\API目录

目录	方法编码	方法名称	是否实现自动化	用例数
app	API_CleanCookie	清除Cookie
app	API_QueryCorpInfoSimple	查询企业号信息	是	1
app	API_QuerySimpleApp	查询简化版的应用信息	是	1
app	API_QuerySimpleAppByAgentId	根据AgentId查询简化版的应用信息	是	1
app	getSystemValueByParamKey]	获取微信系统设置值	是	2
contactsservice	API_ContactsService_Simple	微信企业号的通信录服务
contactsservice	API_ContactsServiceLogger_Simple](##API说明!C262)	获取微信通信录服务的日志内容
contactsservice	API_VbaseDataCheck_Simple	vbase数据校验
material	API_GetTemporaryMaterialSimple	获取临时素材文件	是	1
material	API_UploadTemporaryMaterialSimple	上传临时素材文件	是	1
menu	API_Create_QY_MenuSimple	创建简化版微信企业号的应用菜单	是	1
menu	API_Get_QY_MenuSimple	获取简化版微信企业号的应用菜单	是	1
private	getAccessToken	获取accessToken	是	1
private	getIsExecuteRemote	是否远程调用构件方法	是	1
sendmessage	API_GetTag_Simple	获取标签成员
sendmessage	API_GetUser_Simple](##API说明!C582)	获取成员信息
sendmessage	API_ListDepartment_Simple	获取微信部门列表
sendmessage	API_ListTag_Simple	获取标签列表	是	1
sendmessage	API_ListUser_Simple	获取部门成员(详情)	是	1
sendmessage	API_SendFileMessage_Simple](##API说明!C728)	发送文件消息	是	15
sendmessage	API_SendImageMessage_Simple	发送图片消息	是	5
sendmessage	API_SendMpnewsWithContentMessage_Simple	发送图文消息	是	6
sendmessage	API_SendNewsMessage_Simple	发送news消息	是	6
sendmessage	API_SendSoundVoiceMessage_Simple	发送语音消息	是	5
sendmessage	API_SendTextcardMessageAction_Simple	发送Textcard消息	是	5
sendmessage	API_SendTextMessage_Simple	发送文本消息	是	5
sendmessage	API_SendVideoMessage_Simple	发送视频文件消息	是	5
configValue	API_QuerySimpleConfig	查询简化版企业号的配置信息	是	1
configValue	API_SaveSimpleConfig	保存简化版企业号的配置信息

服务端方法\app

post

API_CleanCookie

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_CleanCookie

API属性	值
API编码	API_CleanCookie
API名称	清除Cookie
API描述
请求方式	POST

参数说明:

编码	名称	类型	初始值	必须	描述

返回值说明:

编码	名称	类型	初始值	描述
isSuccess	是否成功	布尔
errorMsg	异常信息	文本

返回示例：

{
  "isSuccess": true,
  "errorMsg": "errorMsg_text"
}

post

API_QueryCorpInfoSimple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_QueryCorpInfoSimple

API属性	值
API编码	API_QueryCorpInfoSimple
API名称	查询企业号信息
API描述
请求方式	POST

参数说明:

编码	名称	类型	初始值	必须	描述

返回值说明:

编码	名称	类型
AppProvider	应用提供商基本信息	实体
isSuccess	是否成功	布尔
errorMsg	异常信息	文本

AppProvider实体字段:

字段编码	字段编码	字段类型	长度
id	id	文本	255
ProviderBizCode	提供商的业务编码	文本	255
ProviderLogo	企业Logo	文本	255
ProviderName	企业简称	文本	255
ProviderIntro	企业简介	文本	255
ProviderWebsite	企业官网	文本	255
UpdateTime	更新时间	文本	255
CreateTime	创建时间	文本	255
ProviderCorpId	供应商CropId	文本	255
Secret	管理密钥	文本	255

返回示例：

{
  "AppProvider": 
    {
      "id": "id_text1",
      "ProviderBizCode": "ProviderBizCode_text1",
      "ProviderLogo": "ProviderLogo_text1",
      "ProviderName": "ProviderName_text1",
      "ProviderIntro": "ProviderIntro_text1",
      "ProviderWebsite": "ProviderWebsite_text1",
      "UpdateTime": "UpdateTime_text1",
      "CreateTime": "CreateTime_text1",
      "ProviderCorpId": "ProviderCorpId_text1",
      "Secret": "Secret_text1"
    },
    {
      "id": "id_text2",
      "ProviderBizCode": "ProviderBizCode_text2",
      "ProviderLogo": "ProviderLogo_text2",
      "ProviderName": "ProviderName_text2",
      "ProviderIntro": "ProviderIntro_text2",
      "ProviderWebsite": "ProviderWebsite_text2",
      "UpdateTime": "UpdateTime_text2",
      "CreateTime": "CreateTime_text2",
      "ProviderCorpId": "ProviderCorpId_text2",
      "Secret": "Secret_text2"
    }
  ],
  "isSuccess": true,
  "errorMsg": "errorMsg_text"
}

post

API_QuerySimpleApp

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_QuerySimpleApp

API属性	值
API编码	API_QueryCorpInfoSimple
API名称	查询简化版的应用信息
API描述
请求方式	POST

参数说明:

编码	名称	类型	初始值	必须	描述
simpleAppBizCode	简化版应用业务编码	文本		否

参数示例：

{
  "simpleAppBizCode": "simpleAppBizCode_text"
}

返回值说明:

编码	名称	类型
simpleApp	简化版应用信息	实体
isSuccess	是否成功	布尔
errorMsg	异常信息	文本

simpleApp实体：

字段编码	字段编码	字段类型	长度
id	id	文本	255
ProviderBizCode	所属提供商信息，作为外键信息	文本	255
SimpleAppBizCode	应用业务编码	文本	255
SimpleAppIntro	应用介绍	文本	255
ReceiveServiceEventURL	服务事件接收URL	长文本	1000
Token	Token	文本	255
EncodingAESKey	EncodingAESKey	文本	255
AgentId	应用AgentId	文本	255
Secret	应用Secret	文本	255
UpdateTime	更新时间	文本	255
CreateTime	创建时间	文本	255
SimpleAppName	应用名称	文本	255
Website	可信域名	文本	255
OAuthURL	OAuth验证url	长文本	1000
OAuthCallbackURL	OAuth验证回调url	长文本	1000
WxVersion	微信的版本	文本	255
SimpleAppLogo	logo图标	文本	255

返回示例：

{
  "isSuccess": true,
  "errorMsg": "errorMsg_text",
  "simpleApp": 
    {
      "id": "id_text1",
      "ProviderBizCode": "ProviderBizCode_text1",
      "SimpleAppBizCode": "SimpleAppBizCode_text1",
      "SimpleAppIntro": "SimpleAppIntro_text1",
      "ReceiveServiceEventURL": "ReceiveServiceEventURL_text1",
      "Token": "Token_text1",
      "EncodingAESKey": "EncodingAESKey_text1",
      "AgentId": "AgentId_text1",
      "Secret": "Secret_text1",
      "UpdateTime": "UpdateTime_text1",
      "CreateTime": "CreateTime_text1",
      "SimpleAppName": "SimpleAppName_text1",
      "Website": "Website_text1",
      "OAuthURL": "OAuthURL_text1",
      "OAuthCallbackURL": "OAuthCallbackURL_text1",
      "WxVersion": "WxVersion_text1",
      "SimpleAppLogo": "SimpleAppLogo_text1"
    },
    {
      "id": "id_text2",
      "ProviderBizCode": "ProviderBizCode_text2",
      "SimpleAppBizCode": "SimpleAppBizCode_text2",
      "SimpleAppIntro": "SimpleAppIntro_text2",
      "ReceiveServiceEventURL": "ReceiveServiceEventURL_text2",
      "Token": "Token_text2",
      "EncodingAESKey": "EncodingAESKey_text2",
      "AgentId": "AgentId_text2",
      "Secret": "Secret_text2",
      "UpdateTime": "UpdateTime_text2",
      "CreateTime": "CreateTime_text2",
      "SimpleAppName": "SimpleAppName_text2",
      "Website": "Website_text2",
      "OAuthURL": "OAuthURL_text2",
      "OAuthCallbackURL": "OAuthCallbackURL_text2",
      "WxVersion": "WxVersion_text2",
      "SimpleAppLogo": "SimpleAppLogo_text2"
    }
  ]
}

post

API_QuerySimpleAppByAgentId

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_QuerySimpleAppByAgentId

API属性	值
API编码	API_QuerySimpleAppByAgentId
API名称	根据AgentId查询简化版的应用信息
API描述
请求方式	POST

参数说明:

编码	名称	类型	初始值	必须	描述
AgentId	简化版应用业务编码	文本		否

参数示例:

{
  "AgentId": "AgentId_text"
}

返回值说明:

编码	名称	类型
simpleApp	简化版应用信息简化版企业号通用配置	实体
isSuccess	是否成功	布尔
errorMsg	异常信息	文本

simpleApp实体：

字段编码	字段编码	字段类型	长度
id	id	文本	255
ProviderBizCode	所属提供商信息，作为外键信息	文本	255
SimpleAppBizCode	应用业务编码	文本	255
SimpleAppIntro	应用介绍	文本	255
ReceiveServiceEventURL	服务事件接收URL	长文本	1000
Token	Token	文本	255
EncodingAESKey	EncodingAESKey	文本	255
AgentId	应用AgentId	文本	255
Secret	应用Secret	文本	255
UpdateTime	更新时间	文本	255
CreateTime	创建时间	文本	255
SimpleAppName	应用名称	文本	255
Website	可信域名	文本	255
OAuthURL	OAuth验证url	长文本	1000
OAuthCallbackURL	OAuth验证回调url	长文本	1000
WxVersion	微信的版本	文本	255
SimpleAppLogo	logo图标	文本	255

返回示例：

{
  "isSuccess": true,
  "errorMsg": "errorMsg_text",
  "simpleApp": 
    {
      "id": "id_text1",
      "ProviderBizCode": "ProviderBizCode_text1",
      "SimpleAppBizCode": "SimpleAppBizCode_text1",
      "SimpleAppIntro": "SimpleAppIntro_text1",
      "ReceiveServiceEventURL": "ReceiveServiceEventURL_text1",
      "Token": "Token_text1",
      "EncodingAESKey": "EncodingAESKey_text1",
      "AgentId": "AgentId_text1",
      "Secret": "Secret_text1",
      "UpdateTime": "UpdateTime_text1",
      "CreateTime": "CreateTime_text1",
      "SimpleAppName": "SimpleAppName_text1",
      "Website": "Website_text1",
      "OAuthURL": "OAuthURL_text1",
      "OAuthCallbackURL": "OAuthCallbackURL_text1",
      "WxVersion": "WxVersion_text1",
      "SimpleAppLogo": "SimpleAppLogo_text1"
    },
    {
      "id": "id_text2",
      "ProviderBizCode": "ProviderBizCode_text2",
      "SimpleAppBizCode": "SimpleAppBizCode_text2",
      "SimpleAppIntro": "SimpleAppIntro_text2",
      "ReceiveServiceEventURL": "ReceiveServiceEventURL_text2",
      "Token": "Token_text2",
      "EncodingAESKey": "EncodingAESKey_text2",
      "AgentId": "AgentId_text2",
      "Secret": "Secret_text2",
      "UpdateTime": "UpdateTime_text2",
      "CreateTime": "CreateTime_text2",
      "SimpleAppName": "SimpleAppName_text2",
      "Website": "Website_text2",
      "OAuthURL": "OAuthURL_text2",
      "OAuthCallbackURL": "OAuthCallbackURL_text2",
      "WxVersion": "WxVersion_text2",
      "SimpleAppLogo": "SimpleAppLogo_text2"
    }
  ]
}

post

getSystemValueByParamKey

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/getSystemValueByParamKey

API属性	值
API编码	getSystemValueByParamKey
API名称	获取微信系统设置值
API描述
请求方式	POST

参数说明:

编码	名称	类型	初始值	必须	描述
paramKey	键	文本		否

参数示例:

{
  "paramKey": "paramKey_text"
}

返回值说明:

编码	名称	类型	初始值	描述
paramValue	键	文本

返回示例：

{
  "paramValue": "paramValue_text"
}

服务端方法\configValue

post

API_QuerySimpleConfig

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_QuerySimpleConfig

API属性	值
API编码	API_QuerySimpleAppByAgentId
API名称	查询简化版企业号的配置信息
API描述
请求方式	POST

参数说明:

编码	名称	类型	初始值	必须	描述

返回值说明:

编码	名称	类型	初始值	描述
`v_wx_qy_simple_config`	简化版企业号通用配置	实体

v_wx_qy_simple_config实体：

字段编码	字段编码	字段类型	长度	字段描述
id		文本	64
isExecuteRemote	是否远程调用构件方法	布尔
simpleAppName	应用名称	文本	255
simpleAppBizCode	应用业务编码	文本		套件业务编码
WxVersion	微信的版本	文本	255

返回示例：

{
  "v_wx_qy_simple_config": 
    {
      "id": "id_text1",
      "isExecuteRemote": true,
      "simpleAppName": "simpleAppName_text1",
      "simpleAppBizCode": "simpleAppBizCode_text1",
      "WxVersion": "WxVersion_text1"
    },
    {
      "id": "id_text2",
      "isExecuteRemote": true,
      "simpleAppName": "simpleAppName_text2",
      "simpleAppBizCode": "simpleAppBizCode_text2",
      "WxVersion": "WxVersion_text2"
    }
  ]
}

post

API_SaveSimpleConfig

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_QuerySimpleConfig

API属性	值
API编码	API_SaveSimpleConfig
API名称	保存简化版企业号的配置信息
API描述
请求方式	POST

参数说明:

编码	名称	类型	初始值	必须	描述
v_wx_qy_simple_config	简化版企业号通用配置	实体		否

v_wx_qy_simple_config实体：

字段编码	字段编码	字段类型	长度	字段描述
id		文本	64
isExecuteRemote	是否远程调用构件方法	布尔
simpleAppName	应用名称	文本	255
simpleAppBizCode	应用业务编码	文本		套件业务编码
WxVersion	微信的版本	文本	255

参数示例:

{
  "v_wx_qy_simple_config": 
    {
      "id": "id_text1",
      "isExecuteRemote": true,
      "simpleAppName": "simpleAppName_text1",
      "simpleAppBizCode": "simpleAppBizCode_text1",
      "WxVersion": "WxVersion_text1"
    },
    {
      "id": "id_text2",
      "isExecuteRemote": true,
      "simpleAppName": "simpleAppName_text2",
      "simpleAppBizCode": "simpleAppBizCode_text2",
      "WxVersion": "WxVersion_text2"
    }
  ]
}

返回值说明:

编码	名称	类型	初始值	描述

返回示例：

服务端方法\contactsservice

post

API_ContactsService_Simple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_ContactsService_Simple

API属性	值
API编码	API_ContactsService_Simple
API名称	微信企业号的通信录服务
API描述	通过数据校验后得到的合法数据为该方法的输入数据。该方法负责将数据的输入并且启动通信录的线程服务，该方法的运行结束并不代表通信录服务结束，具体要看看VWX_ContactServiceLogger的跟踪情况而定。
请求方式	POST

参数示例:

编码	名称	类型	必须
vbaseUser	vbase人员数据	实体	否
vbaseOrganization	vbase机构数据	实体	否
performType	异步操作类型	整数	否
simpleAppCode	应用编码	文本	否

vbaseUser实体：

字段编码	字段编码	字段类型	长度
id	唯一id	文本	255
o_id	机构id	文本	255
o_orgName	机构名称	文本	255
u_wx_departmentId	微信端的部门id	文本	255
u_mobile	人员的电话号码	文本	255
u_email	人员的电子邮箱	文本	255
u_userName	人员的名称	文本	255
u_duties	人员的职务	文本	255
a_id	人员的账号id	文本	255
a_account	人员的账号名称	文本	255

vbaseOrganization实体：

字段编码	字段编码	字段类型	长度
id	唯一id	文本	255
o_id	机构id	文本	255
o_orgName	机构名称	文本	255
pid	机构的pid	文本	255
orderNo	排序号	文本	255
o_wx_id	微信端的id	整数	50
o_wx_pid	微信端的pid	整数	50

参数示例:

{
  "vbaseUser": 
    {
      "id": "id_text1",
      "o_id": "o_id_text1",
      "o_orgName": "o_orgName_text1",
      "u_wx_departmentId": "u_wx_departmentId_text1",
      "u_mobile": "u_mobile_text1",
      "u_email": "u_email_text1",
      "u_userName": "u_userName_text1",
      "u_duties": "u_duties_text1",
      "a_id": "a_id_text1",
      "a_account": "a_account_text1"
    },
    {
      "id": "id_text2",
      "o_id": "o_id_text2",
      "o_orgName": "o_orgName_text2",
      "u_wx_departmentId": "u_wx_departmentId_text2",
      "u_mobile": "u_mobile_text2",
      "u_email": "u_email_text2",
      "u_userName": "u_userName_text2",
      "u_duties": "u_duties_text2",
      "a_id": "a_id_text2",
      "a_account": "a_account_text2"
    }
  ],
  "vbaseOrganization": 
    {
      "id": "id_text1",
      "o_id": "o_id_text1",
      "o_orgName": "o_orgName_text1",
      "pid": "pid_text1",
      "orderNo": "orderNo_text1",
      "o_wx_id": 1,
      "o_wx_pid": 1
    },
    {
      "id": "id_text2",
      "o_id": "o_id_text2",
      "o_orgName": "o_orgName_text2",
      "pid": "pid_text2",
      "orderNo": "orderNo_text2",
      "o_wx_id": 1,
      "o_wx_pid": 1
    }
  ],
  "performType": 1,
  "simpleAppCode": "simpleAppCode_text"
}

返回值说明:

编码	名称	类型
isSuccess	是否成功	布尔
errorMsg	异常信息	文本
loggerId	日志id	文本

返回示例：

{
  "isSuccess": true,
  "errorMsg": "errorMsg_text",
  "loggerId": "loggerId_text"
}

post

API_ContactsServiceLogger_Simple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_ContactsServiceLogger_Simple

API属性	值
API编码	API_ContactsServiceLogger_Simple
API名称	获取微信通信录服务的日志内容
API描述	该方法主要用于检测通信录的更新进度.目前通信录服务有11个刻度。从通信录服务开始起，每隔1秒将获取一次，并返回每一次的进度值。直至通信录服务成功结束或者异常结束。
请求方式	POST

参数示例:

编码	名称	类型	初始值	必须	描述
loggerId	日志id	文本		否

参数示例:

{
  "loggerId": "loggerId_text"
}

返回值说明:

编码	名称	类型
messageKey	消息的key	文本
messageValue	消息的value	文本
schedule	执行的进度	小数

返回示例：

{
  "messageKey": "messageKey_text",
  "messageValue": "messageValue_text",
  "schedule": 1.0
}

post

API_VbaseDataCheck_Simple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_VbaseDataCheck_Simple

API属性 值
API编码 API_VbaseDataCheck_Simple
API名称 vbase数据校验
API描述 该方法用于通信录服务的最开始的vbase机构人员的数据检查；要求如下：
1、同一层级的部门不能有相同的部门名称
2、人员的姓名、账号不能为空，手机号码与电子邮箱号码不能同时为空。
3、手机号码必须以1开头符合11位数字的号码，
手机号码与电子邮箱号码的检测用网上常用的正则表达式进行认证。
4、手机号码与电子邮箱号码必须唯一,
如果vbase的机构人员数据符合上述要求将通过，否则拒绝添加非法的机构人员数据。
请求方式 POST
参数示例:
编码 名称 类型 初始值 必须 描述
vbaseOrganization 输入的机构数据 实体 否 
vbaseUser 输入的vbase的机构人员数据 实体 否 
vbaseOrganization实体
字段编码 字段编码 字段类型 长度 精度 字段初始值 字段描述
id 记录唯一ID 文本 255 
o_id 机构ID 文本 255 
o_orgName 机构名称 文本 255 
pid 父节点ID 文本 255 
innerCode 层级码编号 文本 255 
orderNo 排序号 文本 255 
isLeaf 是否叶子 文本 255 
name 树节点名称 文本 255 
illegalReason 非法原因 文本 255 
processData 处理操作 文本 255 
vbaseUser实体
字段编码 字段编码 字段类型 长度 精度 字段初始值 字段描述
id 记录唯一ID 文本 255 
o_id 机构ID 文本 255 
o_orgName 机构名称 文本 255 
u_id 人员id 文本 255 
u_mobile 人员手机 文本 255 
u_email 人员邮件 文本 255 
u_duties 人员职务 文本 255 
u_userName 人员姓名 文本 255 
a_id 账号id 文本 255 
a_account 账号名称 文本 255 
illegalReason 非法原因 文本 255 
processData 处理操作 文本 255 
参数示例:
{
  "vbaseOrganization": 
    {
      "id": "id_text1",
      "o_id": "o_id_text1",
      "o_orgName": "o_orgName_text1",
      "pid": "pid_text1",
      "innerCode": "innerCode_text1",
      "orderNo": "orderNo_text1",
      "isLeaf": "isLeaf_text1",
      "name": "name_text1",
      "illegalReason": "illegalReason_text1",
      "processData": "processData_text1"
    },
    {
      "id": "id_text2",
      "o_id": "o_id_text2",
      "o_orgName": "o_orgName_text2",
      "pid": "pid_text2",
      "innerCode": "innerCode_text2",
      "orderNo": "orderNo_text2",
      "isLeaf": "isLeaf_text2",
      "name": "name_text2",
      "illegalReason": "illegalReason_text2",
      "processData": "processData_text2"
    }
  ],
  "vbaseUser": 
    {
      "id": "id_text1",
      "o_id": "o_id_text1",
      "o_orgName": "o_orgName_text1",
      "u_id": "u_id_text1",
      "u_mobile": "u_mobile_text1",
      "u_email": "u_email_text1",
      "u_duties": "u_duties_text1",
      "u_userName": "u_userName_text1",
      "a_id": "a_id_text1",
      "a_account": "a_account_text1",
      "illegalReason": "illegalReason_text1",
      "processData": "processData_text1"
    },
    {
      "id": "id_text2",
      "o_id": "o_id_text2",
      "o_orgName": "o_orgName_text2",
      "u_id": "u_id_text2",
      "u_mobile": "u_mobile_text2",
      "u_email": "u_email_text2",
      "u_duties": "u_duties_text2",
      "u_userName": "u_userName_text2",
      "a_id": "a_id_text2",
      "a_account": "a_account_text2",
      "illegalReason": "illegalReason_text2",
      "processData": "processData_text2"
    }
  ]
}
返回值说明:
编码 名称 类型 初始值 描述
legalityVbaseOrganization 合法的vbase机构数据 实体 
illegalVbaseOrganization 非法的vbase机构数据 实体 
legalityVbaseUser 合法的vbase人员数据 实体 
illegalVbaseUser 非法的vbase人员数据 实体 
legalityVbaseOrganization实体
| 字段编码      | 字段编码   | 字段类型 | 长度 | 精度 | 字段初始值 |
| ------------- | ---------- | -------- | ---- | ---- | ---------- |
| id            | 记录唯一ID | 文本     | 255  |      |            |
| o_id          | 机构ID     | 文本     | 255  |      |            |
| o_orgName     | 机构名称   | 文本     | 255  |      |            |
| pid           | 父节点ID   | 文本     | 255  |      |            |
| innerCode     | 层级码编号 | 文本     | 255  |      |            |
| orderNo       | 排序号     | 文本     | 255  |      |            |
| isLeaf        | 是否叶子   | 文本     | 255  |      |            |
| name          | 树节点名称 | 文本     | 255  |      |            |
| illegalReason | 非法原因   | 文本     | 255  |      |            |
| processData   | 处理操作   | 文本     | 255  |      |            |
illegalVbaseOrganization实体
| 字段编码      | 字段编码   | 字段类型 | 长度 | 精度 | 字段初始值 |
| ------------- | ---------- | -------- | ---- | ---- | ---------- |
| id            | 记录唯一ID | 文本     | 255  |      |            |
| o_id          | 机构ID     | 文本     | 255  |      |            |
| o_orgName     | 机构名称   | 文本     | 255  |      |            |
| pid           | 父节点ID   | 文本     | 255  |      |            |
| innerCode     | 层级码编号 | 文本     | 255  |      |            |
| orderNo       | 排序号     | 文本     | 255  |      |            |
| isLeaf        | 是否叶子   | 文本     | 255  |      |            |
| name          | 树节点名称 | 文本     | 255  |      |            |
| illegalReason | 非法原因   | 文本     | 255  |      |            |
| processData   | 处理操作   | 文本     | 255  |      |            |
legalityVbaseUser实体
| 字段编码      | 字段编码   | 字段类型 | 长度 | 精度 | 字段初始值 |
| ------------- | ---------- | -------- | ---- | ---- | ---------- |
| id            | 记录唯一ID | 文本     | 255  |      |            |
| o_id          | 机构ID     | 文本     | 255  |      |            |
| o_orgName     | 机构名称   | 文本     | 255  |      |            |
| u_id          | 人员id     | 文本     | 255  |      |            |
| u_mobile      | 人员手机   | 文本     | 255  |      |            |
| u_email       | 人员邮件   | 文本     | 255  |      |            |
| u_duties      | 人员职务   | 文本     | 255  |      |            |
| u_userName    | 人员姓名   | 文本     | 255  |      |            |
| a_id          | 账号id     | 文本     | 255  |      |            |
| a_account     | 账号名称   | 文本     | 255  |      |            |
| illegalReason | 非法原因   | 文本     | 255  |      |            |
| processData   | 处理操作   | 文本     | 255  |      |            |
illegalVbaseUser实体
| 字段编码      | 字段编码   | 字段类型 | 长度 | 精度 | 字段初始值 |
| ------------- | ---------- | -------- | ---- | ---- | ---------- |
| id            | 记录唯一ID | 文本     | 255  |      |            |
| o_id          | 机构ID     | 文本     | 255  |      |            |
| o_orgName     | 机构名称   | 文本     | 255  |      |            |
| u_id          | 人员id     | 文本     | 255  |      |            |
| u_mobile      | 人员手机   | 文本     | 255  |      |            |
| u_email       | 人员邮件   | 文本     | 255  |      |            |
| u_duties      | 人员职务   | 文本     | 255  |      |            |
| u_userName    | 人员姓名   | 文本     | 255  |      |            |
| a_id          | 账号id     | 文本     | 255  |      |            |
| a_account     | 账号名称   | 文本     | 255  |      |            |
| illegalReason | 非法原因   | 文本     | 255  |      |            |
| processData   | 处理操作   | 文本     | 255  |      |            |
返回示例：
{
  "legalityVbaseOrganization": 
    {
      "id": "id_text1",
      "o_id": "o_id_text1",
      "o_orgName": "o_orgName_text1",
      "pid": "pid_text1",
      "innerCode": "innerCode_text1",
      "orderNo": "orderNo_text1",
      "isLeaf": "isLeaf_text1",
      "name": "name_text1",
      "illegalReason": "illegalReason_text1",
      "processData": "processData_text1"
    },
    {
      "id": "id_text2",
      "o_id": "o_id_text2",
      "o_orgName": "o_orgName_text2",
      "pid": "pid_text2",
      "innerCode": "innerCode_text2",
      "orderNo": "orderNo_text2",
      "isLeaf": "isLeaf_text2",
      "name": "name_text2",
      "illegalReason": "illegalReason_text2",
      "processData": "processData_text2"
    }
  ],
  "illegalVbaseOrganization": 
    {
      "id": "id_text1",
      "o_id": "o_id_text1",
      "o_orgName": "o_orgName_text1",
      "pid": "pid_text1",
      "innerCode": "innerCode_text1",
      "orderNo": "orderNo_text1",
      "isLeaf": "isLeaf_text1",
      "name": "name_text1",
      "illegalReason": "illegalReason_text1",
      "processData": "processData_text1"
    },
    {
      "id": "id_text2",
      "o_id": "o_id_text2",
      "o_orgName": "o_orgName_text2",
      "pid": "pid_text2",
      "innerCode": "innerCode_text2",
      "orderNo": "orderNo_text2",
      "isLeaf": "isLeaf_text2",
      "name": "name_text2",
      "illegalReason": "illegalReason_text2",
      "processData": "processData_text2"
    }
  ],
  "legalityVbaseUser": 
    {
      "id": "id_text1",
      "o_id": "o_id_text1",
      "o_orgName": "o_orgName_text1",
      "u_id": "u_id_text1",
      "u_mobile": "u_mobile_text1",
      "u_email": "u_email_text1",
      "u_duties": "u_duties_text1",
      "u_userName": "u_userName_text1",
      "a_id": "a_id_text1",
      "a_account": "a_account_text1",
      "illegalReason": "illegalReason_text1",
      "processData": "processData_text1"
    },
    {
      "id": "id_text2",
      "o_id": "o_id_text2",
      "o_orgName": "o_orgName_text2",
      "u_id": "u_id_text2",
      "u_mobile": "u_mobile_text2",
      "u_email": "u_email_text2",
      "u_duties": "u_duties_text2",
      "u_userName": "u_userName_text2",
      "a_id": "a_id_text2",
      "a_account": "a_account_text2",
      "illegalReason": "illegalReason_text2",
      "processData": "processData_text2"
    }
  ],
  "illegalVbaseUser": 
    {
      "id": "id_text1",
      "o_id": "o_id_text1",
      "o_orgName": "o_orgName_text1",
      "u_id": "u_id_text1",
      "u_mobile": "u_mobile_text1",
      "u_email": "u_email_text1",
      "u_duties": "u_duties_text1",
      "u_userName": "u_userName_text1",
      "a_id": "a_id_text1",
      "a_account": "a_account_text1",
      "illegalReason": "illegalReason_text1",
      "processData": "processData_text1"
    },
    {
      "id": "id_text2",
      "o_id": "o_id_text2",
      "o_orgName": "o_orgName_text2",
      "u_id": "u_id_text2",
      "u_mobile": "u_mobile_text2",
      "u_email": "u_email_text2",
      "u_duties": "u_duties_text2",
      "u_userName": "u_userName_text2",
      "a_id": "a_id_text2",
      "a_account": "a_account_text2",
      "illegalReason": "illegalReason_text2",
      "processData": "processData_text2"
    }
  ]
}

API属性	值
API编码	API_VbaseDataCheck_Simple
API名称	vbase数据校验
API描述	该方法用于通信录服务的最开始的vbase机构人员的数据检查；要求如下： 1、同一层级的部门不能有相同的部门名称 2、人员的姓名、账号不能为空，手机号码与电子邮箱号码不能同时为空。 3、手机号码必须以1开头符合11位数字的号码，手机号码与电子邮箱号码的检测用网上常用的正则表达式进行认证。 4、手机号码与电子邮箱号码必须唯一, 如果vbase的机构人员数据符合上述要求将通过，否则拒绝添加非法的机构人员数据。
请求方式	POST

编码	名称	类型	初始值	必须	描述
vbaseOrganization	输入的机构数据	实体		否
vbaseUser	输入的vbase的机构人员数据	实体		否

字段编码	字段编码	字段类型	长度
id	记录唯一ID	文本	255
o_id	机构ID	文本	255
o_orgName	机构名称	文本	255
pid	父节点ID	文本	255
innerCode	层级码编号	文本	255
orderNo	排序号	文本	255
isLeaf	是否叶子	文本	255
name	树节点名称	文本	255
illegalReason	非法原因	文本	255
processData	处理操作	文本	255

字段编码	字段编码	字段类型	长度
id	记录唯一ID	文本	255
o_id	机构ID	文本	255
o_orgName	机构名称	文本	255
u_id	人员id	文本	255
u_mobile	人员手机	文本	255
u_email	人员邮件	文本	255
u_duties	人员职务	文本	255
u_userName	人员姓名	文本	255
a_id	账号id	文本	255
a_account	账号名称	文本	255
illegalReason	非法原因	文本	255
processData	处理操作	文本	255

编码	名称	类型
legalityVbaseOrganization	合法的vbase机构数据	实体
illegalVbaseOrganization	非法的vbase机构数据	实体
legalityVbaseUser	合法的vbase人员数据	实体
illegalVbaseUser	非法的vbase人员数据	实体

服务端方法\material

post

API_GetTemporaryMaterialSimple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_GetTemporaryMaterialSimple

API属性	值
API编码	API_GetTemporaryMaterialSimple
API名称	获取临时素材文件
API描述
请求方式	POST

参数示例:

编码	名称	类型	必须

media_id	媒体文件id	文本	否
simpleAppBizCode	简化版应用业务编码	文本	否

参数示例:

{
  "media_id": "media_id_text",
  "simpleAppBizCode": "simpleAppBizCode_text"
}

返回值说明:

编码	名称	类型
AppFileInfo_id	应用文件id	文本
errorType	异常类型	文本
isSuccess	是否成功	布尔
errorCode	异常编码	文本
errorMsg	异常信息	文本
errorContent	异常的详细信息	文本
AppFileInfo_name	文件名称	文本
AppFileInfo_fileSize	文件大小	文本

返回示例：

{
  "AppFileInfo_id": "AppFileInfo_id_text",
  "errorType": "errorType_text",
  "isSuccess": true,
  "errorCode": "errorCode_text",
  "errorMsg": "errorMsg_text",
  "errorContent": "errorContent_text",
  "AppFileInfo_name": "AppFileInfo_name_text",
  "AppFileInfo_fileSize": "AppFileInfo_fileSize_text"
}

post

API_UploadTemporaryMaterialSimple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_UploadTemporaryMaterialSimple

API属性	值
API编码	API_UploadTemporaryMaterialSimple
API名称	上传临时素材文件
API描述
请求方式	POST

参数示例:

编码	名称	类型	必须	描述
type	媒体文件类型	文本	否	媒体文件类型，分别有图片（image）、语音（voice）、视频（video），普通文件(file)
media	媒体文件标识	文本	否	form-data中媒体文件标识，有filename、filelength、content-type等信息
simpleAppBizCode	简化版应用业务编码	文本	否

参数示例:

{
  "type": "type_text",
  "media": "media_text",
  "simpleAppBizCode": "simpleAppBizCode_text"
}

返回值说明:

编码	名称	类型
type	媒体文件类型	文本
media_id	媒体文件上传后获取的唯一标识	文本
created_at	媒体文件上传时间戳	文本
errorType	异常类型	文本
isSuccess	是否成功	布尔
errorCode	异常编码	文本
errorMsg	异常信息	文本
errorContent	异常的详细信息	文本

返回示例：

{
  "type": "type_text",
  "media_id": "media_id_text",
  "created_at": "created_at_text",
  "errorType": "errorType_text",
  "isSuccess": true,
  "errorCode": "errorCode_text",
  "errorMsg": "errorMsg_text",
  "errorContent": "errorContent_text"
}

post

API_Create_QY_MenuSimple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_Create_QY_MenuSimple

API属性	值
API编码	API_Create_QY_MenuSimple
API名称	创建简化版微信企业号的应用菜单
API描述
请求方式	POST

参数示例:

编码	名称	类型	初始值	必须	描述
menu	应用菜单	实体		否	应用菜单
simpleAppBizCode	简化版应用业务编码	文本		否

menu实体

字段编码	字段编码	字段类型	长度
name	菜单标题	文本	255
type	菜单的响应动作类型	文本	255
key	菜单KEY值	文本	255
url	网页链接	长文本	255
id		文本	255
PID	父记录字段	文本	255
OrderNo	排序字段	整数	50
InnerCode	层级码字段	文本	255
IsLeaf	叶子节点字段	布尔
isOAuth	是否需要OAuth验证	布尔

参数示例:

{
  "menu": 
    {
      "name": "name_text1",
      "type": "type_text1",
      "key": "key_text1",
      "url": "url_text1",
      "id": "id_text1",
      "PID": "PID_text1",
      "OrderNo": 1,
      "InnerCode": "InnerCode_text1",
      "IsLeaf": true,
      "isOAuth": true
    },
    {
      "name": "name_text2",
      "type": "type_text2",
      "key": "key_text2",
      "url": "url_text2",
      "id": "id_text2",
      "PID": "PID_text2",
      "OrderNo": 1,
      "InnerCode": "InnerCode_text2",
      "IsLeaf": true,
      "isOAuth": true
    }
  ],
  "simpleAppBizCode": "simpleAppBizCode_text"
}

返回值说明:

编码	名称	类型	初始值	描述
isSuccess	是否成功	布尔
errorContent	异常的详细信息	文本

返回示例：

{
  "isSuccess": true,
  "errorContent": "errorContent_text"
}

post

API_Get_QY_MenuSimple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_Get_QY_MenuSimple

API属性	值
API编码	API_Get_QY_MenuSimple
API名称	获取简化版微信企业号的应用菜单
API描述	获取微信企业号的应用菜单
请求方式	POST

参数示例:

编码	名称	类型	初始值	必须	描述
simpleAppBizCode	简化版应用业务编码	文本		否

参数示例:

{
  "simpleAppBizCode": "simpleAppBizCode_text"
}

返回值说明:

编码	名称	类型
menu	菜单（微信端下载的）	实体
isSuccess	是否成功	布尔
errorContent	异常的详细信息	文本

menu实体

字段编码	字段编码	字段类型	长度
ParentId	菜单的上级id	文本	255
MenuOrderNo	菜单的同级排序号	文本	255
MenuInnerCode	菜单的层级码	文本	255
MenuIsLeaf	菜单的是否叶子节点	布尔
MenuName	菜单中文名	文本	255
MenuType	菜单类型	文本	255
MenuUrl	菜单打开的url	长文本	1000
MenuKey	菜单KEY值	文本	255
id		文本	255
isOAuth	是否需要OAuth验证	布尔

返回示例：

{
  "menu": 
    {
      "ParentId": "ParentId_text1",
      "MenuOrderNo": "MenuOrderNo_text1",
      "MenuInnerCode": "MenuInnerCode_text1",
      "MenuIsLeaf": true,
      "MenuName": "MenuName_text1",
      "MenuType": "MenuType_text1",
      "MenuUrl": "MenuUrl_text1",
      "MenuKey": "MenuKey_text1",
      "id": "id_text1",
      "isOAuth": true
    },
    {
      "ParentId": "ParentId_text2",
      "MenuOrderNo": "MenuOrderNo_text2",
      "MenuInnerCode": "MenuInnerCode_text2",
      "MenuIsLeaf": true,
      "MenuName": "MenuName_text2",
      "MenuType": "MenuType_text2",
      "MenuUrl": "MenuUrl_text2",
      "MenuKey": "MenuKey_text2",
      "id": "id_text2",
      "isOAuth": true
    }
  ],
  "isSuccess": true,
  "errorContent": "errorContent_text"
}

服务端方法\Private

post

getAccessToken

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/getAccessToken

API属性	值
API编码	getAccessToken
API名称	获取accessToken
API描述	获取accessToken
请求方式	POST

参数示例:

编码	名称	类型	初始值	必须	描述
simpleAppBizCode	简化版应用业务编码	文本		否

参数示例:

{
  "simpleAppBizCode": "simpleAppBizCode_text"
}

返回值说明:

编码	名称	类型
access_token	access_token	文本
agentid	应用id	整数
isSuccess	是否成功	布尔
errorMsg	错误信息	文本

返回示例：

{
  "access_token": "access_token_text",
  "agentid": 1,
  "isSuccess": true,
  "errorMsg": "errorMsg_text"
}

post

getIsExecuteRemote

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/getIsExecuteRemote

API属性	值
API编码	getIsExecuteRemote
API名称	是否远程调用构件方法
API描述
请求方式	POST

参数示例:

编码	名称	类型	初始值	描述

参数示例:

返回值说明:

编码	名称	类型	初始值	描述
isExecuteRemote	是否远程调用构件方法	布尔

返回示例：

{
  "isExecuteRemote": true
}

服务端方法\sendmessage

post

API_GetTag_Simple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_GetTag_Simple

API属性	值
API编码	API_GetTag_Simple
API名称	获取标签成员
API描述	获取标签成员
请求方式	POST

参数示例:

编码	名称	类型	初始值	必须	描述
tagid	标签ID	整数		否
simpleAppBizCode	简化版应用业务编码	文本		否

参数示例:

{
  "tagid": 1,
  "simpleAppBizCode": "simpleAppBizCode_text"
}

返回值说明:

编码	名称	类型
userlist	成员列表	实体
partylist	部门列表	实体
isSuccess	是否成功	布尔
errorContent	异常的详细信息	文本

userlist实体

字段编码	字段编码	字段类型	长度	精度	字段初始值	字段描述
userid	成员UserID	文本	255
name	成员姓名	文本	255

partylist实体

字段编码	字段编码	字段类型	长度	精度	字段初始值	字段描述
department_id	部门id	整数	50

返回示例：

{
  "userlist": 
    {
      "userid": "userid_text1",
      "name": "name_text1"
    },
    {
      "userid": "userid_text2",
      "name": "name_text2"
    }
  ],
  "partylist": 
    {
      "department_id": 1
    },
    {
      "department_id": 1
    }
  ],
  "isSuccess": true,
  "errorContent": "errorContent_text"
}

post

API_GetUser_Simple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_GetUser_Simple

API属性	值
API编码	API_GetUser_Simple
API名称	获取成员信息
API描述
请求方式	POST

参数示例:

编码	名称	类型	初始值	必须	描述
userid	成员UserID	文本		否	成员UserID。对应管理端的帐号
simpleAppBizCode	简化版应用业务编码	文本		否

参数示例:

{
  "userid": "userid_text",
  "simpleAppBizCode": "simpleAppBizCode_text"
}

返回值说明:

编码	名称	类型	描述
userid	成员UserID	文本	成员UserID。对应管理端的帐号
name	成员名称	文本	成员名称
department	成员所属部门id列表	实体	成员所属部门id列表
position	职位信息	文本	职位信息
mobile	手机号码	文本	手机号码
gender	性别	整数	性别。0表示未定义，1表示男性，2表示女性
email	邮箱	文本	邮箱
weixinid	微信号	文本	微信号
avatar	头像url	文本	头像url。注：如果要获取小图将url最后的"/0"改成"/64"即可
status	关注状态	整数	关注状态: 1=已关注，2=已禁用，4=未关注
extattr_attrs	扩展属性	实体	扩展属性
errorType	异常类型	文本
isSuccess	是否成功	布尔
errorCode	异常编码	文本
errorMsg	异常信息	文本
errorContent	异常详细信息	文本

department实体

字段编码	字段编码	字段类型	长度	精度	字段初始值	字段描述
department_id	部门id	整数	50

extattr_attrs实体

字段编码	字段编码	字段类型	长度	精度	字段初始值	字段描述
name	名称	文本	255
value	属性值	文本	255

返回示例：

{
  "userid": "userid_text",
  "name": "name_text",
  "department": 
    {
      "department_id": 1
    },
    {
      "department_id": 1
    }
  ],
  "position": "position_text",
  "mobile": "mobile_text",
  "gender": 1,
  "email": "email_text",
  "weixinid": "weixinid_text",
  "avatar": "avatar_text",
  "status": 1,
  "extattr_attrs": 
    {
      "name": "name_text1",
      "value": "value_text1"
    },
    {
      "name": "name_text2",
      "value": "value_text2"
    }
  ],
  "errorType": "errorType_text",
  "isSuccess": true,
  "errorCode": "errorCode_text",
  "errorMsg": "errorMsg_text",
  "errorContent": "errorContent_text"
}

post

API_ListDepartment_Simple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_ListDepartment_Simple

API属性	值
API编码	API_ListDepartment_Simple
API名称	获取微信部门列表
API描述
请求方式	POST

参数示例:

编码	名称	类型	初始值	必须	描述
depId	部门id	整数		否	部门id
simpleAppBizCode	简化版应用业务编码	文本		否

参数示例:

{
  "depId": 1,
  "simpleAppBizCode": "simpleAppBizCode_text"
}

返回值说明:

编码	名称	类型	描述
department	部门列表数据	实体	部门列表数据。以部门的order字段从小到大排列
errorType	异常类型	文本
isSuccess	是否成功	布尔
errorCode	异常编码	文本
errorMsg	异常信息	文本
errorContent	异常的详细信息	文本

department实体

字段编码	字段编码	字段类型
department_id	部门id	整数
name	部门名称	文本
parentid	父亲部门id	整数
department_order	次序值	整数
id		文本
pid		文本
isleaf		布尔
InnerCode		文本

返回示例：

{
  "department": 
    {
      "department_id": 1,
      "name": "name_text1",
      "parentid": 1,
      "department_order": 1,
      "id": "id_text1",
      "pid": "pid_text1",
      "isleaf": true,
      "InnerCode": "InnerCode_text1"
    },
    {
      "department_id": 1,
      "name": "name_text2",
      "parentid": 1,
      "department_order": 1,
      "id": "id_text2",
      "pid": "pid_text2",
      "isleaf": true,
      "InnerCode": "InnerCode_text2"
    }
  ],
  "errorType": "errorType_text",
  "isSuccess": true,
  "errorCode": "errorCode_text",
  "errorMsg": "errorMsg_text",
  "errorContent": "errorContent_text"
}

post

API_ListTag_Simple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_ListTag_Simple

API属性	值
API编码	API_ListTag_Simple
API名称	获取标签列表
API描述
请求方式	POST

参数示例:

编码	名称	类型	初始值	必须	描述
simpleAppBizCode	简化版应用业务编码	文本		否

参数示例:

{
  "simpleAppBizCode": "simpleAppBizCode_text"
}

返回值说明:

编码	名称	类型
taglist	标签列表	实体
errorType	异常类型	文本
isSuccess	是否成功	布尔
errorCode	异常编码	文本
errorMsg	异常信息	文本
errorContent	异常的详细信息	文本

taglist实体

字段编码	字段编码	字段类型	长度	精度	字段初始值	字段描述
tagid	标签id	整数
tagname	标签名称	文本

返回示例：

{
  "taglist": 
    {
      "tagid": 1,
      "tagname": "tagname_text1"
    },
    {
      "tagid": 1,
      "tagname": "tagname_text2"
    }
  ],
  "errorType": "errorType_text",
  "isSuccess": true,
  "errorCode": "errorCode_text",
  "errorMsg": "errorMsg_text",
  "errorContent": "errorContent_text"
}

post

API_ListUser_Simple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_ListUser_Simple

API属性	值
API编码	API_ListUser_Simple
API名称	获取部门成员(详情)
API描述
请求方式	POST

参数示例:

编码	名称	类型	必须	描述
departmentId	获取的部门id	整数	否	获取的部门id
fetch_child	否获取子部门的成员	整数	否	是否获取子部门的成员(1/0：是否递归获取子部门下面的成员)
status	获取成员类型	整数	否	0获取全部成员，1获取已关注成员列表，2获取禁用成员列表，4获取未关注成员列表。status可叠加,未填写则默认为4
simpleAppBizCode	简化版应用业务编码	文本	否

参数示例:

{
  "departmentId": 1,
  "fetch_child": 1,
  "status": 1,
  "simpleAppBizCode": "simpleAppBizCode_text"
}

返回值说明:

编码	名称	类型	描述
userlist	成员列表	实体	成员列表
errorType	异常类型	文本
isSuccess	是否成功	布尔
errorCode	异常编码	文本
errorMsg	异常信息	文本
errorContent	异常的详细信息	文本

userlist实体

字段编码	字段编码	字段类型
userid	成员UserID	文本
name	成员名称	文本
department	成员所属部门	文本
position	职位信息	文本
mobile	手机号码	文本
gender	性别	整数
email	邮箱	文本
weixinid	微信号	文本
avatar	头像url	文本
status	关注状态	整数
extattr	扩展属性	文本

返回示例：

{
  "userlist": 
    {
      "userid": "userid_text1",
      "name": "name_text1",
      "department": "department_text1",
      "position": "position_text1",
      "mobile": "mobile_text1",
      "gender": 1,
      "email": "email_text1",
      "weixinid": "weixinid_text1",
      "avatar": "avatar_text1",
      "status": 1,
      "extattr": "extattr_text1"
    },
    {
      "userid": "userid_text2",
      "name": "name_text2",
      "department": "department_text2",
      "position": "position_text2",
      "mobile": "mobile_text2",
      "gender": 1,
      "email": "email_text2",
      "weixinid": "weixinid_text2",
      "avatar": "avatar_text2",
      "status": 1,
      "extattr": "extattr_text2"
    }
  ],
  "errorType": "errorType_text",
  "isSuccess": true,
  "errorCode": "errorCode_text",
  "errorMsg": "errorMsg_text",
  "errorContent": "errorContent_text"
}

post

API_SendFileMessage_Simple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_SendFileMessage_Simple

API属性	值
API编码	API_ListUser_Simple
API名称	发送文件消息
API描述
请求方式	POST

参数示例:

编码	名称	类型	必须	描述
touser	成员ID列表	文本	否	成员ID列表（消息接收者，多个接收者用‘\|’分隔，最多支持1000个）。特殊情况：指定为@all，则向关注该企业应用的全部成员发送
toparty	部门ID列表	文本	否	部门ID列表，多个接收者用‘\|’分隔，最多支持100个。当touser为@all时忽略本参数
totag	标签ID列表	文本	否	标签ID列表，多个接收者用‘\|’分隔。当touser为@all时忽略本参数
safe	是否保密消息	布尔	否	表示是否是保密消息，0表示否，1表示是，默认0
media	form-data中媒体文件标识	文本	否	form-data中媒体文件标识，有filename、filelength、content-type等信息
simpleAppBizCode	简化版应用业务编码	文本	否

参数示例:

{
  "touser": "touser_text",
  "toparty": "toparty_text",
  "totag": "totag_text",
  "safe": true,
  "media": "media_text",
  "simpleAppBizCode": "simpleAppBizCode_text"
}

返回值说明:

编码	名称	类型	描述
invaliduser	无效用户	文本	无效用户
invalidparty	无效部门	文本	无效部门
invalidtag	无效标签	文本	无效标签
errorType	异常类型	文本
isSuccess	是否成功	布尔
errorCode	异常编码	文本
errorMsg	异常信息	文本
errorContent	异常的详细信息	文本

返回示例：

{
  "invaliduser": "invaliduser_text",
  "invalidparty": "invalidparty_text",
  "invalidtag": "invalidtag_text",
  "errorType": "errorType_text",
  "isSuccess": true,
  "errorCode": "errorCode_text",
  "errorMsg": "errorMsg_text",
  "errorContent": "errorContent_text"
}

post

API_SendImageMessage_Simple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_SendImageMessage_Simple

API属性	值
API编码	API_SendImageMessage_Simple
API名称	发送图片消息
API描述
请求方式	POST

参数示例:

编码	名称	类型	必须	描述
touser	成员ID列表	文本	否	成员ID列表（消息接收者，多个接收者用‘\|’分隔，最多支持1000个）。特殊情况：指定为@all，则向关注该企业应用的全部成员发送
toparty	部门ID列表	文本	否	部门ID列表，多个接收者用‘\|’分隔，最多支持100个。当touser为@all时忽略本参数
totag	标签ID列表	文本	否	标签ID列表，多个接收者用‘\|’分隔。当touser为@all时忽略本参数
safe	是否保密消息	布尔	否	表示是否是保密消息，0表示否，1表示是，默认0
media	form-data中媒体文件标识	文本	否	form-data中媒体文件标识，有filename、filelength、content-type等信息
simpleAppBizCode	简化版应用业务编码	文本	否

参数示例:

{
  "touser": "touser_text",
  "toparty": "toparty_text",
  "totag": "totag_text",
  "safe": true,
  "media": "media_text",
  "simpleAppBizCode": "simpleAppBizCode_text"
}

返回值说明:

编码	名称	类型	描述
invaliduser	无效用户	文本	无效用户
invalidparty	无效部门	文本	无效部门
invalidtag	无效标签	文本	无效标签
errorType	异常类型	文本
isSuccess	是否成功	布尔
errorCode	异常编码	文本
errorMsg	异常信息	文本
errorContent	异常的详细信息	文本

返回示例：

{
  "invaliduser": "invaliduser_text",
  "invalidparty": "invalidparty_text",
  "invalidtag": "invalidtag_text",
  "errorType": "errorType_text",
  "isSuccess": true,
  "errorCode": "errorCode_text",
  "errorMsg": "errorMsg_text",
  "errorContent": "errorContent_text"
}

post

API_SendMpnewsWithContentMessage_Simple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_ListUser_Simple

API属性	值
API编码	API_SendMpnewsWithContentMessage_Simple
API名称	发送图文消息
API描述
请求方式	POST

参数示例:

编码	名称	类型	必须	描述
touser	成员ID列表	文本	否	成员ID列表（消息接收者，多个接收者用‘\|’分隔，最多支持1000个）。特殊情况：指定为@all，则向关注该企业应用的全部成员发送
toparty	部门ID列表	文本	否	部门ID列表，多个接收者用‘\|’分隔，最多支持100个。当touser为@all时忽略本参数
totag	标签ID列表	文本	否	标签ID列表，多个接收者用‘\|’分隔。当touser为@all时忽略本参数
safe	是否保密消息	布尔	否	表示是否是保密消息，0表示否，1表示是，默认0
mpnews_articles	图文消息	实体	否	图文消息
simpleAppBizCode	简化版应用业务编码	文本	否

mpnews_articles实体

字段编码	字段编码	字段类型	长度	字段描述
title	图文消息的标题	文本
author	图文消息的作者	文本
content_source_url	“阅读原文”之后的页面链接	文本
content	图文消息的内容	长文本	9999
digest	图文消息的描述	文本
show_cover_pic	是否显示封面	布尔
media	form-data中媒体文件标识	文本	255	form-data中媒体文件标识，有filename、filelength、content-type等信息
id		文本	255

参数示例:

{
  "touser": "touser_text",
  "toparty": "toparty_text",
  "totag": "totag_text",
  "safe": true,
  "mpnews_articles": 
    {
      "title": "title_text1",
      "author": "author_text1",
      "content_source_url": "content_source_url_text1",
      "content": "content_text1",
      "digest": "digest_text1",
      "show_cover_pic": true,
      "media": "media_text1",
      "id": "id_text1"
    },
    {
      "title": "title_text2",
      "author": "author_text2",
      "content_source_url": "content_source_url_text2",
      "content": "content_text2",
      "digest": "digest_text2",
      "show_cover_pic": true,
      "media": "media_text2",
      "id": "id_text2"
    }
  ],
  "simpleAppBizCode": "simpleAppBizCode_text"
}

返回值说明:

编码	名称	类型	描述
invaliduser	无效用户	文本	无效用户
invalidparty	无效部门	文本	无效部门
invalidtag	无效标签	文本	无效标签
errorType	异常类型	文本
isSuccess	是否成功	布尔
errorCode	异常编码	文本
errorMsg	异常信息	文本
errorContent	异常的详细信息	文本
access_token	授权方（企业）access_token	文本
media_id	上传永久图文消息素材资源标识ID	文本

返回示例：

{
  "invaliduser": "invaliduser_text",
  "invalidparty": "invalidparty_text",
  "invalidtag": "invalidtag_text",
  "errorType": "errorType_text",
  "isSuccess": true,
  "errorCode": "errorCode_text",
  "errorMsg": "errorMsg_text",
  "errorContent": "errorContent_text",
  "access_token": "access_token_text",
  "media_id": "media_id_text"
}

post

API_SendNewsMessage_Simple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_SendNewsMessage_Simple

API属性	值
API编码	API_SendNewsMessage_Simple
API名称	发送news消息
API描述
请求方式	POST

参数示例:

编码	名称	类型	必须	描述
touser	成员ID列表	文本	否	成员ID列表（消息接收者，多个接收者用‘\|’分隔，最多支持1000个）。特殊情况：指定为@all，则向关注该企业应用的全部成员发送
toparty	部门ID列表	文本	否	部门ID列表，多个接收者用‘\|’分隔，最多支持100个。当touser为@all时忽略本参数
totag	标签ID列表	文本	否	标签ID列表，多个接收者用‘\|’分隔。当touser为@all时忽略本参数
news_articles	news_articles	实体	否	news_articles
eventType	事件类型	文本	否
isOauth	是否需要oauth验证	布尔	否
simpleAppBizCode	简化版应用业务编码	文本	否

news_articles实体

字段编码	字段编码	字段类型	长度
title	标题	文本
description	描述	长文本	1000
url	点击后跳转的链接	长文本	9999
media_id	文件id	文本	255
id		文本	255

参数示例:

{
  "touser": "touser_text",
  "toparty": "toparty_text",
  "totag": "totag_text",
  "news_articles": 
    {
      "title": "title_text1",
      "description": "description_text1",
      "url": "url_text1",
      "media_id": "media_id_text1",
      "id": "id_text1"
    },
    {
      "title": "title_text2",
      "description": "description_text2",
      "url": "url_text2",
      "media_id": "media_id_text2",
      "id": "id_text2"
    }
  ],
  "eventType": "eventType_text",
  "isOauth": true,
  "simpleAppBizCode": "simpleAppBizCode_text"
}

返回值说明:

编码	名称	类型	描述
invaliduser	无效用户	文本	无效用户
invalidparty	无效部门	文本	无效部门
invalidtag	无效标签	文本	无效标签
errorType	异常类型	文本
isSuccess	是否成功	布尔
errorCode	异常编码	文本
errorMsg	异常信息	文本
errorContent	异常的详细信息	文本

返回示例：

{
  "invaliduser": "invaliduser_text",
  "invalidparty": "invalidparty_text",
  "invalidtag": "invalidtag_text",
  "errorType": "errorType_text",
  "isSuccess": true,
  "errorCode": "errorCode_text",
  "errorMsg": "errorMsg_text",
  "errorContent": "errorContent_text"
}

post

API_SendSoundVoiceMessage_Simple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_SendSoundVoiceMessage_Simple

API属性	值
API编码	API_SendSoundVoiceMessage_Simple
API名称	发送语音消息
API描述
请求方式	POST

参数示例:

编码	名称	类型	必须	描述
touser	成员ID列表	文本	否	成员ID列表（消息接收者，多个接收者用‘\|’分隔，最多支持1000个）。特殊情况：指定为@all，则向关注该企业应用的全部成员发送
toparty	部门ID列表	文本	否	部门ID列表，多个接收者用‘\|’分隔，最多支持100个。当touser为@all时忽略本参数
totag	标签ID列表	文本	否	标签ID列表，多个接收者用‘\|’分隔。当touser为@all时忽略本参数
safe	是否保密消息	布尔	否	表示是否是保密消息，0表示否，1表示是，默认0
media	form-data中媒体文件标识	文本	否	form-data中媒体文件标识，有filename、filelength、content-type等信息
simpleAppBizCode	简化版应用业务编码	文本	否

参数示例:

{
  "touser": "touser_text",
  "toparty": "toparty_text",
  "totag": "totag_text",
  "safe": true,
  "media": "media_text",
  "simpleAppBizCode": "simpleAppBizCode_text"
}

返回值说明:

编码	名称	类型	描述
invaliduser	无效用户	文本	无效用户
invalidparty	无效部门	文本	无效部门
invalidtag	无效标签	文本	无效标签
errorType	异常类型	文本
isSuccess	是否成功	布尔
errorCode	异常编码	文本
errorMsg	异常信息	文本
errorContent	异常的详细信息	文本

返回示例：

{
  "invaliduser": "invaliduser_text",
  "invalidparty": "invalidparty_text",
  "invalidtag": "invalidtag_text",
  "errorType": "errorType_text",
  "isSuccess": true,
  "errorCode": "errorCode_text",
  "errorMsg": "errorMsg_text",
  "errorContent": "errorContent_text"
}

post

API_SendTextcardMessageAction_Simple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_SendTextcardMessageAction_Simple

API属性	值
API编码	API_SendTextcardMessageAction_Simple
API名称	发送Textcard消息
API描述
请求方式	POST

参数示例:

编码	名称	类型	必须	描述
touser	成员ID列表	文本	否	成员ID列表（消息接收者，多个接收者用‘\|’分隔，最多支持1000个）。特殊情况：指定为@all，则向关注该企业应用的全部成员发送
toparty	部门ID列表	文本	否	部门ID列表，多个接收者用‘\|’分隔，最多支持100个。当touser为@all时忽略本参数
totag	标签ID列表	文本	否	标签ID列表，多个接收者用‘\|’分隔。当touser为@all时忽略本参数
eventType	事件类型	文本	否
title	标题	长文本	否	(必填)标题，不超过128个字节，超过会自动截断
description	描述	文本	否	(必填)描述，不超过512个字节，超过会自动截断
url	点击后跳转的链接	文本	否	(必填)点击后跳转的链接。
simpleAppBizCode	简化版应用业务编码	文本	否

参数示例:

{
  "touser": "touser_text",
  "toparty": "toparty_text",
  "totag": "totag_text",
  "eventType": "eventType_text",
  "title": "title_text",
  "description": "description_text",
  "url": "url_text",
  "simpleAppBizCode": "simpleAppBizCode_text"
}

返回值说明:

编码	名称	类型	描述
invaliduser	无效用户	文本	无效用户
invalidparty	无效部门	文本	无效部门
invalidtag	无效标签	文本	无效标签
errorType	异常类型	文本
isSuccess	是否成功	布尔
errorCode	异常编码	文本
errorMsg	异常信息	文本
errorContent	异常的详细信息	文本

返回示例：

{
  "invaliduser": "invaliduser_text",
  "invalidparty": "invalidparty_text",
  "invalidtag": "invalidtag_text",
  "errorType": "errorType_text",
  "isSuccess": true,
  "errorCode": "errorCode_text",
  "errorMsg": "errorMsg_text",
  "errorContent": "errorContent_text"
}

post

API_SendTextMessage_Simple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_SendTextMessage_Simple

API属性	值
API编码	API_SendTextMessage_Simple
API名称	发送文本消息
API描述
请求方式	POST

参数示例:

编码	名称	类型	必须	描述

touser	成员ID列表	文本	否	成员ID列表（消息接收者，多个接收者用‘\|’分隔，最多支持1000个）。特殊情况：指定为@all，则向关注该企业应用的全部成员发送
toparty	部门ID列表	文本	否	部门ID列表，多个接收者用‘\|’分隔，最多支持100个。当touser为@all时忽略本参数
totag	标签ID列表	文本	否	标签ID列表，多个接收者用‘\|’分隔。当touser为@all时忽略本参数
text	消息内容	实体	否	消息内容
safe	是否保密消息	布尔	否	表示是否是保密消息，0表示否，1表示是，默认0
eventType	事件类型	文本	否
simpleAppBizCode	简化版应用业务编码	文本	否

text实体

字段编码	字段编码	字段类型	长度	精度	字段初始值	字段描述
content	消息内容	长文本

参数示例:

{
  "touser": "touser_text",
  "toparty": "toparty_text",
  "totag": "totag_text",
  "text": 
    {
      "content": "content_text1"
    },
    {
      "content": "content_text2"
    }
  ],
  "safe": true,
  "eventType": "eventType_text",
  "simpleAppBizCode": "simpleAppBizCode_text"
}

返回值说明:

编码	名称	类型	描述
invaliduser	无效用户	文本	无效用户
invalidparty	无效部门	文本	无效部门
invalidtag	无效标签	文本	无效标签
errorType	异常类型	文本
isSuccess	是否成功	布尔
errorCode	异常编码	文本
errorMsg	异常信息	文本
errorContent	异常的详细信息	文本

返回示例：

{
  "invaliduser": "invaliduser_text",
  "invalidparty": "invalidparty_text",
  "invalidtag": "invalidtag_text",
  "errorType": "errorType_text",
  "isSuccess": true,
  "errorCode": "errorCode_text",
  "errorMsg": "errorMsg_text",
  "errorContent": "errorContent_text"
}

post

API_SendVideoMessage_Simple

http://*****:**/webapi/vbase_wx_qy_simple_yw_api/API_SendVideoMessage_Simple

API属性	值
API编码	API_SendVideoMessage_Simple
API名称	发送视频文件消息
API描述
请求方式	POST

参数示例:

编码	名称	类型	必须	描述
touser	成员ID列表	文本	否	成员ID列表（消息接收者，多个接收者用‘\|’分隔，最多支持1000个）。特殊情况：指定为@all，则向关注该企业应用的全部成员发送
toparty	部门ID列表	文本	否	部门ID列表，多个接收者用‘\|’分隔，最多支持100个。当touser为@all时忽略本参数
totag	标签ID列表	文本	否	标签ID列表，多个接收者用‘\|’分隔。当touser为@all时忽略本参数
safe	是否保密消息	布尔	否	表示是否是保密消息，0表示否，1表示是，默认0
media	form-data中媒体文件标识	文本	否	form-data中媒体文件标识，有filename、filelength、content-type等信息
title	视频消息的标题	文本	否
description	视频消息的描述	文本	否
simpleAppBizCode	简化版应用业务编码	文本	否

参数示例:

{
  "touser": "touser_text",
  "toparty": "toparty_text",
  "totag": "totag_text",
  "safe": true,
  "media": "media_text",
  "title": "title_text",
  "description": "description_text",
  "simpleAppBizCode": "simpleAppBizCode_text"
}

返回值说明:

编码	名称	类型	描述
invaliduser	无效用户	文本	无效用户
invalidparty	无效部门	文本	无效部门
invalidtag	无效标签	文本	无效标签
errorType	异常类型	文本
isSuccess	是否成功	布尔
errorCode	异常编码	文本
errorMsg	异常信息	文本
errorContent	异常的详细信息	文本

返回示例：

{
  "invaliduser": "invaliduser_text",
  "invalidparty": "invalidparty_text",
  "invalidtag": "invalidtag_text",
  "errorType": "errorType_text",
  "isSuccess": true,
  "errorCode": "errorCode_text",
  "errorMsg": "errorMsg_text",
  "errorContent": "errorContent_text"
}

企业微信接口说明

服务端方法\API目录​

服务端方法\app​

API_CleanCookie

API_QueryCorpInfoSimple

API_QuerySimpleApp

API_QuerySimpleAppByAgentId

getSystemValueByParamKey

服务端方法\configValue​

API_QuerySimpleConfig

API_SaveSimpleConfig

服务端方法\contactsservice​

API_ContactsService_Simple

API_ContactsServiceLogger_Simple

API_VbaseDataCheck_Simple

服务端方法\material​

API_GetTemporaryMaterialSimple

API_UploadTemporaryMaterialSimple

服务端方法\menu​

API_Create_QY_MenuSimple

API_Get_QY_MenuSimple

服务端方法\Private​

getAccessToken

getIsExecuteRemote

服务端方法\sendmessage​

API_GetTag_Simple

API_GetUser_Simple

API_ListDepartment_Simple

API_ListTag_Simple

API_ListUser_Simple

API_SendFileMessage_Simple

API_SendImageMessage_Simple

API_SendMpnewsWithContentMessage_Simple

API_SendNewsMessage_Simple

API_SendSoundVoiceMessage_Simple

API_SendTextcardMessageAction_Simple

API_SendTextMessage_Simple

API_SendVideoMessage_Simple

服务端方法\API目录

服务端方法\app

服务端方法\configValue

服务端方法\contactsservice

服务端方法\material

服务端方法\menu

服务端方法\Private

服务端方法\sendmessage