wechatapi-微信号二次开发-群管理模块默认模块 Base URLs: wechatapi.net Authent

默认模块

Authentication

开发API/群管理接口

POST 创建微信群

POST /group/createChatroom

创建微信群时最少要选择两位微信好友邀请企微好友需要使用username

Body 请求参数

{
  "appId": "{{appid}}",
  "wxids": [
    "wxid_**********",
    "wxid_**********"
  ]
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» wxids	body	[string]	是	好友的wxid列表

返回示例

{
  "ret": 200,
  "msg": "操作成功",
  "data": {
    "headImgBase64": "/9j/**********/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/2wBDAQMEBAUEBQkFBQkUDQsNFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBT/wAARCACLAIsDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD77oooqyAooooAzvEOuQeG9GudSuY5ZYIACyQgFzlgOASB39a8v1/9qPwp4dtDc3VhrDRgZzHDEfw5lFdr8VDjwFqvJHEfTr/rUr87fi1q2o3umtoN3bzwlrxmWZTglSTiuulQ9rCUk9iJVFSknNaM+y/DH7YPgvxVcSQWthrcMidp4IRn6YlNdknxt0J1Vvs1+qk4yY4//i6+NI/g7qngf4c6V4zs2QNEFwo5aYHg5/DP5V5x4++OdxYiCJLp7JQ7sHY4djzwCOwrCcVyLkfvLc9ClCnUle3uvb9T7j8Q/td+D/Dc80dxpmuzLF1lgt4Sp+mZQf0p2nftdeC78WrPZ6xZx3H3ZLiGHCj1YLKxA/CvyV8V/GzxZqcX2Jbq4KiVm83O1iCSRznmrvwu+I+q6HqZvJLxGu5BhvP+ZCO55rHlm1odiw9GVScEttj92dB0n/hJdItdT0+7trizuoxLE4ZvmUjI7VePhC9C58yD6bjn+VfF/wCxb+2Hay3lh4M1ydY4JR5VtIGyEcYG3PpX6AsA+CCCMdaE7nmVabg0jyp7sxa/qGkvBKstmkUjTFR5UgfdjYc5ONhzkDqOtWK1PEkMseqsztuQoqKSO4zn+YrLoV7ambVnYKKKKokKKKKACiiigAooooA4n4zTm2+G2ryDHBgzk448+MGvnXxH4W0zxo1lHeaXK+xf9dvJPTIxx9K98/aB1GDSfhFr13cnEEX2dm4z/wAvEeP1xWN8E9SsPE/hnTtRt5UMZUlRKNxzyp/rXJXq1KdvZvff0PXwdKlWpyjUXp6nCfDrWH1j4X32gzWC3EFo0zRSS9HCT7NvTsOv0r83/wBpvX4dW8d38FlbQ2xhufIjjiHGefmHHX/Gv1f+JNzovhHQJbS1EUMkgflAFVGZt7H6k5596+NNL/Zl0b4i/G6xv/mWxllE7iNN0YfaWP5nJrGFRRbnfc9BU404KCWx5T8Df2UpPFjxah4qvPs1pKilYHb55MjrivZdf/Yi+HdpYyM15c2W5cx+bIWyfb0r2PxH8NNX0vxHHb6T4ds7yw383c10QwX/AGfk/Su11H4bXD6CPsN2tpc44m6qp9KTrzvodipU4W7s/OpPg/4h+FvxY0S10qc3VlfzbbSdWYFSGU4bjrX7ieB7m9vPCOlXGoBVvpLdGmB/v45Oa+StS8BLF8PpYdWuv7S1CzdbqK43YZGAI4bsOa6PwZ8S9atPB1ha3Opg3NmggZg3BAHBJrrjVg43R4+NoyUrI+gvGKqJLZhjcd+cfhXO1w/w58dv4zvdZjku/tT2ZiBxJuC7t/5fdruKuEuePMjxpXT1CiiitCQooooAKKKKACiiigDzv9oKxj1L4P8AiG2lAZHSHIPtPGf6V5D+zV4au4fhhOZrp4dt5ILbaP4AT/WvdfiqllL4C1NNRMgs2MSuYRluZUxj8cVmQafaeHPC1pZWIIsYolcbxhiWGf5muLENLQ9nBSSi/U+b/jdfSR31nY6hO4t7t/LuX7lRkjHvwKt/BXV/+Ef1VILe6his4nPkSM/IGcYJ+nau0ksF8T+IjpsXh+LWLxW3xSOuQh7/ANa6K0/Ze0zxVeW+p6vcizltSxitdO+QZzyH6557VhToOpHQ3nW9nPmZR8Y+PLu3e5iimJTcSso+7tz1xXimt/tHaFp94yXfiy4nlRjE9vbcgMODxn1r33xt4FEdvI0EiF4U2GJRwVHoOx96+cJPhj4e/tmaWOOzUyTFmVlG8tnj+tKVCVM9jD4nD1oc1ToeqeHNam1rRQZJ2e2miwBIfvA4IJ+uK47xN4Z8QQJdXz6+dL0OPlIEhyWHv8w5r2bwV8IjrSaeZQI9NkfDRIPLdV7MH5/Diq/xN+Cer6Laapd2etSa1pDW2xbS7/1kKjoCe5/AdK0hQUIXieNXxEZVdNjjf2H9Xs9W1X4hm0unudjWG8yJsYZ+04yMn0NfVdfOH7Hvw1k+Hq+LGkdWN/8AZHCbNrpt87hjnn71fR9dtNNRSZ5Fdp1G0FFFFaHOFFFFABRRRQAUUUUAcr8T40l8F3av90z22f8AwIjrn9b1Da4hz8i/L/45XQfE9WfwXd7BlhPbNz7XEZNea63qRn1BgrAoXycf7teZinaSPdwMVKi/X/I9E+GNxpsWnXQt5jBqqktJ5WPmGeB+XP4VNP4tlt/EX2TzVLsu/wAwenfNeNXniRvDl1pMkUoNw9zlsN1BVhg/ga0rrXZbnVFuf9YYyUO08YzxXqYKa5LHmY+naoj22HTbbWwz5QK3BHdjVAfDfSY7wXSwqGU5PArE8NajBKilZTHKfuqX6GumOozQAecflPcd67210PPV0b9lFGkaiMbUA4Aqr4gKT2bh13RgEMPWqUGtZiYQ4ZvSs/W9W+z6VdXLOAqxlip9RWLk0tUXG7ehL4f01bBJTHb+TFIFKt/exn/H9a16yvDusvq1gox+4jAMZPfPX+QrVrkvfU2ne+oUUUUyAooooAKKyPE08dvYxtKwVfNAyfoa5jT9TtYdSMkcqD6mm1aPMZznyrTVnfUVhQ+LbBmKNIQZOiJV+e7tfsYnluo7aGPknOJcf4Vg6iSubU05xv17Ddf0WHxFpM+n3EksUU23LwkBxhgwwSCOoHauMX4JaOGJ/tLVST6yx/8AxutfT/GPh3W782+m6rHcXGfmV2BkA7n6VJqCPpjTG4cCN/uXRPFKSpzV5K44161L3Y6GVafBbw/bXIndru6cdPPdSAfwUV00PhPSreza3js41DdZP4q50XyyyA+ah981pJfW6KrTToEHvW0Yci91GU8Q5u8ncSL4e6dBJ5iT3StnIIdeP/Ha3l0+IQLExaQL3Y806y1SDVYBJbyCVI/3ZI7Ec4/UV+dXgXUD4h+HRtryHfbHTHgmjk4a34olVlA0hFVFc/Q6PRoYblZkeRWH8IIwf0qPVPD9tq1hc2kxkWOcFWKEBh9OK+Lvgb4LTwteyaVJcmV7iBLpN3uW4/Svam0ssgYpy5yTU+3lLRmqpcuqZ7bpOlQ6NZR2sDO0aAAGQgn9AKu18/vpHtVSXRXGTVpJbFODk7tn0XRXzPPp/lnDDmqUtnnOBzT0MHGzsfUtFfPfwttXj8f6Wx6Dzf8A0U9fQlIRxPxZ1q20Pw7az3UTzRvdrGFQ85KOf6GuE027g1pQ1rayJnjmu0+M2f8AhGbPaoY/bU6jP8D1yXhy9k0+NjMVjVV3HjqKwrycad+hFOEXWv17G5babB4Ps5tU19xZWcKMwdm5kx/dryzw144vfjALyXRIlj8Ph2je8vcyMxHVVAxjFeM/tLfH59VtrrSrRnFpk+UC3KA16L+zkNXHw28PyWsLG1Z3EpSQIpbjJIINeNzym7H0EMPGL53ocp8X/hPrPhWyn1fwtqVxA5H/ACyO1jnrx6V0f7P/AMXz4p0e60PxFfSz3VnvaNZDyyKB19a9In8NX+q+JTczPD9hwQ0ZQ+Yvt1/pXhvgXTrXw/8AGSW38sGaR5oSgHG1du7P5iulO6smY1qap+9NWR78utaNIfkvXUe61MuraQ+F/tAODwd3FRR6usAz5Nsy+hXmie/juZEf7JAOP7n/ANevbUnY+Ta13PSPhqtquiXX2SUTRm6Ylgc87E4/lXyZ4S8Kprt74k0mOIQC6gxLLjA+fOcenSvrP4aOH0O5IRIx9qbhBgfcSvBPh9p1zYePNVW4ddsscSqgHy8Ft3P4iuarJX949SjflRPqGiJoPxK8O3qgiGS3a1YDoSuMY/76r0lkL5EfBGOGHaqGoaMdUutPuGcf6NNvAx0HGf5VuKxMm4nIIAxisHOC2Z02k+hTltimM7c/SqU1qgjhDH96+ScdK2J4wzhivy1WbYsiuyE7QQKy9pIfLPsYN1ZRAZwxP1rHngXnAIrp7p96/cC8c1j3bKinKnJIHA96XtWHK+pb+HUITxvpp5/5af8Aop69xrxfwEAvjawTBDL5meP+mbV7RXXRlzRuYTVmcX8VUL6BaAIZFF4pYDsNj8/yrz/Vla40K73QvHKABEfUV694kvr7T7GOWwtUvJvNAaORcjbg8/nivMvjP401ceD9Q02zs7W01GWNSbkjAiAHPf3rkxs+WjJPyNsHR9pXvHc/N79otfsnxDvLFHGxGcYT2Ne6fsf/ABqtdV8F/wDCEy3cdleHE0Etw4Bcn+EZrwL4h+EJ7jXrqZdQN+0hP7w1p/s9+Bp7L4n6PPcS4WKVXCxnn8a4lONpcu+h9C8FiIVeeovdPuHV73UfDU1zqN7MLI+XiSB2+Zm/hIHp1rx34E2918RvitdeK5JPK0lRMJJD0BbH+Fel/EbSxqOny+QWnk+7lCSOPX868E+EGtX/AIZ0DX/DV3NNoPmFnF7ImFDDPGSKz96HvCjT+sS9nV2Pr+w0q318NNpl9banCvXyCCR+tRtozQzlWtpiw7Yr4m03xXrnhq3YWl7cwW87kB0b/WD1Fey/DP8Aav1nwrNb2upbb+zjOA0qjeF9K7qWaxT95HVi+Doxjz0Z3Pr34fQNb6LMrQtBmdiFccn5V5rx6wuLc3D3a8EwB9w9817L4E+KGn/FnQ/7Y02MRRQyG1dQMfOFVj+jivnO11tF4yMdMV01qkavLNbM+ap0Hhpyo1N0en22oRqQhPA4FbtpdW7AcZNeTweI1DD5v1rYsPFaxyoS4UZ5+lcFWyeh2pK2h6gzwNGP3dZt4FUcLxWNrPjqwaC3Sy3I38TGucu/GAYH58/jWXPIiUZG/fSJu544rEuJljfIOSCOtY0/iRJTln6cdapTeIISCNw/OtE7rUVlbU7b4dTNJ43tC5yWaTH/AH7avba+ePhZqsd18QtLjVslvN/9FPX0PXpYf4H6nn1rc2hqeHImmvnUKrDyyTuHQZFfN37ZctxpNi4hIhW8+Vtg655b9a+l/CQLak47eUc/mK+ff26dOdfDGl3aIWMc5U4HY5P9K58fFOiz1Mlt9bd0fnpfo32mVQxwnT3rf+F0N2/xB0Q2sayOsytsZsA/Xmq15Yf6aSRw1dx8LfAl7rmrQ6jp19Haz6bMsjRFTl1/yK8DC6y1P1DMoNUIu2lj6ok06bTNf02zuYlklu4zkoQVUrjI/UV5x+0t8OLu70G9uLFo0Hmec0KgAn2GOcV9DaNo8WqSWd7KB5y/NvAPVsbv5Cn+NfCUDajFcywNdxY/1GOH+tfUvCuULn5O8c1Nps/Pbw38N/F2sz6fK2iXk2j2sQBliXqCTllz6YrC0vw9qWq3S2trbyXdyzMAscTM688FsV+mOjwx6foUdpa2y2aQx7I4gAdq9wfWtf4beB/DnhvUL24i0O3t5CBKt24Hftjr1B/OvBngJxnqfUYbP4wpe7HU8/8A2Zfhpqnwv+G32HVwRdX121+FPVVaONAMduYz1r5Yg12+brbEf8DFfoNe6mdVuXcwPAIz5a7xgMBzuA7Dn9K/NqO+cjcrKVHo1enOny04R7Hy06zxNadaW7Z1EXiG/Tj7IGPp5yr/ADNSp4m1t5BHBozTMeABdRj+ZrmU1XK8bfqeP51o6Nqrfb4uVJBzgtx+lcU01qy43vodZeah4l03ylvdKMCsu4D7TG38jWXJr+qSKdthKD71p+NvFPnyWpeVQfL2gIM1x9xrjqpJII/3m/xqY1EzWo58u5PeeJdegTI09WGf4n2/zNNXxLqAjDvZHd6LKprPGrfaI22vgDqAc/zqpJqbbCQ5P1wK0VRXONNtanqP7Pvie8vvjLoFtLYPDG/2jMhbIGLeU/0r7Rr4c/Zx1Dz/AI1+HE3jDfaeM/**********/V/iT4MksdL0Q3N4kgeKM3Spnr3ZwPzr0iirrUY1o8sjTDV3hpupFJt97/o0fAMv7NHxRa6Rv+EQYoOp/tG0/+O1u+Dfgd8VPCfjCyvo/CEpsmOLnGp2gGOMcebz3r7horihl1KDum/w/yPoqnEeKq01TcI2Sts//AJI898LW3iCxBS80CRY+oBu4z/J66S7m1CV42XRS23qDcj/4ut6ivaVWSjyHyMoKUnLucuj6jExP9h3Dk9/Ph4/8erCePxPeeKYprrRbptLjVMBLyFckMSRgP9K9ForGp+9d2awbpqyJrq7jvHWSO2e1G0AxuwY5+oJr4Ag/Zn+Kfyh/DXljvt1C2/8AjtffNFYypqaSbKjNxvY+A3/Zq+KwLRjwwzxZzn+0bX/47VnTv2bvijY3Ecn/AAjDFc8r/aFr0/7+1950Vg8LB7tmntpHw/rP7PvxOuyUh8NllI+8b+2+X/yJWM/7N/xY8javhgk/9hC1/wDjtffNFQsFTXVjlXnJWZ8At+zT8V4U3ReGCzkcr/aFqP8A2rUE/wCzV8XHiVh4Uy4/g/tG0/8AjtfoLRVfVKfmZqo0fHHwA+BnxE8HfFnw9q+veGxYaXbfaPPuPttvJs3W8ir8qSFjlmUcDvX2PRRXTTpqmrIiUnJ3Z//Z",
    "chatroomId": "**********@chatroom"
  }
}

{
  "ret": 500,
  "msg": "创建群聊失败",
  "data": {
    "code": "0",
    "msg": "MemberList are wrong"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» ret	integer	true	none	none
» msg	string	true	none	none
» data	object	true	none	none
»» headImgBase64	string	true	none	群头像的base64图片
»» chatroomId	string	true	none	群ID

POST 修改群名称

POST /group/modifyChatroomName

修改完群名称后若发现手机未展示修改后的名称，可能是手机缓存未刷新，手机聊天框多切换几次会刷新。

Body 请求参数

{
  "appId": "{{appid}}",
  "chatroomName": "VideosAPi test",
  "chatroomId": "**********@chatroom"
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» chatroomName	body	string	是	群名称
» chatroomId	body	string	是	群ID

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» ret	integer	true	none		none
» msg	string	true	none		none

POST 修改群备注

POST /group/modifyChatroomRemark

群备注仅自己可见修改完群备注后若发现手机未展示修改后的备注，可能是手机缓存未刷新，手机聊天框多切换几次会刷新。

Body 请求参数

{
  "appId": "{{appid}}",
  "chatroomRemark": "VideosApi test private",
  "chatroomId": "**********@chatroom"
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» chatroomRemark	body	string	是	群备注
» chatroomId	body	string	是	群ID

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» ret	integer	true	none		none
» msg	string	true	none		none

POST 修改我在群内的昵称

POST /group/modifyChatroomNickNameForSelf

Body 请求参数

{
  "appId": "{{appid}}",
  "nickName": "廖静",
  "chatroomId": "**********@chatroom"
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» nickName	body	string	是	群昵称
» chatroomId	body	string	是	群ID

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» ret	integer	true	none		none
» msg	string	true	none		none

POST 邀请/添加进群

POST /group/inviteMember

Body 请求参数

{
  "appId": "{{appid}}",
  "wxids": "wxid_**********",
  "chatroomId": "**********@chatroom",
  "reason": ""
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» wxids	body	string	是	邀请进群的好友wxid，多个英文逗号分隔
» chatroomId	body	string	是	群ID
» reason	body	string	是	邀请进群的说明

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» ret	integer	true	none		none
» msg	string	true	none		none

POST 删除群成员

POST /group/removeMember

Body 请求参数

{
  "appId": "{{appid}}",
  "wxids": "wxid_**********",
  "chatroomId": "**********@chatroom"
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» wxids	body	string	是	删除的群成员wxid，多个英文逗号分隔
» chatroomId	body	string	是	群ID

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» ret	integer	true	none		none
» msg	string	true	none		none

POST 退出群聊

POST /group/quitChatroom

Body 请求参数

{
  "appId": "{{appid}}",
  "chatroomId": "**********@chatroom"
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» chatroomId	body	string	是	群ID

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» ret	integer	true	none		none
» msg	string	true	none		none

POST 获取群信息

POST /group/getChatroomInfo

Body 请求参数

{
  "appId": "{{appid}}",
  "chatroomId": "**********@chatroom"
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» chatroomId	body	string	是	群ID（通过“获取通讯录列表”接口返回）

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功",
  "data": {
    "chatroomId": "VideosApi@chatroom",
    "nickName": "VideosApi test",
    "pyInitial": "VideosApiTEST",
    "quanPin": "VideosApitest",
    "sex": 0,
    "remark": "VideosApi test private",
    "remarkPyInitial": "VideosApiTEST",
    "remarkQuanPin": "VideosApiTEST",
    "chatRoomNotify": 1,
    "chatRoomOwner": "VideosAPi",
    "smallHeadImgUrl": "https://wx.qlogo.cn/mmcrhead/PiajxSqBRaEJEIII6n6NUHudK1r**********PRoWm7Km3ZQIpq8xp65nD6yUm8BHxzqhV1ic1jQvvnv/0",
    "memberList": [
      {
        "wxid": "VideosAPi",
        "nickName": "VideosAPi",
        "inviterUserName": null,
        "memberFlag": 1,
        "displayName": null,
        "bigHeadImgUrl": null,
        "smallHeadImgUrl": null
      },
      {
        "wxid": "wxid_***********",
        "nickName": "Ashley",
        "inviterUserName": "VideosAPi",
        "memberFlag": 1,
        "displayName": null,
        "bigHeadImgUrl": null,
        "smallHeadImgUrl": null
      },
      {
        "wxid": "wxid_*********",
        "nickName": "G",
        "inviterUserName": "VideosAPi",
        "memberFlag": 1,
        "displayName": null,
        "bigHeadImgUrl": null,
        "smallHeadImgUrl": null
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» ret	integer	true	none	none
» msg	string	true	none	none
» data	object	true	none	none
»» chatroomId	string	true	none	群ID
»» nickName	string	true	none	群名称
»» pyInitial	string	true	none	群名称的拼音首字母
»» quanPin	string	true	none	群名称的全拼
»» sex	integer	true	none	none
»» remark	string	true	none	群备注，仅自己可见
»» remarkPyInitial	string	true	none	群备注的拼音首字母
»» remarkQuanPin	string	true	none	群备注的全拼
»» chatRoomNotify	integer	true	none	群消息是否提醒
»» chatRoomOwner	string	true	none	群主的wxid
»» smallHeadImgUrl	string	true	none	群头像链接
»» memberList	[object]	true	none	群成员列表
»»» wxid	string	true	none	群成员的wxid
»»» nickName	string	true	none	群成员的昵称
»»» inviterUserName	string¦null	true	none	邀请人的wxid
»»» memberFlag	integer	true	none	标识
»»» displayName	null	true	none	在本群内的昵称
»»» bigHeadImgUrl	null	true	none	大尺寸头像
»»» smallHeadImgUrl	null	true	none	小尺寸头像

POST 获取群成员列表

POST /group/getChatroomMemberList

Body 请求参数

{
  "appId": "{{appid}}",
  "chatroomId": "**********@chatroom"
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» chatroomId	body	string	是	群ID

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功",
  "data": {
    "memberList": [
      {
        "wxid": "VideosAPi",
        "nickName": "VIdeosAPi",
        "inviterUserName": null,
        "memberFlag": 1,
        "displayName": null,
        "bigHeadImgUrl": "https://wx.qlogo.cn/mmhead/ver_1/T0MtLBu618rUlZqaAiaWfucmVibiawiciaSibPfz11siaLZr0qSxQTAR9lu7YicDwYAHNia1je79icxul6bzQ4LLZopiaM9EdYAEublPCLV29QKLv26ictBHjWsWnE0lvYGjibB9DkE6q/0",
        "smallHeadImgUrl": "https://wx.qlogo.cn/mmhead/ver_1/T0MtLBu618rUlZqaAiaWfucmVibiawiciaSibPfz11siaLZr0qSxQTAR9lu7YicDwYAHNia1je79icxul6bzQ4LLZopiaM9EdYAEublPCLV29QKLv26ictBHjWsWnE0lvYGjibB9DkE6q/132"
      },
      {
        "wxid": "wxid_**********",
        "nickName": "Ashley",
        "inviterUserName": "VideosApi",
        "memberFlag": 1,
        "displayName": null,
        "bigHeadImgUrl": "https://wx.qlogo.cn/mmhead/ver_1/5ibSibfNKwpv0TLLuSFv2hibEBqShib4BKsaxHZ2v10y9F93ibO5lK4bwib47qtuwsLZD8HY7fVicibWlWvehCLDCdicy38NaIbVupuMZMDwiaXozjUhk/0",
        "smallHeadImgUrl": "https://wx.qlogo.cn/mmhead/ver_1/5ibSibfNKwpv0TLLuSFv2hibEBqShib4BKsaxHZ2v10y9F93ibO5lK4bwib47qtuwsLZD8HY7fVicibWlWvehCLDCdicy38NaIbVupuMZMDwiaXozjUhk/132"
      },
      {
        "wxid": "wxid_**********",
        "nickName": "G",
        "inviterUserName": "VideosAPi",
        "memberFlag": 2049,
        "displayName": "G1",
        "bigHeadImgUrl": "https://wx.qlogo.cn/mmhead/ver_1/FMkteDauMN35F3lhfavibDYpGibfHqrsMICtqBbWDfwfQOnIYfgHBpOJLLbac0Wf3odowXcePFHMzj954EeFOiaKcsgIaMedw5KWZhBpaLsFfSK5HNAE7AQODQ1FfrPiaTCh/0",
        "smallHeadImgUrl": "https://wx.qlogo.cn/mmhead/ver_1/FMkteDauMN35F3lhfavibDYpGibfHqrsMICtqBbWDfwfQOnIYfgHBpOJLLbac0Wf3odowXcePFHMzj954EeFOiaKcsgIaMedw5KWZhBpaLsFfSK5HNAE7AQODQ1FfrPiaTCh/132"
      }
    ],
    "chatroomOwner": "VideosAPi",
    "adminWxid": [
      "wxid_**********"
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» ret	integer	true	none	none
» msg	string	true	none	none
» data	object	true	none	none
»» memberList	[object]	true	none	群成员列表
»»» wxid	string	true	none	群成员的wxid
»»» nickName	string	true	none	群成员昵称
»»» inviterUserName	string¦null	true	none	邀请人的wxid
»»» memberFlag	integer	true	none	标识
»»» displayName	string¦null	true	none	在本群内的昵称
»»» bigHeadImgUrl	string	true	none	大尺寸头像
»»» smallHeadImgUrl	string	true	none	小尺寸头像
»» chatroomOwner	null	true	none	群主的wxid
»» adminWxid	null	true	none	管理的wxid

POST 获取群成员详情

POST /group/getChatroomMemberDetail

Body 请求参数

{
  "appId": "{{appid}}",
  "chatroomId": "**********@chatroom",
  "memberWxids": [
    "wxid_**********",
    "wxid_**********"
  ]
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» chatroomId	body	string	是	群ID
» memberWxids	body	[string]	是	none

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功",
  "data": [
    {
      "userName": "wxid_**********",
      "nickName": "G",
      "pyInitial": "G",
      "quanPin": "G",
      "sex": 0,
      "remark": null,
      "remarkPyInitial": null,
      "remarkQuanPin": null,
      "chatRoomNotify": 0,
      "signature": null,
      "alias": null,
      "snsBgImg": "http://shmmsns.qpic.cn/mmsns/s5BUfupeMYsJx3WHf6RyTxAqLUpGZPsgD9l68D5iaf7qibkcjz08RwNwDxj9ToFvnaicFD2X8CtPe4/0",
      "bigHeadImgUrl": "https://wx.qlogo.cn/mmhead/ver_1/tmlG7SpZJMJEh0dA14icl4CWnliaI8pKvVicEMaowRywgVpljBK3nmBib0jHG4eVo5hiaqS7Gg0p7GwCuHopGYqdNBu9WVtxMB8icSFGUjibCDPoGXicPic1r3gx3PQ4YMf3GPfXj/0",
      "smallHeadImgUrl": "https://wx.qlogo.cn/mmhead/ver_1/tmlG7SpZJMJEh0dA14icl4CWnliaI8pKvVicEMaowRywgVpljBK3nmBib0jHG4eVo5hiaqS7Gg0p7GwCuHopGYqdNBu9WVtxMB8icSFGUjibCDPoGXicPic1r3gx3PQ4YMf3GPfXj/132",
      "description": null,
      "cardImgUrl": null,
      "labelList": null,
      "country": "CN",
      "province": "Guangdong",
      "city": "Foshan",
      "phoneNumList": null,
      "friendUserName": "wxid_**********",
      "inviterUserName": "VideosAPi",
      "memberFlag": 0
    },
    {
      "userName": "wxid_**********",
      "nickName": "Ashley",
      "pyInitial": "ASHLEY",
      "quanPin": "Ashley",
      "sex": 2,
      "remark": "小号",
      "remarkPyInitial": "XH",
      "remarkQuanPin": "xiaohao",
      "chatRoomNotify": 0,
      "signature": "山林不向四季起誓 枯荣随缘。",
      "alias": "zero-one_200906",
      "snsBgImg": "http://shmmsns.qpic.cn/mmsns/UaAfqYic92wm7ZCrsEwlQMXSmBLs8dpwBzrXnrOyyP3B8bDibCCFInJ9PicC9LPYY17uWH1yIOmBYQ/0",
      "bigHeadImgUrl": "https://wx.qlogo.cn/mmhead/ver_1/buiaXybHTBK3BuGr1edN72zBDermWVFJ7YC8Jib2RcCSdiauAtZcPgUQpdhE9KY5NsumDAWD16fsg3A6OKuhdEr97VAHdTGgk6R1Eibuj7ZNwJ4/0",
      "smallHeadImgUrl": "https://wx.qlogo.cn/mmhead/ver_1/buiaXybHTBK3BuGr1edN72zBDermWVFJ7YC8Jib2RcCSdiauAtZcPgUQpdhE9KY5NsumDAWD16fsg3A6OKuhdEr97VAHdTGgk6R1Eibuj7ZNwJ4/132",
      "description": null,
      "cardImgUrl": null,
      "labelList": "27",
      "country": "AD",
      "province": null,
      "city": null,
      "phoneNumList": [
        "\n\u000b14752126220"
      ],
      "friendUserName": "wxid_**********",
      "inviterUserName": null,
      "memberFlag": null
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» ret	integer	true	none	none
» msg	string	true	none	none
» data	[object]	true	none	none
»» userName	string	true	none	群成员的wxid
»» nickName	string	true	none	群成员的昵称
»» pyInitial	string	true	none	群成员昵称的拼音首字母
»» quanPin	string	true	none	群成员昵称的全拼
»» sex	integer	true	none	性别
»» remark	string¦null	true	none	备注
»» remarkPyInitial	string¦null	true	none	备注的拼音首字母
»» remarkQuanPin	string¦null	true	none	备注的全拼
»» chatRoomNotify	integer	true	none	消息通知
»» signature	string¦null	true	none	签名
»» alias	string¦null	true	none	微信号
»» snsBgImg	string	true	none	朋友圈背景图链接
»» bigHeadImgUrl	string	true	none	大尺寸头像
»» smallHeadImgUrl	string	true	none	小尺寸头像
»» description	null	true	none	描述
»» cardImgUrl	null	true	none	描述的图片链接
»» labelList	string¦null	true	none	标签列表，多个英文逗号分隔
»» country	string	true	none	国家
»» province	string¦null	true	none	省份
»» city	string¦null	true	none	城市
»» phoneNumList	[string]	true	none	手机号码
»» friendUserName	string	true	none	好友的wxid
»» inviterUserName	string¦null	true	none	邀请人的wxid
»» memberFlag	integer¦null	true	none	标识

POST 设置群公告

POST /group/setChatroomAnnouncement

仅群主或管理员可以发布群公告

Body 请求参数

{
  "appId": "{{appid}}",
  "chatroomId": "**********@chatroom",
  "content": "群公告哈"
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» chatroomId	body	string	是	群ID
» content	body	string	是	公告内容

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» ret	integer	true	none		none
» msg	string	true	none		none

POST 获取群公告

POST /group/getChatroomAnnouncement

Body 请求参数

{
  "appId": "{{appid}}",
  "chatroomId": "**********@chatroom"
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» chatroomId	body	string	是	群ID

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功",
  "data": {
    "announcement": "群公告哈",
    "announcementEditor": "**********",
    "publishTime": 1703839509
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» ret	integer	true	none	none
» msg	string	true	none	none
» data	object	true	none	none
»» announcement	string	true	none	群公告内容
»» announcementEditor	string	true	none	群公告作者的wxid
»» publishTime	integer	true	none	群公告发布时间

POST 同意进群

POST /group/agreeJoinRoom

Body 请求参数

{
  "appId": "{{appid}}",
  "url": "https://support.weixin.qq.com/cgi-bin/mmsupport-bin/addchatroombyinvite?ticket=A%2FtYjg2L%2FGB%2FHYqOwzWNMQ%3D%3D"
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» url	body	string	是	邀请进群回调消息中的url

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功",
  "data": {
    "chatroomId": "**********@chatroom"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» ret	integer	true	none	none
» msg	string	true	none	none
» data	object	true	none	none
»» chatroomId	string	true	none	群ID

POST 添加群成员为好友

POST /group/addGroupMemberAsFriend

添加群成员为好友，若对方关闭从群聊添加的权限则添加失败

Body 请求参数

{
  "appId": "{{appid}}",
  "chatroomId": "**********@chatroom",
  "content": "hallo",
  "memberWxid": "wxid_**********"
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» chatroomId	body	string	是	群ID
» memberWxid	body	string	是	群成员的wxid
» content	body	string	是	加好友的招呼语

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功",
  "data": {
    "v3": "v3_020b3826fd030100000000003a070e7757675c000000501ea9a3dba12f95f6b60a0536a1adb690dcccc9bf58cc80765e6eb16bffa5996420bb**********bdcd5689df8dfb21d40af93d286f72c3a0e8cfa6dcb68afed39226f008c6@stranger"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» ret	integer	true	none	none
» msg	string	true	none	none
» data	object	true	none	none
»» v3	string	true	none	添加群成员的v3，通过好友后会通过回调消息返回此值

POST 获取群二维码

POST /group/getChatroomQrCode

注意

在新设备登录后的1-3天内，无法使用本功能。在此期间，如果尝试进行获取，您将收到来自微信团队的提醒。请注意遵守相关规定。
生成的群二维码图片7天有效

Body 请求参数

{
  "appId": "{{appid}}",
  "chatroomId": "**********@chatroom"
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» chatroomId	body	string	是	群ID

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功",
  "data": {
    "qrBase64": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/wAALCAG4AbgBAREA/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/9oACAEBAAA/AP1Tooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooor+Veiiiiiiv6qK/lXr+qiiiv5V6/qor+Vev6qKKKKK/lXoooooor+qiiiv5V6KK/qoor+Veiv6qKKK/lXr+qiv5V6KKKKKK/qoooooor+Vev6qKKKKK/lXr+qiiiv5V6KKKKKK/qor+Veiiiv6qKK/lXor+qiiv5V6K/qoor+Veiv6qKK/lXr+qiv5V6KK/qor+Vev6qKKKKK/lXr+qiiiiiiv5V6/qor+Veiiv6qK/lXr+qiiv5V6K/qoor+Veiiv6qK/lXor+qiv5V6/qoor+Veiv6qK/lXor+qiiv5V6/qor+Veiv6qKKKKK/lXor+qiv5V6/qor+Veiiv6qK/lXr+qiiiiiiv5V6/qor+Veiiv6qK/lXr+qiiv5V6K/qor+Veiiiv6qKK/lXor+qiiv5V6/qor+Veiiiv6qKK/lXr+qiiiiv5V6KK/qor+Vev6qKK/lXr+qiv5V6KK/qor+Vev6qKKKKKK/lXr+qiv5V6KK/qor+Vev6qK/lXr+qiiv5V6K/qooor+Veiiiv6qKK/lXoooor+qiv5V6KK/qor+Vev6qKK/lXoor+qiiiiv5V6/qor+Veiiv6qK/lXr+qiiiiiiv5V6/qooooor+Vev6qK/lXr+qiv5V6K/qoor+Vev6qK/lXr+qiiv5V6/qoor+Vev6qKKK/lXoor+qiv5V6KK/qoor+Veiv6qK/lXr+qiiiv5V6/qooooor+Vev6qKKKKKK/lXoooooor+qiv5V6/qor+Vev6qK/lXr+qiv5V6/qor+Vev6qK/lXr+qiv5V6/qor+Vev6qK/lXr+qiv5V6/qor+Vev6qK/lXr+qiv5V6/qor+Vev6qK/lXr+qiv5V6/qor+Vev6qK/lXoooooor+qiiiiiiiiiiiiiiiiiiiv5V6/qor+Veiiiv6qKKK/lXr+qiiiv5V6/qor+Veiv6qK/lXr+qiv5V6/qor+Veiv6qK/lXor+qiiiiiiiiiiiiiiiiv5V6KKKKKK/qor+Veiiv6qK/lXooooooor+qiv5V6KKKK/qoooooor+Veiv6qK/lXor+qiv5V6/qooor+Veiv6qKKK/lXr+qiiiiiiv5V6KKK/qor+Vev6qK/lXr+qiiv5V6/qor+Vev6qK/lXoor+qiv5V6K/qor+Veiiv6qKKK/lXr+qiv5V6KK/qooor+Veiiv6qKKK/lXor+qiiv5V6/qooooooooor+Vev6qK/lXoor+qiv5V6/qor+Veiiv6qKKK/lXoor+qiiiv5V6KKK/qor+Veiiv6qKK/lXr+qiiv5V6/qoor+Veiv6qKK/lXor+qiv5V6/qor+Veiiiv6qKKKKKKK/lXoor+qiv5V6/qooor+Vev6qKKKK/lXoor+qiiv5V6/qooooor+Vev6qKK/lXr+qiiv5V6/qoor+Veiiv6qKKK/lXooor+qiiiv5V6/qooooooor+Vev6qK/lXr+qiiv5V6K/qor+Vev6qK/lXoor+qiv5V6K/qor+Vev6qKKKK/lXr+qiiv5V6K/qor+Vev6qK/lXor+qiiv5V6KKK/qor+Veiv6qK/lXor+qiiiiv5V6/qoooooor+Vev6qK/lXoor+qiiiv5V6K/qor+Vev6qKKKK/lXor+qiiiiv5V6KKK/qooor+Veiv6qKKKKK/lXor+qiv5V6/qoor+Vev6qKKK/lXr+qiiiiiiiiv5V6K/qor+Vev6qK/lXoor+qiv5V6K/qor+Vev6qKKK/lXr+qiiv5V6/qor+Veiv6qK/lXoor+qiv5V6/qooooor+Veiiv6qKK/lXoor+qiiv5V6KKKK/qooooooor+Veiiv6qK/lXr+qiv5V6/qoooor+Veiv6qK/lXoor+qiv5V6K/qoor+Vev6qKKK/lXr+qiv5V6/qoooor+Veiiiiiiv6qK/lXr+qiv5V6/qor+Veiiv6qKKKKKK/lXr+qiv5V6/qoor+Veiiiv6qK/lXoooor+qiiv5V6K/qor+Veiiv6qK/lXor+qiiv5V6/qoor+Vev6qK/lXooor+qiv5V6/qoor+Veiv6qKK/lXr+qiiiiiiiiiv5V6/qooor+Vev6qKK/lXr+qiiiiv5V6K/qoor+Vev6qKKKKKK/lXr+qiiiiiv5V6/qoor+Vev6qK/lXr+qiv5V6KKK/qoor+Veiv6qK/lXor+qiiiiiiiiiv5V6/qor+Vev6qK/lXoor+qiiiv5V6K/qooooor+Veiiiiv6qK/lXor+qiiv5V6/qor+Vev6qKK/lXr+qiiiiiiiv5V6KKKK/qor+Veiv6qKKKKKKK/lXr+qiiv5V6/qooor+Vev6qK/lXr+qiv5V6/qor+Veiiiv6qK/lXoor+qiiv5V6K/qoor+Veiv6qK/lXoooor+qiv5V6KK/qoor+Veiiv6qKKKKKKKKKKKKKKK/lXoor+qiv5V6/qor+Vev6qKKKKKK/lXor+qiiv5V6K/qor+Vev6qKK/lXr+qiiv5V6/qoooor+Veiiiiv6qK/lXor+qiiv5V6K/qooooooooor+Vev6qK/lXor+qiiv5V6/qoor+Veiiv6qK/lXoor+qiv5V6KKK/qooor+Veiiiiv6qK/lXr+qiiv5V6K/qoooor+Veiv6qKK/lXr+qiiiiiiiiiv5V6KK/qor+Veiiiiiv6qKK/lXor+qiv5V6KKKK/qor+Veiiiiiv6qKK/lXr+qiv5V6/qoor+Vev6qKKK/lXr+qiv5V6KKKK/qor+Veiiv6qKKKKKKKK/lXoor+qiiiv5V6/qoor+Vev6qK/lXor+qiiiv5V6/qor+Vev6qK/lXr+qiiiv5V6/qooor+Vev6qKK/lXr+qiiv5V6/qoor+Veiv6qKKK/lXr+qiiiv5V6/qoooooooooor+Vev6qK/lXr+qiv5V6K/qoor+Veiv6qK/lXr+qiiv5V6/qoor+Veiv6qK/lXr+qiv5V6K/qor+Veiiv6qKKK/lXoor+qiiv5V6/qor+Vev6qK/lXoor+qiiiiiiiiiiiiv5V6/qooor+Veiiiv6qKKK/lXr+qiiv5V6KKKK/qooor+Vev6qKK/lXor+qiv5V6/qoor+Veiiv6qKK/lXr+qiiiv5V6KKKK/qooooooor+Veiiiiiiiiiv6qKK/lXr+qiv5V6/qor+Vev6qK/lXr+qiv5V6KKKKKK/qoor+Vev6qK/lXor+qiiiv5V6/qoor+Veiiiiiiv6qK/lXr+qiiiiiiv5V6/qooor+Veiv6qK/lXoor+qiv5V6/qor+Veiv6qKK/lXoor+qiv5V6/qor+Vev6qK/lXoor+qiiiiv5V6K/qooor+Veiv6qK/lXor+qiv5V6/qor+Vev6qK/lXor+qiiiiiiv5V6K/qor+Veiiiiv6qK/lXor+qiiiiv5V6K/qoor+Veiiiv6qK/lXor+qiiv5V6KKK/qor+Vev6qK/lXoor+qiv5V6KK/qoooor+Vev6qK/lXr+qiiiiiiv5V6KK/qoooor+Veiiv6qKK/lXoor+qiv5V6KKK/qooor+Vev6qKK/lXooooor+qiv5V6/qor+Vev6qK/lXr+qiiiv5V6/qor+Veiiv6qK/lXr+qiiiiiiiiiiiv5V6KKK/qor+Vev6qKKK/lXr+qiiv5V6/qooooor+Vev6qKK/lXor+qiv5V6K/qoor+Vev6qK/lXoooooooor+qiv5V6KK/qor+Vev6qKKKKKK/lXr+qiv5V6/qor+Veiv6qKKK/lXor+qiv5V6/qor+Veiv6qKK/lXr+qiv5V6KK/qoor+Veiiv6qK/lXr+qiiiiv5V6/qor+Vev6qKK/lXor+qiiv5V6K/qooooooooooooor+Vev6qK/lXor+qiiiiv5V6K/qor+Veiv6qKKK/lXr+qiiv5V6K/qoor+Vev6qK/lXooooooor+qiv5V6/qor+Veiiiiiiiiv6qKKKKKKKK/lXr+qiiiv5V6/qor+Veiiv6qK/lXr+qiv5V6/qoor+Vev6qKK/lXr+qiv5V6K/qor+Vev6qKK/lXooor+qiv5V6/qoooor+Vev6qKK/lXr+qiiv5V6/qooor+Vev6qKKKKKKKK/lXoor+qiv5V6KKKK/qor+Vev6qK/lXr+qiiiiiiv5V6KK/qooooor+Vev6qKK/lXoooor+qiiiiiv5V6K/qor+Veiv6qKK/lXr+qiiiiiiiv5V6KKK/qooooor+Vev6qK/lXr+qiv5V6KK/qooooor+Veiv6qK/lXr+qiv5V6/qor+Vev6qK/lXor+qiiiv5V6K/qooooor+Veiv6qKKKKKKKKKK/lXor+qiv5V6K/qor+Vev6qK/lXr+qiiiv5V6K/qor+Vev6qKKK/lXor+qiv5V6/qor+Vev6qKK/lXr+qiv5V6KK/qooor+Veiv6qK/lXoor+qiiv5V6/qor+Veiiv6qKKKKKKKKK/lXr+qiv5V6K/qor+Vev6qK/lXr+qiiiv5V6/qoooor+Veiv6qKK/lXr+qiiv5V6K/qoor+Veiv6qK/lXr+qiiv5V6KK/qoor+Vev6qKK/lXr+qiv5V6/qor+Vev6qKKKKKKKK/lXr+qiiiv5V6KK/qor+Vev6qK/lXoooor+qiiiiiv5V6K/qooor+Veiiv6qKK/lXr+qiiiiv5V6KKKKKKKK/qooor+Vev6qKKKKKKK/lXoor+qiiiv5V6KK/qooor+Vev6qKKK/lXoor+qiiiiiv5V6KKK/qor+Veiiiv6qK/lXr+qiiiiiv5V6/qor+Vev6qK/lXr+qiv5V6K/qoooooor+Veiiv6qKKK/lXor+qiv5V6K/qor+Vev6qKK/lXooor+qiiv5V6KKKKK/qoor+Veiv6qKKKK/lXoor+qiv5V6KKKKK/qooor+Vev6qKKKKKKKKKKKKKK/lXor+qiv5V6/qoor+Veiiiv6qKK/lXoor+qiiiv5V6K/qoor+Veiiiv6qK/lXor+qiiiv5V6/qooor+Vev6qKKKKKKKKKK/lXoooooor+qiv5V6/qoor+Vev6qK/lXor+qiiv5V6KKKKK/qor+Vev6qK/lXoooor+qiv5V6/qoor+Vev6qK/lXr+qiiv5V6/qor+Vev6qK/lXor+qiiv5V6/qoooooor+Vev6qKKKKK/lXr+qiv5V6/qooor+Vev6qKK/lXor+qiv5V6/qooor+Vev6qKKK/lXor+qiiv5V6/qor+Veiiiiiiiiv6qKKK/lXr+qiiv5V6K/qoooooor+Vev6qK/lXoor+qiv5V6/qor+Vev6qK/lXooor+qiv5V6/qor+Veiv6qKKK/lXoooor+qiiv5V6KK/qor+Vev6qK/lXooooooooor+qiv5V6/qor+Vev6qKKKKKK/lXr+qiv5V6KK/qor+Vev6qK/lXor+qiv5V6/qoooooor+Veiv6qK/lXor+qiiiiiv5V6KK/qor+Vev6qKK/lXr+qiv5V6/qor+Vev6qK/lXor+qiv5V6/qor+Veiiv6qKKKKKK/lXr+qiv5V6KK/qor+Vev6qK/lXr+qiv5V6KKKKKKK/qoor+Veiv6qK/lXor+qiv5V6K/qor+Vev6qKKK/lXor+qiv5V6KK/qor+Veiv6qK/lXr+qiiv5V6KK/qoooooor+Vev6qKKKKK/lXr+qiv5V6K/qoor+Vev6qKK/lXoor+qiv5V6K/qor+Vev6qKKKK/lXr+qiv5V6/qoor+Veiv6qK/lXor+qiiv5V6K/qor+Vev6qK/lXr+qiiiv5V6/qoooooor+Veiiiiiiv6qKK/lXr+qiiv5V6KK/qooor+Vev6qKK/lXoor+qiv5V6K/qoooor+Vev6qKKK/lXoor+qiiv5V6/qoooor+Veiiiv6qKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK//2Q==",
    "qrTips": "该二维码7天内(1月5日前)有效，重新进入将更新"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» ret	integer	true	none	none
» msg	string	true	none	none
» data	object	true	none	none
»» qrBase64	string	true	none	群二维码图片的base64
»» qrTips	string	true	none	群二维码的提示

POST 群保存到通讯录

POST /group/saveContractList

Body 请求参数

{
  "appId": "{{appid}}",
  "chatroomId": "**********@chatroom",
  "operType": 3
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» chatroomId	body	string	是	群ID
» operType	body	integer	是	操作类型 3保存到通讯录 2从通讯录移除

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» ret	integer	true	none		none
» msg	string	true	none		none

POST 管理员操作

POST /group/adminOperate

添加、删除群管理员，转让群主

Body 请求参数

{
  "appId": "{{appid}}",
  "chatroomId": "**********@chatroom",
  "operType": 1,
  "wxids": [
    "wxid_**********"
  ]
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» chatroomId	body	string	是	群ID
» operType	body	integer	是	操作类型 1：添加群管理（可添加多个微信号） 2：删除群管理（可删除多个） 3：转让（只能转让一个微信号）
» wxids	body	[string]	是	none

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» ret	integer	true	none		none
» msg	string	true	none		none

POST 聊天置顶

POST /group/pinChat

Body 请求参数

{
  "appId": "{{appid}}",
  "chatroomId": "**********@chatroom",
  "top": true
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» chatroomId	body	string	是	群ID
» top	body	boolean	是	是否置顶

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» ret	integer	true	none		none
» msg	string	true	none		none

POST 设置消息免打扰

POST /group/setMsgSilence

Body 请求参数

{
  "appId": "{{appid}}",
  "chatroomId": "**********@chatroom",
  "silence": true
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» chatroomId	body	string	是	群ID
» silence	body	boolean	是	是否免打扰

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» ret	integer	true	none		none
» msg	string	true	none		none

POST 扫码进群

POST /group/joinRoomUsingQRCode

qrUrl是通过解析群二维码图片获得的内容

Body 请求参数

{
  "appId": "{{appid}}",
  "qrUrl": "https://weixin.qq.com/g/AwYAALLELoeKLg-qWAtkYtBdyTg_i2TG22w1GS-cL1GFO9J4AemIyZAw7RSuIpZw"
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» qrUrl	body	string	是	二维码的链接

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功",
  "data": {
    "chatroomName": "VideosApi-test-room(2)",
    "html": null,
    "chatroomId": "**********@chatroom"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» ret	integer	true	none	none
» msg	string	true	none	none
» data	object	true	none	none
»» chatroomName	string	true	none	群名称
»» html	null	true	none	none
»» chatroomId	string	true	none	群ID

POST 确认进群申请

POST /group/roomAccessApplyCheckApprove

群聊开启邀请确认后，有人申请进群时群主和管理员会收到进群申请，本接口用于确认进群申请

Body 请求参数

{
  "appId": "{{appid}}",
  "chatroomId": "**********@chatroom",
  "msgContent": "<sysmsg type=\"NewXmlChatRoomAccessVerifyApplication\">\n\t<NewXmlChatRoomAccessVerifyApplication>\n\t\t<text> <![CDATA[\"Ashley\"想邀请1位朋友加入群聊]]></text>\n\t\t <link>\n\t\t\t<scene>roomaccessapplycheck_approve</scene>\n\t\t\t<text> <![CDATA[ 去确认]]></text>\n\t\t\t<ticket> <![CDATA[AwAAAAEAAAAVxQT9t2UOmpKWhJUViezAdSPKcaOLjP8JydTTWGHXiByZInpCp71HDoXAui/u7ByQVOutX93UlKBpkA2/3FoSAET1nA==]]> </ticket>\n\t\t\t<invitationreason> <![CDATA[进一下]]> </invitationreason>\n\t\t\t<inviterusername> <![CDATA[wxid_p**********]]> </inviterusername>\n\t\t\t<memberlist>\n\t\t\t\t<memberlistsize>1</memberlistsize>\n\t\t\t\t<member>\n\t\t\t\t\t<username> <![CDATA[wxid_8pvk**********]]> </username>\n\t\t\t\t\t<nickname> <![CDATA[白开水加糖]]> </nickname>\n\t\t\t\t\t<headimgurl> <![CDATA[http://wx.qlogo.cn/mmhead/ver_1/b6BQ3ibU4I5hDEtSyR1unAOaQMymjgk6gE9bUmteJUY6JAaJeMKJvibkLEia8PpbvuDo96bC5JKhydyLJWia7yTmahwwb0ZfjGZy9jMsibbQBVmU/96]]> </headimgurl>\n\t\t\t\t\t<quitchatroominfo> <![CDATA[曾被移出群聊,建议谨慎通过,]]> </quitchatroominfo>\n\t\t\t\t</member>\n\t\t\t</memberlist>\n\t\t</link>\n\t\t<RoomName> <![CDATA[34757816141@chatroom]]> </RoomName>\n\t</NewXmlChatRoomAccessVerifyApplication>\n</sysmsg>",
  "newMsgId": "8866462780395237368"
}

请求参数

名称	位置	类型	必选	说明
VideosApi-token	header	string	是	none
body	body	object	否	none
» appId	body	string	是	设备ID
» chatroomId	body	string	是	群ID
» newMsgId	body	string	是	消息ID
» msgContent	body	string	是	消息内容

返回示例

200 Response

{
  "ret": 200,
  "msg": "操作成功"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» ret	integer	true	none		none
» msg	string	true	none		none

wechatapi-微信号二次开发-群管理模块

默认模块

Authentication

开发API/群管理接口

POST 创建微信群

请求参数

返回结果

返回数据结构

POST 修改群名称

请求参数

返回结果

返回数据结构

POST 修改群备注

请求参数

返回结果

返回数据结构

POST 修改我在群内的昵称

请求参数

返回结果

返回数据结构

POST 邀请/添加 进群

请求参数

返回结果

返回数据结构

POST 删除群成员

请求参数

返回结果

返回数据结构

POST 退出群聊

请求参数

返回结果

返回数据结构

POST 获取群信息

请求参数

返回结果

返回数据结构

POST 获取群成员列表

请求参数

返回结果

返回数据结构

POST 获取群成员详情

请求参数

返回结果

返回数据结构

POST 设置群公告

请求参数

返回结果

返回数据结构

POST 获取群公告

请求参数

返回结果

返回数据结构

POST 同意进群

请求参数

返回结果

返回数据结构

POST 添加群成员为好友

请求参数

返回结果

返回数据结构

POST 获取群二维码

注意

请求参数

返回结果

返回数据结构

POST 群保存到通讯录

请求参数

返回结果

返回数据结构

POST 管理员操作

请求参数

返回结果

返回数据结构

POST 聊天置顶

请求参数

返回结果

返回数据结构

POST 设置消息免打扰

请求参数

返回结果

POST 邀请/添加进群