MSGTYPE_TEXT
MSGTYPE_TEXT = 'text'
微信公众平台企业号PHP-SDK, 官方API类库
@author binsee binsee@163.com
xml_encode(mixed $data, string $root = 'xml', string $item = 'item', string $attr = '', string $id = 'id', string $encoding = 'utf-8') : string
XML编码
mixed | $data | 数据 |
string | $root | 根节点名 |
string | $item | 数字索引的子节点名 |
string | $attr | 根节点属性 |
string | $id | 数字索引子节点key转换的属性名 |
string | $encoding | 数据编码 |
createMenu(array $data, mixed $agentid = '') : mixed
创建菜单
array | $data | 菜单数组数据 example: array ( 'button' => array ( 0 => array ( 'name' => '扫码', 'sub_button' => array ( 0 => array ( 'type' => 'scancode_waitmsg', 'name' => '扫码带提示', 'key' => 'rselfmenu_0_0', ), 1 => array ( 'type' => 'scancode_push', 'name' => '扫码推事件', 'key' => 'rselfmenu_0_1', ), ), ), 1 => array ( 'name' => '发图', 'sub_button' => array ( 0 => array ( 'type' => 'pic_sysphoto', 'name' => '系统拍照发图', 'key' => 'rselfmenu_1_0', ), 1 => array ( 'type' => 'pic_photo_or_album', 'name' => '拍照或者相册发图', 'key' => 'rselfmenu_1_1', ) ), ), 2 => array ( 'type' => 'location_select', 'name' => '发送位置', 'key' => 'rselfmenu_2_0' ), ), ) type可以选择为以下几种,会收到相应类型的事件推送。请注意,3到8的所有事件,仅支持微信iPhone5.4.1以上版本, 和Android5.4以上版本的微信用户,旧版本微信用户点击后将没有回应,开发者也不能正常接收到事件推送。 1、click:点击推事件 2、view:跳转URL 3、scancode_push:扫码推事件 4、scancode_waitmsg:扫码推事件且弹出“消息接收中”提示框 5、pic_sysphoto:弹出系统拍照发图 6、pic_photo_or_album:弹出拍照或者相册发图 7、pic_weixin:弹出微信相册发图器 8、location_select:弹出地理位置选择器 |
mixed | $agentid |
createDepartment(array $data) : bool|array
创建部门
array | $data | 结构体为: array ( "name" => "邮箱产品组", //部门名称 "parentid" => "1" //父部门id "order" => "1", //(非必须)在父部门中的次序。从1开始,数字越大排序越靠后 ) |
成功返回结果 { "errcode": 0, //返回码 "errmsg": "created", //对返回码的文本描述内容 "id": 2 //创建的部门id。 }
updateDepartment(array $data) : bool|array
更新部门
array | $data | 结构体为: array( "id" => "1" //(必须)部门id "name" => "邮箱产品组", //(非必须)部门名称 "parentid" => "1", //(非必须)父亲部门id。根部门id为1 "order" => "1", //(非必须)在父部门中的次序。从1开始,数字越大排序越靠后 ) |
成功返回结果 { "errcode": 0, //返回码 "errmsg": "updated" //对返回码的文本描述内容 }
moveDepartment( $data) : bool|array
移动部门
$data | array( "department_id" => "5", //所要移动的部门 "to_parentid" => "2", //想移动到的父部门节点,根部门为1 "to_position" => "1" //(非必须)想移动到的父部门下的位置,1表示最上方,往后位置为2,3,4,以此类推,默认为1 ) |
成功返回结果 { "errcode": 0, //返回码 "errmsg": "ok" //对返回码的文本描述内容 }
createUser(array $data) : bool|array
创建成员
array | $data | 结构体为: array( "userid" => "zhangsan", "name" => "张三", "department" => [1, 2], "position" => "产品经理", "mobile" => "15913215421", "gender" => 1, //性别。gender=0表示男,=1表示女 "tel" => "62394", "email" => "zhangsan@gzdev.com", "weixinid" => "zhangsan4dev" ) |
成功返回结果 { "errcode": 0, //返回码 "errmsg": "created", //对返回码的文本描述内容 }
updateUser(array $data) : bool|array
更新成员
array | $data | 结构体为: array( "userid" => "zhangsan", "name" => "张三", "department" => [1, 2], "position" => "产品经理", "mobile" => "15913215421", "gender" => 1, //性别。gender=0表示男,=1表示女 "tel" => "62394", "email" => "zhangsan@gzdev.com", "weixinid" => "zhangsan4dev" ) |
成功返回结果 { "errcode": 0, //返回码 "errmsg": "updated" //对返回码的文本描述内容 }
getUserInfo( $userid) : bool|array
获取成员信息
$userid | 员工UserID。对应管理端的帐号 |
成功返回结果 { "errcode": 0, "errmsg": "ok", "userid": "zhangsan", "name": "李四", "department": [1, 2], "position": "后台工程师", "mobile": "15913215421", "gender": 1, //性别。gender=0表示男,=1表示女 "tel": "62394", "email": "zhangsan@gzdev.com", "weixinid": "lisifordev", //微信号 "avatar": "http://wx.qlogo.cn/mmopen/ajNVdqHZLLA3W..../0", //头像url。注:如果要获取小图将url最后的"/0"改成"/64"即可 "status": 1 //关注状态: 1=已关注,2=已冻结,4=未关注 }
getUserList( $department_id, $fetch_child, $status) : bool|array
获取部门成员
$department_id | 部门id |
|
$fetch_child | 1/0:是否递归获取子部门下面的成员 |
|
$status | 0获取全部员工,1获取已关注成员列表,2获取禁用成员列表,4获取未关注成员列表。status可叠加 |
成功返回结果 { "errcode": 0, "errmsg": "ok", "userlist": [ { "userid": "zhangsan", "name": "李四" } ] }
getUserListall( $department_id, $fetch_child, $status) : bool|array
获取部门成员详情
$department_id | 部门id |
|
$fetch_child | 1/0:是否递归获取子部门下面的成员 |
|
$status | 0获取全部员工,1获取已关注成员列表,2获取禁用成员列表,4获取未关注成员列表。status可叠加 |
成功返回结果 { "errcode": 0, "errmsg": "ok", "userlist": [ { "userid": "zhangsan", "name": "李四" } ] }
addTagUser(array $data) : bool|array
增加标签成员
array | $data | 结构体为: array ( "tagid" => "1", "userlist" => array( //企业员工ID列表 "user1", "user2" ) ) |
成功返回结果 { "errcode": 0, //返回码 "errmsg": "ok", //对返回码的文本描述内容 "invalidlist":"usr1|usr2|usr" //若部分userid非法,则会有此段。不在权限内的员工ID列表,以“|”分隔 }
delTagUser(array $data) : bool|array
删除标签成员
array | $data | 结构体为: array ( "tagid" => "1", "userlist" => array( //企业员工ID列表 "user1", "user2" ) ) |
成功返回结果 { "errcode": 0, //返回码 "errmsg": "deleted", //对返回码的文本描述内容 "invalidlist":"usr1|usr2|usr" //若部分userid非法,则会有此段。不在权限内的员工ID列表,以“|”分隔 }
sendMessage(array $data) : bool|array
主动发送信息接口
array | $data | 结构体为: array( "touser" => "UserID1|UserID2|UserID3", "toparty" => "PartyID1|PartyID2 ", "totag" => "TagID1|TagID2 ", "safe":"0" //是否为保密消息,对于news无效 "agentid" => "001", //应用id "msgtype" => "text", //根据信息类型,选择下面对应的信息结构体
) 请查看官方开发文档中的 发送消息 -> 消息类型及数据格式 |
如果对应用或收件人、部门、标签任何一个无权限,则本次发送失败; 如果收件人、部门或标签不存在,发送仍然执行,但返回无效的部分。 { "errcode": 0, "errmsg": "ok", "invaliduser": "UserID1", "invalidparty":"PartyID1", "invalidtag":"TagID1" }