Laravel
话题列表 社区 Wiki 优质外文 招聘求职 Laravel 实战教程 社区文档
登录
注册

企微

Hanson 的个人博客 / 1 / 0 / 创建于 1年前

title: 企微协议（新） v1.0.0

企微协议（新）#

v1.0.0

Base URLs:

客户端#

POST 获取所有实例列表#

POST /client/all_clients

Body 请求参数

{}

请求参数#

名称 位置 类型 必选 说明
body body object 否 none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 恢复实例#

POST /client/restore_client

代理支持 http、socks4 和 socks5 的 url 格式：如 127.0.0.1:10807, socks5://user:pass@10.10.1.10:3128, 不使用代理请留空

Body 请求参数

{
  "guid": "string",
  "proxy": "",
  "bridge": "",
  "sync_history_msg": true,
  "force_online": true
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 Guid none
» proxy body string 否 Proxy none
» bridge body string 否 Bridge none
» sync_history_msg body boolean 否 Sync History Msg none
» force_online body boolean 是 none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 删除实例#

POST /client/remove_client

Body 请求参数

{
  "guid": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body StopClientModel 否 StopClientModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 设置实例桥接 ID#

POST /client/set_bridge

Body 请求参数

{
  "guid": "string",
  "bridge": "string"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body ClientBridgeModel 否 ClientBridgeModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 设置代理#

POST /client/set_proxy

Body 请求参数

{
  "guid": "",
  "proxy": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none
» proxy body string 是 none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 设置通知消息开关#

POST /client/set_notify_msg_flag

Body 请求参数

{
  "guid": "string",
  "self_msg": true,
  "contact_msg": true,
  "self_room_msg": true,
  "contact_room_msg": true,
  "room_white_list": []
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none
» self_msg body boolean 是 none
» contact_msg body boolean 是 none
» self_room_msg body boolean 是 none
» contact_room_msg body boolean 是 none
» room_white_list body [string] 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

全局#

POST 通知回调地址#

POST /global/set_notify_url

Body 请求参数

{
  "notify_url": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body pywemodels__global___NotifyUrlModel 否 NotifyUrlModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

登录#

POST 获取登录二维码#

POST /login/get_login_qrcode

Body 请求参数

{
  "guid": "string",
  "verify_login": false
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none
» verify_login body boolean 是 收到 LoginSafeVerify = 11012 # 登录安全验证通知 的回调后，传 true 重新扫码

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 检查登录二维码#

POST /login/check_login_qrcode

Body 请求参数

{
  "guid": "string"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body CheckLoginQRCodeModel 否 CheckLoginQRCodeModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 保持登录#

POST /login/keep_login

Body 请求参数

{
  "guid": "string"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body ManualLoginModel 否 ManualLoginModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 输入登录验证码#

POST /login/verify_login_qrcode

当二维码回调 status == QRCODE_REQUIRE_VERIFY (10) 时， 也就是需要登录验证了，在业务前端让用户输入验证码

Body 请求参数

{
  "guid": "",
  "code": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none
» code body string 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

POST 自动登录#

POST /login/auto_login

模拟退出企微，重新打开自动登录的场景

Body 请求参数

{
  "guid": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

POST 推送手机确认登录通知#

POST /login/push_login_url

Body 请求参数

{
  "guid": "string"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

用户#

POST 获取当前帐号信息#

POST /user/get_profile

Body 请求参数

{
  "guid": "string"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body GetProfileModel 否 GetProfileModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 获取当前帐号公司信息#

POST /user/get_corp_info

Body 请求参数

{
  "guid": "string"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body GetCorpInfoModel 否 GetCorpInfoModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 登出#

POST /user/logout

Body 请求参数

{
  "guid": "string"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body LogoutModel 否 LogoutModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 获取二维码名片#

POST /user/get_qrcode_card

Body 请求参数

{
  "guid": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

POST 获取二维码名片 (新)#

POST /user/get_qrcode_card_new

Body 请求参数

{
  "guid": "string"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body GetProfileModel 否 GetProfileModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

企业架构#

POST 同步公司架构#

POST /arch/sync_arch

Body 请求参数

{
  "guid": "string",
  "cli_version": "",
  "limit": 100
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SyncArchModel 否 SyncArchModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 获取公司架构节点数据#

POST /arch/get_arch_node_data

Body 请求参数

{
  "guid": "string",
  "node_list": []
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body GetArchNodeDataModel 否 GetArchNodeDataModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 修改同事信息 (备注和描述)#

POST /arch/modify_colleague_info

Body 请求参数

{
  "guid": "string",
  "user_id": "string",
  "remark": "string",
  "desc": "string"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body ModifyColleagueInfoModel 否 ModifyColleagueInfoModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 同步同事信息#

POST /arch/sync_colleague_info

Body 请求参数

{
  "guid": "string",
  "seq": "string",
  "limit": 10
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none
» seq body string 是 none
» limit body integer 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

会话#

POST 获取会话列表#

POST /session/get_session_list

Body 请求参数

{
  "guid": "",
  "begin_seq": "0",
  "limit": 100
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none
» begin_seq body string 是 none
» limit body integer 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

POST 设置会话命令#

POST /session/set_session_cmd

Body 请求参数

{
  "guid": "",
  "conversation_id": "",
  "cmd": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none
» conversation_id body string 是 none
» cmd body string 是 免打扰 shield

详细说明#

» cmd: 免打扰 shield
取消免打扰 unshield
置顶会话 top
取消置顶 down
群保存到通讯录 collect
群移除通讯录 uncollect
群折叠 fold
群取消折叠 unfold

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

联系人#

POST 同步联系人#

POST /contact/sync_contact

Body 请求参数

{
  "guid": "string",
  "seq": "",
  "limit": 10
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SyncContactModel 否 SyncContactModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 同步申请好友列表#

POST /contact/sync_apply_contact

Body 请求参数

{
  "guid": "string",
  "seq": "",
  "limit": 10
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SyncApplyContactModel 否 SyncApplyContactModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 批量获取用户信息#

POST /contact/batch_get_userinfo

Body 请求参数

{
  "guid": "string",
  "user_list": []
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body BatchGetUserInfoModel 否 BatchGetUserInfoModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 更新联系人#

POST /contact/update_contact

Body 请求参数

{
  "guid": "string",
  "user_id": "",
  "desc": "",
  "remark": "",
  "remark_url": "",
  "company_remark": "",
  "phone_list": [],
  "label_info_list": []
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body UpdateContactModel 否 UpdateContactModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 添加搜索的微信用户#

POST /contact/add_search_wx_contact

Body 请求参数

{
  "guid": "string",
  "user_id": "0",
  "openid": "",
  "wx_ticket": "",
  "verify": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body AddSearchWxContactModel 否 AddSearchWxContactModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 通过手机号搜索微信 / 企微用户#

POST /contact/search_contact

Body 请求参数

{
  "guid": "string",
  "keyword": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SearchContactModel 否 SearchContactModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 添加搜索的企微用户#

POST /contact/add_search_wx_work_contact

Body 请求参数

{
  "guid": "string",
  "user_id": "0",
  "corp_id": "0",
  "verify": "",
  "ticket": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body AddSearchWxWorkContactModel 否 AddSearchWxWorkContactModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 添加名片为联系人#

POST /contact/add_card_contact

Body 请求参数

{
  "guid": "string",
  "user_id": "0",
  "corp_id": "0",
  "room_id": "0",
  "from_user_id": "0",
  "verify": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body AddCardContactModel 否 AddCardContactModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 添加被对方的删除联系人#

POST /contact/add_deleted_contact

Body 请求参数

{
  "guid": "string",
  "user_id": "0",
  "corp_id": "0",
  "verify": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body AddDeletedContactModel 否 AddDeletedContactModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 同意联系人申请#

POST /contact/agree_contact

Body 请求参数

{
  "guid": "string",
  "user_id": "0",
  "corp_id": "0"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body AgreeContactModel 否 AgreeContactModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 删除联系人#

POST /contact/delete_contact

Body 请求参数

{
  "guid": "string",
  "user_id": "0",
  "corp_id": "0"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body DeleteContactModel 否 DeleteContactModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 批量获取公司信息#

POST /contact/batch_get_corpinfo

Body 请求参数

{
  "guid": "string",
  "corp_list": []
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body BatchGetCorpInfoModel 否 BatchGetCorpInfoModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

群聊#

POST 获取客户群列表#

POST /room/get_room_list

Body 请求参数

{
  "guid": "string",
  "start_index": 0,
  "limit": 10
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body GetRoomListModel 否 GetRoomListModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 批量获取群详细信息#

POST /room/batch_get_room_detail

Body 请求参数

{
  "guid": "string",
  "room_list": []
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body BatchGetRoomDetailModel 否 BatchGetRoomDetailModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 批量获取群成员详细信息#

POST /room/batch_get_member_detail

Body 请求参数

{
  "guid": "string",
  "room_id": "",
  "user_list": []
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body BatchGetRoomMemberDetailModel 否 BatchGetRoomMemberDetailModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 创建外部群#

POST /room/create_outer_room

Body 请求参数

{
  "guid": "string",
  "user_list": []
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body CreateOuterRoomModel 否 CreateOuterRoomModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 创建内部群#

POST /room/create_inner_room

Body 请求参数

{
  "guid": "string",
  "user_list": []
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body CreateInnerRoomModel 否 CreateInnerRoomModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 创建空的外部群#

POST /room/create_empty_outer_room

Body 请求参数

{
  "guid": "string"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body CreateEmptyOuterRoomModel 否 CreateEmptyOuterRoomModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 修改群名称#

POST /room/modify_room_name

Body 请求参数

{
  "guid": "string",
  "room_id": "",
  "room_name": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body ModifyRoomNameModel 否 ModifyRoomNameModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 邀请 / 添加群成员#

POST /room/invite_room_member

Body 请求参数

{
  "guid": "string",
  "room_id": "",
  "user_list": []
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body InviteRoomMemberModel 否 InviteRoomMemberModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 移除群成员#

POST /room/remove_room_member

Body 请求参数

{
  "guid": "string",
  "room_id": "",
  "user_list": []
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body RemoveRoomMemberModel 否 RemoveRoomMemberModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 获取群二维码#

POST /room/get_room_qrcode

Body 请求参数

{
  "room_id": "10864048529087050",
  "guid": "5038d5bb-b1b4-3a01-958a-a96dd230c013",
  "get_type": 1
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» room_id body string 是 none
» guid body string 是 none
» get_type body integer 是 none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 修改群公告#

POST /room/modify_room_notice

Body 请求参数

{
  "guid": "string",
  "room_id": "",
  "notice": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body ModifyRoomNoticeModel 否 ModifyRoomNoticeModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 转让群主#

POST /room/change_room_master

Body 请求参数

{
  "guid": "string",
  "room_id": "",
  "user_id": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body ChangeRoomMasterModel 否 ChangeRoomMasterModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 添加群管理员#

POST /room/room_add_admin

Body 请求参数

{
  "guid": "string",
  "room_id": "",
  "user_list": []
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body RoomAddAdminModel 否 RoomAddAdminModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 移除群管理员#

POST /room/room_remove_admin

Body 请求参数

{
  "guid": "string",
  "room_id": "",
  "user_list": []
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body RoomRemoveAdminModel 否 RoomRemoveAdminModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 开启 / 关闭群邀请确认#

POST /room/modify_invite_status

Body 请求参数

{
  "guid": "string",
  "room_id": "",
  "status": 0
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body ModifyRoomInviteStatusModel 否 ModifyRoomInviteStatusModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 开启 / 关闭禁止修改群名#

POST /room/modify_name_guard_status

Body 请求参数

{
  "guid": "string",
  "room_id": "",
  "status": 0
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body ModifyRoomNameGuardModel 否 ModifyRoomNameGuardModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 退出群#

POST /room/quit_room

Body 请求参数

{
  "guid": "string",
  "room_id": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body QuitRoomModel 否 QuitRoomModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 解散群#

POST /room/dismiss_room

Body 请求参数

{
  "guid": "string",
  "room_id": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body DismissRoomModel 否 DismissRoomModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 获群入群欢迎语#

POST /room/get_welcome_list

Body 请求参数

{
  "guid": "string",
  "offset": "",
  "limit": 10,
  "welcome_type": 10
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body GetRoomWelcomeListModel 否 GetRoomWelcomeListModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 设置入群欢迎语#

POST /room/set_welcome

Body 请求参数

{
  "guid": "string",
  "room_id": "",
  "msg_type": 0,
  "msg_index": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none
» room_id body string 是 none
» msg_type body integer 是 none
» msg_index body string 是 none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 获取群防骚扰规则#

POST /room/get_antispam_list

Body 请求参数

{
  "guid": "string"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body GetAntiSpamListModel 否 GetAntiSpamListModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 设置群防骚扰规则#

POST /room/set_antispam_rule

Body 请求参数

{
  "guid": "string",
  "room_id": "",
  "rule_list": []
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SetAntiSpamRuleModel 否 SetAntiSpamRuleModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 添加群联系人#

POST /room/add_room_contact

Body 请求参数

{
  "guid": "string",
  "room_id": "",
  "user_id": "",
  "corp_id": "",
  "verify": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body AddRoomContactModel 否 AddRoomContactModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 设置客户群黑名单#

POST /room/opr_room_black_list

Body 请求参数

{
  "guid": "string",
  "user_list": [
    "string"
  ],
  "status": 1
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body OprRoomBlackListModel 否 OprRoomBlackListModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 获取客户群黑名单#

POST /room/get_room_black_list

Body 请求参数

{
  "guid": "string",
  "page_buff": "",
  "limit": 2000
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body GetBlackListModel 否 GetBlackListModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 设置客户群白名单#

POST /room/opr_room_white_list

Body 请求参数

{
  "guid": "string",
  "user_list": [
    "string"
  ],
  "status": 1
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body OprRoomWhiteListModel 否 OprRoomWhiteListModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 通过群邀请链接进群#

POST /room/accept_invite_url

Body 请求参数

{
  "guid": "string",
  "invite_url": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body AcceptInviteUrlModel 否 AcceptInviteUrlModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 增量同步群信息#

POST /room/sync_room_info

Body 请求参数

{
  "guid": "string",
  "room_id": "string",
  "version": 0
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none
» room_id body string 是 none
» version body integer 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

POST 修改群内昵称#

POST /room/modify_in_room_nickname

Body 请求参数

{
  "guid": "string",
  "room_id": "string",
  "nickname": "string"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body ModifyInRoomNicknameModel 否 ModifyInRoomNicknameModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 修改群备注#

POST /room/modify_room_remark

Body 请求参数

{
  "guid": "string",
  "room_id": "string",
  "remark": "string"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body ModifyRoomRemarkModel 否 ModifyRoomRemarkModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 获取群置顶消息#

POST /room/get_room_top_msg

Body 请求参数

{
  "guid": "string",
  "room_id": "string"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body GetRoomTopMsgModel 否 GetRoomTopMsgModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 设置群置顶消息#

POST /room/set_room_top_msg

Body 请求参数

{
  "guid": "string",
  "room_id": "string",
  "message": {},
  "appinfo": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SetRoomTopMsgModel 否 SetRoomTopMsgModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 移除群置顶消息#

POST /room/remove_room_top_msg

Body 请求参数

{
  "guid": "string",
  "room_id": "string",
  "top_id": "string"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body RemoveRoomTopMsgModel 否 RemoveRoomTopMsgModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

消息#

POST 发送文本消息#

POST /msg/send_text

Body 请求参数

{
  "guid": "string",
  "conversation_id": "",
  "content": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SendTextModel 否 SendTextModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 发送群 @消息#

POST /msg/send_room_at

at_list 传 [0], 是 @全部

只有群主或管理员能 at 全部人

Body 请求参数

{
  "guid": "string",
  "conversation_id": "",
  "content": "",
  "at_list": []
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SendRoomAtModel 否 SendRoomAtModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 发送语音消息#

POST /msg/send_voice

Body 请求参数

{
  "guid": "string",
  "conversation_id": "",
  "file_id": "",
  "size": 0,
  "voice_time": 0,
  "aes_key": "",
  "md5": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SendVoiceModel 否 SendVoiceModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 发送位置消息#

POST /msg/send_location

Body 请求参数

{
  "guid": "string",
  "conversation_id": "",
  "longitude": 0,
  "latitude": 0,
  "address": "",
  "title": "",
  "zoom": 0
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SendLocationModel 否 SendLocationModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 发送图片消息#

POST /msg/send_image

Body 请求参数

{
  "guid": "string",
  "conversation_id": "",
  "file_id": "",
  "size": 0,
  "image_width": 0,
  "image_height": 0,
  "aes_key": "",
  "md5": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SendImageModel 否 SendImageModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 发送文件消息#

POST /msg/send_file

Body 请求参数

{
  "guid": "string",
  "conversation_id": "",
  "file_id": "",
  "size": 0,
  "file_name": "",
  "aes_key": "",
  "md5": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SendFileModel 否 SendFileModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 发送视频消息#

POST /msg/send_video

Body 请求参数

{
  "guid": "string",
  "conversation_id": "",
  "file_id": "",
  "size": 0,
  "file_name": "",
  "aes_key": "",
  "md5": "",
  "video_duration": 0,
  "video_width": 0,
  "video_height": 0
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SendVideoModel 否 SendVideoModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 发送 Gif 消息#

POST /msg/send_gif

Body 请求参数

{
  "guid": "string",
  "conversation_id": "",
  "file_id": "",
  "size": 0,
  "aes_key": "",
  "md5": "",
  "url": "",
  "image_width": 0,
  "image_height": 0
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SendGifModel 否 SendGifModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 发送名片#

POST /msg/send_personal_card

Body 请求参数

{
  "guid": "string",
  "conversation_id": "",
  "user_id": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SendPersonalCardModel 否 SendPersonalCardModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 发送链接#

POST /msg/send_link

Body 请求参数

{
  "guid": "string",
  "conversation_id": "",
  "title": "",
  "description": "",
  "url": "",
  "image_url": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SendLinkModel 否 SendLinkModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 发送小程序#

POST /msg/send_weapp

Body 请求参数

{
  "guid": "string",
  "conversation_id": "",
  "username": "",
  "appid": "",
  "appname": "",
  "appicon": "",
  "title": "",
  "page_path": "",
  "file_id": "",
  "size": 0,
  "aes_key": "",
  "md5": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SendWeAppModel 否 SendWeAppModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 发送视频号#

POST /msg/send_feed_video

Body 请求参数

{
  "guid": "string",
  "conversation_id": "",
  "feed_type": 0,
  "cover_url": "",
  "thumb_url": "",
  "avatar": "",
  "nickname": "",
  "desc": "",
  "url": "",
  "extras": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SendFeedVideoModel 否 SendFeedVideoModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 获取语音消息翻译 id#

POST /msg/apply_voice_id

Body 请求参数

{
  "guid": "string",
  "conversation_id": "",
  "msgid": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body ApplyVoiceToTextModel 否 ApplyVoiceToTextModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 获取语音消息翻译结果#

POST /msg/query_voice_text

Body 请求参数

{
  "guid": "string",
  "conversation_id": "",
  "msgid": "",
  "voiceid": "",
  "seqid": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body QueryVoiceToTextModel 否 QueryVoiceToTextModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 确认企微内部消息已读#

POST /msg/confirm_msg

Body 请求参数

{
  "guid": "string",
  "message_type": 0,
  "sender": "",
  "receiver": "",
  "roomid": "",
  "msgid": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body ConfirmMsgModel 否 ConfirmMsgModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 撤回消息#

POST /msg/revoke_msg

Body 请求参数

{
  "guid": "string",
  "conversation_id": "",
  "msgid": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body RevokeMsgModel 否 RevokeMsgModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 标记会话已读#

POST /msg/report_unread

Body 请求参数

{
  "guid": "string",
  "conversation_id": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body ReportUnReadModel 否 ReportUnReadModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 极速群发#

POST /msg/send_group_msg

Body 请求参数

{
  "guid": "087c16d6-050e-3eda-8e04-68de09780291",
  "user_list": [
    "7881301xxxxxxx"
  ],
  "room_list": [
    "10779xxxxxxxx"
  ],
  "content": "你好",
  "image_msg_list": [
    {
      "image_url": "https://wework.qpic.cn/wwpic/816939_13XbcgvqQimlLzs_1688522339/0",
      "size": 10000,
      "thumb_width": 300,
      "thumb_height": 240
    }
  ],
  "video_msg_list": [
    {
      "file_id": "",
      "size": 0,
      "file_name": "",
      "aes_key": "",
      "md5": "",
      "video_duration": 15,
      "video_width": 300,
      "video_height": 240
    }
  ],
  "weapp_msg_list": [
    {
      "username": "",
      "appid": "",
      "appname": "",
      "appicon": "",
      "title": "",
      "page_path": "",
      "file_id": "",
      "size": 0,
      "aes_key": "",
      "md5": ""
    }
  ],
  "link_msg_list": [
    {
      "title": "",
      "description": "",
      "url": "",
      "image_url": ""
    }
  ]
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none
» user_list body [string] 是 none
» room_list body [string] 是 none
» content body string 是 none
» image_msg_list body [string] 是 none
» video_msg_list body [string] 是 none
» weapp_msg_list body [string] 是 none
» link_msg_list body [string] 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

POST 发送 Gif 消息#

POST /msg/send_gif_url

url 可以用 /cloud/add_image 上传

Body 请求参数

{
  "guid": "string",
  "conversation_id": "",
  "url": "",
  "md5": "",
  "image_width": 0,
  "image_height": 0
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SendGifUrlModel 否 SendGifUrlModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 发送聊天合集（合并转发）#

POST /msg/send_forward_msg

发送聊天合集#

支持合集消息嵌套

1. msg_type 值#

    kTextMsg = 2                  # 文本消息
    kLocationMsg = 3              # 位置消息
    kLinkCardMsg = 4              # 链接消息
    kImageMsg = 5                 # 图片消息
    kVideoMsg = 7                 # 视频消息
    kFileMsg = 8                  # 文件消息
    kForwardMsg = 16              # 合集消息
{
    "guid": "cfec5383-a80d-3a11-b7e7-5f46a7b39a73",
    "conversation_id" : "S:788129xxx",
    "message_list": [
        {
            "msg_type": 2,
            "content": "文本消息"
        },   
        {
            "msg_type": 3,
            "longitude": 116.39,
            "latitude": 39.90,
            "address": "北京市东城区东长安街",
            "title": "天安门",
            "zoom": 15.0
        }, 
        {
            "msg_type": 4,
            "title": "百度一下",
            "desc": "用科技让复杂的世界更简单！",
            "url": "https://www.baidu.com",
            "image_url": "https://img.jbzj.com/file_images/Illustrator/201702/2017020411591786.png"
        },
        {
            "msg_type": 5,
            "file_id": "3069020102046230600201000204283cabaa02030f4df90204ace63cb70204659fef4b042430666438386237652d633365622d346439632d623134362d61323233386531613734653902010002030bc970041025e2ceb37e281290fcac8d32e5353f4e0201020201000400",
            "size": 772458,
            "aes_key": "7e7c6dc5e523f6e66354a0619d12d423",
            "md5": "25e2ceb37e281290fcac8d32e5353f4e",
            "image_width": 600,
            "image_height": 800
        },
        {
            "msg_type": 7,
            "file_id": "30819402010204818c3081890201000204283cabaa02030f4df90204ace63cb702046597b5ef044c4e45574944315f32383363616261616163653633636237363539666630363630303032653830325f32303961366435332d336166642d346165352d613666332d646637626431333264613735020100020400a2a910041025794543d528125d6221e60bb5d903ca0201040201000400",
            "size": 10660107,
            "aes_key": "62643161646438636365356163313239",
            "md5": "25794543d528125d6221e60bb5d903ca",
            "file_name": "a.mp4",
            "video_duration": 14,
            "video_width": 800,
            "video_height": 450
        },
        {
            "msg_type": 8,
            "file_id": "3069020102046230600201000204283cabaa02030f4df90204ace63cb70204659fefc9042462353361363839622d666531622d343434652d393464642d62316237313763666137653302010002037ca7100410e313756042fcb1fc862ad942407acb040201050201000400",
            "size": 8169221,
            "aes_key": "0e8f16ace6f64ad49e9c2b9531bbabaf",
            "md5": "e313756042fcb1fc862ad942407acb04",
            "file_name": "Linux 内核源代码完全注释。第三版.pdf"
        },
        {
            "msg_type": 16,
            "message_list": [
                {
                    "msg_type": 2,
                    "content": "嵌套文本消息"
                }
            ]
        }
    ]
}

Body 请求参数

{
  "guid": "string",
  "conversation_id": "",
  "message_list": []
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SendForwardMsgModel 否 SendForwardMsgModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 发送视频号直播#

POST /msg/send_feed_live

Body 请求参数

{
  "guid": "string",
  "conversation_id": "",
  "feed_type": 0,
  "cover_url": "",
  "thumb_url": "",
  "avatar": "",
  "nickname": "",
  "desc": "",
  "url": "",
  "extras": "",
  "object_id": "",
  "object_nonce_id": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none
» conversation_id body string 是 none
» feed_type body integer 是 none
» cover_url body string 是 none
» thumb_url body string 是 none
» avatar body string 是 none
» nickname body string 是 none
» desc body string 是 none
» url body string 是 none
» extras body string 是 none
» object_id body string 是 none
» object_nonce_id body string 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

开放平台打通#

POST 企业微信 VID 转 OpenID#

POST /open/vid_to_openid

Body 请求参数

{
  "guid": "string",
  "user_list": [],
  "appid": "",
  "corp_id": "",
  "real_appid": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body VidToOpenIdModel 否 VidToOpenIdModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 企业微信 OpenID 转 VID#

POST /open/openid_to_vid

Body 请求参数

{
  "guid": "string",
  "openid_list": [],
  "appid": "",
  "corp_id": "",
  "real_appid": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body OpenIdToVidModel 否 OpenIdToVidModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 企业微信群 ID 转 ChatID#

POST /open/roomid_to_chatid

Body 请求参数

{
  "guid": "string",
  "room_id": "",
  "corp_app_id": "",
  "corp_id": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body RoomIdToChatIdModel 否 RoomIdToChatIdModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 企业微信 ChatID 转群 ID#

POST /open/chatid_to_roomid

Body 请求参数

{
  "guid": "string",
  "chatid": "",
  "corp_app_id": "",
  "corp_id": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body ChatIdToRoomIdModel 否 ChatIdToRoomIdModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 获取开放平台信息#

POST /open/get_appinfo

Body 请求参数

{
  "guid": "5038d5bb-b1b4-3a01-958a-a96dd230c013"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

POST 获取侧边栏信息#

POST /open/get_banner_list

聊天工具栏管理，对应页面 work.weixin.qq.com/wework_admin/fr...

Body 请求参数

{
  "guid": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

POST 获取应用#

POST /open/get_attachment_apps

Body 请求参数

{
  "guid": "string",
  "attachment_type": 2
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none
» attachment_type body integer 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

云存储#

POST C2C CDN 上传#

POST /cloud/cdn_c2c_upload

Body 请求参数

{
  "guid": "",
  "file_type": 0,
  "url": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body pywemodels__cloud__C2CUploadModel 否 C2CUploadModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 下载图片、视频或文件#

POST /cloud/cdn_c2c_download

参数 file_type: 原图 =>1, 中图 =>2, 缩略图 =>3, 视频 =>4, 文件 & GIF=>5

Body 请求参数

{
  "guid": "",
  "file_type": 2,
  "file_id": "",
  "aes_key": "",
  "file_size": 0,
  "file_name": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body pywemodels__cloud__C2CDownloadModel 否 C2CDownloadModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST Big CDN 上传#

POST /cloud/cdn_big_upload

Body 请求参数

{
  "guid": "",
  "url": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body pywemodels__cloud__BigUploadModel 否 BigUploadModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST Big CDN 下载#

POST /cloud/cdn_big_download

Body 请求参数

{
  "guid": "",
  "file_id": "",
  "file_size": 0,
  "file_name": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body pywemodels__cloud__BigDownloadModel 否 BigDownloadModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 微信 CDN 下载#

POST /cloud/cdn_wx_download

Body 请求参数

{
  "guid": "",
  "url": "",
  "auth_key": "",
  "aes_key": "",
  "file_name": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body pywemodels__cloud__WxDownloadModel 否 WxDownloadModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 极速群发图片上传#

POST /cloud/add_image

Body 请求参数

{
  "guid": "",
  "url": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none
» url body string 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

POST 更新 CDN 信息#

POST /cloud/update_cdn_rule

Body 请求参数

{
  "guid": "string"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body UpdateCdnRuleModel 否 UpdateCdnRuleModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

CDN#

POST 更新 CDN 信息#

POST /cdn/update_cdn_rule

Body 请求参数

{
  "guid": "string"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body UpdateCdnRuleModel 否 UpdateCdnRuleModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST C2C CDN 上传#

POST /cdn/c2c_upload

参数 file_type: 图片 =>1, 视频 =>4, 文件 & GIF=>5

Body 请求参数

{
  "guid": "",
  "file_type": 0,
  "file_path": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body pywemodels__cdn__C2CUploadModel 否 C2CUploadModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 下载图片、视频或文件#

POST /cdn/c2c_download

参数 file_type: 原图 =>1, 中图 =>2, 缩略图 =>3, 视频 =>4, 文件 & GIF=>5

Body 请求参数

{
  "guid": "",
  "file_type": 2,
  "file_id": "",
  "aes_key": "",
  "file_size": 0,
  "save_path": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body pywemodels__cdn__C2CDownloadModel 否 C2CDownloadModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST Big CDN 上传#

POST /cdn/big_upload

Body 请求参数

{
  "guid": "",
  "file_path": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body pywemodels__cdn__BigUploadModel 否 BigUploadModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST Big CDN 下载#

POST /cdn/big_download

Body 请求参数

{
  "guid": "",
  "file_id": "",
  "file_size": 0,
  "save_path": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body pywemodels__cdn__BigDownloadModel 否 BigDownloadModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 微信 CDN 下载#

POST /cdn/wx_download

Body 请求参数

{
  "guid": "",
  "url": "",
  "auth_key": "",
  "aes_key": "",
  "save_path": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body pywemodels__cdn__WxDownloadModel 否 WxDownloadModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

标签#

POST 同步获取标签列表#

POST /label/sync_label_list

Body 请求参数

{
  "guid": "string",
  "seq": "",
  "sync_type": 2
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 Guid none
» seq body string 否 Seq none
» sync_type body integer 否 Sync Type 1 - 企业标签

详细说明#

» sync_type: 1 - 企业标签
2 - 个人标签

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 创建标签#

POST /label/create_label

Body 请求参数

{
  "guid": "string",
  "name": "",
  "label_groupid": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body CreateLabelModel 否 CreateLabelModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 为客户添加多个标签#

POST /label/contact_add_labels

Body 请求参数

{
  "guid": "string",
  "user_id": "",
  "label_infos": [
    {
      "label_id": "",
      "corp_or_vid": "",
      "label_groupid": "",
      "business_type": 0
    }
  ]
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none
» user_id body string 是 none
» label_infos body [object] 是 none
»» label_id body string 否 none
»» corp_or_vid body string 否 none
»» label_groupid body string 否 none
»» business_type body integer 否 none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 删除标签#

POST /label/delete_label

Body 请求参数

{
  "guid": "string",
  "label_id": "",
  "label_groupid": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body DeleteLabelModel 否 DeleteLabelModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 修改标签#

POST /label/modify_label

Body 请求参数

{
  "guid": "string",
  "label_id": "",
  "name": "",
  "label_groupid": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body ModifyLabelModel 否 ModifyLabelModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

聊天标签#

POST 同步聊天标签列表#

POST /session_tag/get_session_tag_list

Body 请求参数

{
  "guid": "string",
  "synckey": "0"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body GetSessionTagListModel 否 GetSessionTagListModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 创建聊天标签#

POST /session_tag/create_session_tag

Body 请求参数

{
  "guid": "string",
  "name": "",
  "global_ver": "0"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body CreateSessionTagModel 否 CreateSessionTagModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 修改聊天标签#

POST /session_tag/mod_session_tag

Body 请求参数

{
  "guid": "string",
  "tag_id": "",
  "name": "",
  "global_ver": "0"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body ModSessionTagModel 否 ModSessionTagModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 删除聊天标签#

POST /session_tag/del_session_tag

Body 请求参数

{
  "guid": "string",
  "tag_id": "",
  "global_ver": "0"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body DelSessionTagModel 否 DelSessionTagModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 同步会话所属标签列表#

POST /session_tag/get_session_in_tag_list

Body 请求参数

{
  "guid": "string",
  "synckey": "0"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body GetSessionInTagListModel 否 GetSessionInTagListModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 修改会话所属标签#

POST /session_tag/mod_session_in_tag

Body 请求参数

{
  "guid": "string",
  "conversation_id": "",
  "tag_list": [],
  "global_ver": "0"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body ModSessionInTagModel 否 ModSessionInTagModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

朋友圈#

POST 获取发布的朋友圈记录#

POST /sns/get_sns_record

Body 请求参数

{
  "guid": "string",
  "seq": "",
  "limit": 20
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body GetSnsRecordListModel 否 GetSnsRecordListModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 设置朋友圈封面#

POST /sns/set_cover

Body 请求参数

{
  "guid": "string",
  "file_id": "",
  "file_md5": "",
  "file_size": 0
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SetSnsCoverModel 否 SetSnsCoverModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 设置朋友圈签名#

POST /sns/set_sign

Body 请求参数

{
  "guid": "string",
  "sign": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SetSnsSignModel 否 SetSnsSignModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 发布朋友圈#

POST /sns/post_sns

Body 请求参数

{
  "content": "nostrud in do dolore",
  "user_list": [
    "78813022xxx98"
  ],
  "link_info": {
    "title": "百度一下",
    "content_url": "https://www.baidu.com"
  },
  "media_list": [
    {
      "file_id": "*1*F34hSNMREYF+BNgTfNtYo7Lg5/va+EoTPkyESrZSpwveUtI8Z8Zylqtm+6z4Q5mxctuYc0EZqtCw3OsQ2RXDKfMnQF1PNmNuDnUg6efswhVsyMVW7XccinYpk6PabggQVXwjuCbMTO3IQGWDwa8ls7KOvB3dAg9vU93vsACDWzkU6DCZy3MgILrRhlxacjiUbJRVapy9NpKlW/MjCFz0qRuhOtstB3Md3jHvsZm0Ww3z0ZIa3FAYepKTfN0XbbCUOA43dpsFCj46micLbizlVaSc4H+Yr597XuqL5bWylz8h6kLkj5INFia+gfqniDLYdXw2MRuXbkmcqKNx2KhNHnRmGO2/E0vXDR6E5FbJsT7t3qhuxR9HyE80G+HwlQg78uwFxTVarWyzORsbsm1J7L2fXLSM/UOBbLLKw2AkKsgDkY4H8v5DbL/3ts5bORbm/Zj1RPfuqk/ooZO/hwXAZLkAKh9VRrjVL4BjYyRuQok=",
      "file_size": 270748,
      "video_duration": 15,
      "file_type": 2
    },
    {
      "file_id": "*1*F34hSNMREYF+BNgTfNtYo7Lg5/va+EoTPkyESrZSpwveUtI8Z8Zylqtm+6z4Q5mxctuYc0EZqtCw3OsQ2RXDKfMnQF1PNmNuDnUg6efswhVsyMVW7XccinYpk6PabggQVXwjuCbMTO3IQGWDwa8ls7KOvB3dAg9vU93vsACDWzkU6DCZy3MgILrRhlxacjiUbJRVapy9NpKlW/MjCFz0qRuhOtstB3Md3jHvsZm0Ww3z0ZIa3FAYepKTfN0XbbCUOA43dpsFCj46micLbizlVaSc4H+Yr597XuqL5bWylz8h6kLkj5INFia+gfqniDLYdXw2MRuXbkmcqKNx2KhNHnRmGO2/E0vXDR6E5FbJsT7t3qhuxR9HyE80G+HwlQg78uwFxTVarWyzORsbsm1J7L2fXLSM/UOBbLLKw2AkKsgDkY4H8v5DbL/3ts5bORbm/Zj1RPfuqk/ooZO/hwXAZLkAKh9VRrjVL4BjYyRuQok=",
      "file_size": 70748,
      "file_type": 3
    }
  ],
  "finder_info": {
    "avatar": "http://wx.qlogo.cn/finderhead/Q3auHgzwzM6HSWYDSpFAYCx2KWvRguyFSpCvZwTA5C7iaP7ezkYAGVQ/0",
    "cover_url": "http://wxapp.tc.qq.com/251/20350/stodownload?encfilekey=XGocBFxVWK5dcyOOqpEU4yZ0ia4qlCRBBg1e4YghaftniaDwu7yHDhoIS57QV9m8OewZFxh5PJtjZbrmdb1XBhQHCAON3bV8K4Oa6D8afdvt5WxCF32S8dsuEGY09mHkwZz7GQZ5iaiaT05jciauBujdicB3r9bJ3SwwcuFK5lhnoKu3jNtEH0r6Mc5bVRyx01Gu7W&adaptivelytrans=0&bizid=1023&dotrans=0&hy=SZ&idx=1&m=c519536087668c32080cdda9c8c2e641&token=6xykWLEnztLEWV55LzmMttpgJ35bzDbsVGkuOic0DibTge4ylcibJa7jm3ZBSUIQYGRTsuu09EndGU&finder_expire_time=1649778256&finder_eid=export%2FUzFfAgtgekIEAQAAAAAAE18X7n6gugAAAAstQy6ubaLX4KHWvLEZgBPE2qMgO380DPn9zNPgMIAZurq07zX40HP0Ng0BAokj",
    "desc": "这医生真奇怪，听都听不懂#搞笑视频",
    "extras": "CAEQACLQKwAE9OmXBAAAAQAAAAAAoNvpOPuI2w+==",
    "feed_type": 4,
    "nickname": "夢佳baby",
    "thumb_url": "http://wxapp.tc.qq.com/251/20350/stodownload?encfilekey=XGocBFxVWK5dcyOOqpEU4yZ0ia4qlCRBBg1e4YghaftniaDwu7yHDhoIS57QV9m8OewZFxh5PJtjZbrmdb1XBhQHCAON3bV8K4Oa6D8afdvt5WxCF32S8dsuEGY09mHkwZz7GQZ5iaiaT05jciauBujdicB3r9bJ3SwwcuFK5lhnoKu3jNtEH0r6Mc5bVRyx01Gu7W&adaptivelytrans=0&bizid=1023&dotrans=0&hy=SZ&idx=1&m=c519536087668c32080cdda9c8c2e641&token=6xykWLEnztLEWV55LzmMttpgJ35bzDbsVGkuOic0DibTge4ylcibJa7jm3ZBSUIQYGRTsuu09EndGU&finder_expire_time=1649778256&finder_eid=export%2FUzFfAgtgekIEAQAAAAAAE18X7n6gugAAAAstQy6ubaLX4KHWvLEZgBPE2qMgO380DPn9zNPgMIAZurq07zX40HP0Ng0BAokj",
    "url": "https://channels.weixin.qq.com/web/pages/feed?eid=export%2FUzFfAgtgekIEAQAAAAAAE18X7n6gugAAAAstQy6ubaLX4KHWvLEZgBPE2qMgO380DPn9zNPgMIAZurq07zX40HP0Ng0BAokj"
  },
  "guid": "80"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» content body string 是 none
» user_list body [string] 是 none
» link_info body object 是 none
»» title body string 是 none
»» content_url body string 是 none
» media_list body [object] 是 none
»» file_id body string 是 none
»» file_size body integer 是 none
»» video_duration body integer 否 none
»» file_type body integer 是 none
» finder_info body object 是 none
»» avatar body string 是 none
»» cover_url body string 是 none
»» desc body string 是 none
»» extras body string 是 none
»» feed_type body integer 是 none
»» nickname body string 是 none
»» thumb_url body string 是 none
»» url body string 是 none
» guid body string 是 none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 删除朋友圈#

POST /sns/delete_sns

Body 请求参数

{
  "guid": "string",
  "sid": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none
» sid body string 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

POST 点赞#

POST /sns/sns_like

Body 请求参数

{
  "guid": "string",
  "sid": "",
  "status": true
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none
» sid body string 是 none
» status body boolean 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

POST 评论#

POST /sns/sns_comment

Body 请求参数

{
  "guid": "string",
  "sid": "",
  "ref_commentid": "",
  "comment": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none
» sid body string 是 none
» ref_commentid body string 是 none
» comment body string 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

POST 获取指定朋友圈详情#

POST /sns/get_sns_detail

Body 请求参数

{
  "guid": "string",
  "sid_list": []
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none
» sid_list body [string] 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

POST 删除评论#

POST /sns/delete_sns_comment

Body 请求参数

{
  "guid": "string",
  "sid": "",
  "comment_id": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body DeleteSnsCommentModel 否 DeleteSnsCommentModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

同步#

POST 同步联系人数据#

POST /sync/sync_multi_data

Body 请求参数

{
  "guid": "string",
  "business_id": 1,
  "seq": "",
  "limit": 10
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SyncMultiDataModel 否 SyncMultiDataModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 同步消息#

POST /sync/sync_msg

Body 请求参数

{
  "guid": "string",
  "sync_key": "",
  "limit": 100
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body SyncMsgModel 否 SyncMsgModel none

返回示例

200 Response

"string"

返回结果#

状态码 状态码含义 说明 数据模型
200 OK Successful Response string
422 Unprocessable Entity Validation Error HTTPValidationError

POST 推送同步消息#

POST /sync/push_sync_msg

Body 请求参数

{
  "guid": "string"
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

运维#

POST 备份实例#

POST /private/backup_instance

Body 请求参数

{
  "guid": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

POST 恢复备份实例#

POST /private/restore_instance

Body 请求参数

{
  "guid": "",
  "backup_data": ""
}

请求参数#

名称 位置 类型 必选 中文名 说明
body body object 否 none
» guid body string 是 none
» backup_data body string 是 none

返回示例

200 Response

{}

返回结果#

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

返回数据结构#

数据模型#

WxDownloadModel#




{
  "guid": "string",
  "url": "",
  "auth_key": "",
  "aes_key": "",
  "file_name": ""
}

WxDownloadModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
url string false none Url none
auth_key string false none Auth Key none
aes_key string false none Aes Key none
file_name string false none File Name none

VerifyLoginQRCodeModel#




{
  "guid": "string",
  "code": "string"
}

VerifyLoginQRCodeModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
code string true none Code none

SyncRoomInfoModel#




{
  "guid": "string",
  "room_id": "string",
  "version": 0
}

SyncRoomInfoModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string true none Room Id none
version integer false none Version none

SnsLikeModel#




{
  "guid": "string",
  "sid": "",
  "status": true
}

SnsLikeModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
sid string false none Sid none
status boolean false none Status none

SnsCommentModel#




{
  "guid": "string",
  "sid": "",
  "ref_commentid": "",
  "comment": ""
}

SnsCommentModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
sid string false none Sid none
ref_commentid string false none Ref Commentid none
comment string false none Comment none

SetSessionModel#




{
  "guid": "string",
  "conversation_id": "",
  "cmd": ""
}

SetSessionModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none
cmd string false none Cmd none

SetRoomTopMsgModel#




{
  "guid": "string",
  "room_id": "string",
  "message": {},
  "appinfo": ""
}

SetRoomTopMsgModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string true none Room Id none
message object false none Message none
appinfo string false none Appinfo none

SendGroupMsgModel#




{
  "guid": "string",
  "user_list": [],
  "room_list": [],
  "content": "",
  "image_msg_list": [],
  "video_msg_list": [],
  "weapp_msg_list": [],
  "link_msg_list": []
}

SendGroupMsgModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
user_list [string] false none User List none
room_list [string] false none Room List none
content string false none Content none
image_msg_list [string] false none Image Msg List none
video_msg_list [string] false none Video Msg List none
weapp_msg_list [string] false none Weapp Msg List none
link_msg_list [string] false none Link Msg List none

SendGifUrlModel#




{
  "guid": "string",
  "conversation_id": "",
  "url": "",
  "md5": "",
  "image_width": 0,
  "image_height": 0
}

SendGifUrlModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none
url string false none Url none
md5 string false none Md5 none
image_width integer false none Image Width none
image_height integer false none Image Height none

SendForwardMsgModel#




{
  "guid": "string",
  "conversation_id": "",
  "message_list": []
}

SendForwardMsgModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none
message_list [object] false none Message List none

RemoveRoomTopMsgModel#




{
  "guid": "string",
  "room_id": "string",
  "top_id": "string"
}

RemoveRoomTopMsgModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string true none Room Id none
top_id string true none Top Id none

PushLoginUrlModel#




{
  "guid": "string"
}

PushLoginUrlModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none

ModifyRoomRemarkModel#




{
  "guid": "string",
  "room_id": "string",
  "remark": "string"
}

ModifyRoomRemarkModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string true none Room Id none
remark string true none Remark none

ModifyLabelModel#




{
  "guid": "string",
  "label_id": "",
  "name": "",
  "label_groupid": ""
}

ModifyLabelModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
label_id string false none Label Id none
name string false none Name none
label_groupid string false none Label Groupid none

ModifyInRoomNicknameModel#




{
  "guid": "string",
  "room_id": "string",
  "nickname": "string"
}

ModifyInRoomNicknameModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string true none Room Id none
nickname string true none Nickname none

ModifyColleagueInfoModel#




{
  "guid": "string",
  "user_id": "string",
  "remark": "string",
  "desc": "string"
}

ModifyColleagueInfoModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
user_id string true none User Id none
remark string true none Remark none
desc string true none Desc none

ModSessionTagModel#




{
  "guid": "string",
  "tag_id": "",
  "name": "",
  "global_ver": "0"
}

ModSessionTagModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
tag_id string false none Tag Id none
name string false none Name none
global_ver string false none Global Ver none

ModSessionInTagModel#




{
  "guid": "string",
  "conversation_id": "",
  "tag_list": [],
  "global_ver": "0"
}

ModSessionInTagModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none
tag_list [string] false none Tag List none
global_ver string false none Global Ver none

GetSnsDetailModel#




{
  "guid": "string",
  "sid_list": []
}

GetSnsDetailModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
sid_list [string] false none Sid List none

GetSessionTagListModel#




{
  "guid": "string",
  "synckey": "0"
}

GetSessionTagListModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
synckey string false none Synckey none

GetSessionListModel#




{
  "guid": "string",
  "begin_seq": "0",
  "limit": 100
}

GetSessionListModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
begin_seq string false none Begin Seq none
limit integer false none Limit none

GetSessionInTagListModel#




{
  "guid": "string",
  "synckey": "0"
}

GetSessionInTagListModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
synckey string false none Synckey none

GetRoomTopMsgModel#




{
  "guid": "string",
  "room_id": "string"
}

GetRoomTopMsgModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string true none Room Id none

GetAttachmentItemModel#




{
  "guid": "string",
  "attachment_type": 2
}

GetAttachmentItemModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
attachment_type integer false none Attachment Type none

DeleteSnsModel#




{
  "guid": "string",
  "sid": ""
}

DeleteSnsModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
sid string false none Sid none

DeleteSnsCommentModel#




{
  "guid": "string",
  "sid": "",
  "comment_id": ""
}

DeleteSnsCommentModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
sid string false none Sid none
comment_id string false none Comment Id none

DelSessionTagModel#




{
  "guid": "string",
  "tag_id": "",
  "global_ver": "0"
}

DelSessionTagModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
tag_id string false none Tag Id none
global_ver string false none Global Ver none

CreateSessionTagModel#




{
  "guid": "string",
  "name": "",
  "global_ver": "0"
}

CreateSessionTagModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
name string false none Name none
global_ver string false none Global Ver none

ClientProxyModel#




{
  "guid": "string",
  "proxy": "string"
}

ClientProxyModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
proxy string true none Proxy none

ClientModel#




{
  "guid": "string"
}

ClientModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none

C2CUploadModel#




{
  "guid": "string",
  "file_type": 0,
  "url": ""
}

C2CUploadModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
file_type integer false none File Type none
url string false none Url none

C2CDownloadModel#




{
  "guid": "string",
  "file_type": 2,
  "file_id": "",
  "aes_key": "",
  "file_size": 0,
  "file_name": "",
  "pic_format": 1
}

C2CDownloadModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
file_type integer false none File Type none
file_id string false none File Id none
aes_key string false none Aes Key none
file_size integer false none File Size none
file_name string false none File Name none
pic_format integer false none Pic Format none

BigUploadModel#




{
  "guid": "string",
  "url": ""
}

BigUploadModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
url string false none Url none

BigDownloadModel#




{
  "guid": "string",
  "file_id": "",
  "file_size": 0,
  "file_name": ""
}

BigDownloadModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
file_id string false none File Id none
file_size integer false none File Size none
file_name string false none File Name none

AutoLoginModel#




{
  "guid": "string"
}

AutoLoginModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none

AddImageModel#




{
  "guid": "string",
  "url": ""
}

AddImageModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
url string false none Url none

SetRoomWelcomeModel#




{
  "guid": "string",
  "room_id": "",
  "msg_type": 0,
  "msg_index": ""
}

SetRoomWelcomeModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string false none Room Id none
msg_type integer false none Msg Type none
msg_index string false none Msg Index none

LogoutModel#




{
  "guid": "string"
}

LogoutModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none

BatchGetCorpInfoModel#




{
  "guid": "string",
  "corp_list": []
}

BatchGetCorpInfoModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
corp_list [string] false none Corp List none

pywemodels__global___NotifyUrlModel#




{
  "notify_url": ""
}

NotifyUrlModel

属性#

名称 类型 必选 约束 中文名 说明
notify_url string false none Notify Url none

pywemodels__cloud__WxDownloadModel#




{
  "guid": "",
  "url": "",
  "auth_key": "",
  "aes_key": "",
  "file_name": ""
}

WxDownloadModel

属性#

名称 类型 必选 约束 中文名 说明
guid string false none Guid none
url string false none Url none
auth_key string false none Auth Key none
aes_key string false none Aes Key none
file_name string false none File Name none

pywemodels__cloud__C2CUploadModel#




{
  "guid": "",
  "file_type": 0,
  "url": ""
}

C2CUploadModel

属性#

名称 类型 必选 约束 中文名 说明
guid string false none Guid none
file_type integer false none File Type 2 - 图片 / 动图 4 - 视频 5 - 文件 / 语音
url string false none Url none

pywemodels__cloud__C2CDownloadModel#




{
  "guid": "",
  "file_type": 2,
  "file_id": "",
  "aes_key": "",
  "file_size": 0,
  "file_name": ""
}

C2CDownloadModel

属性#

名称 类型 必选 约束 中文名 说明
guid string false none Guid none
file_type integer false none File Type 1 - 原图 2 - 图片 4 - 视频 5 - 视频 / 语音

1 返回 - 5103017 时再用 2
file_id string false none File Id none
aes_key string false none Aes Key none
file_size integer false none File Size none
file_name string false none File Name none

pywemodels__cloud__BigUploadModel#




{
  "guid": "",
  "url": ""
}

BigUploadModel

属性#

名称 类型 必选 约束 中文名 说明
guid string false none Guid none
url string false none Url none

pywemodels__cloud__BigDownloadModel#




{
  "guid": "",
  "file_id": "",
  "file_size": 0,
  "file_name": ""
}

BigDownloadModel

属性#

名称 类型 必选 约束 中文名 说明
guid string false none Guid none
file_id string false none File Id none
file_size integer false none File Size none
file_name string false none File Name none

pywemodels__client__NotifyUrlModel#




{
  "guid": "string",
  "notify_url": "string"
}

NotifyUrlModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
notify_url string true none Notify Url none

pywemodels__cdn__WxDownloadModel#




{
  "guid": "",
  "url": "",
  "auth_key": "",
  "aes_key": "",
  "save_path": ""
}

WxDownloadModel

属性#

名称 类型 必选 约束 中文名 说明
guid string false none Guid none
url string false none Url none
auth_key string false none Auth Key none
aes_key string false none Aes Key none
save_path string false none Save Path none

pywemodels__cdn__C2CUploadModel#




{
  "guid": "",
  "file_type": 0,
  "file_path": ""
}

C2CUploadModel

属性#

名称 类型 必选 约束 中文名 说明
guid string false none Guid none
file_type integer false none File Type none
file_path string false none File Path none

pywemodels__cdn__C2CDownloadModel#




{
  "guid": "",
  "file_type": 2,
  "file_id": "",
  "aes_key": "",
  "file_size": 0,
  "save_path": ""
}

C2CDownloadModel

属性#

名称 类型 必选 约束 中文名 说明
guid string false none Guid none
file_type integer false none File Type none
file_id string false none File Id none
aes_key string false none Aes Key none
file_size integer false none File Size none
save_path string false none Save Path none

pywemodels__cdn__BigUploadModel#




{
  "guid": "",
  "file_path": ""
}

BigUploadModel

属性#

名称 类型 必选 约束 中文名 说明
guid string false none Guid none
file_path string false none File Path none

pywemodels__cdn__BigDownloadModel#




{
  "guid": "",
  "file_id": "",
  "file_size": 0,
  "save_path": ""
}

BigDownloadModel

属性#

名称 类型 必选 约束 中文名 说明
guid string false none Guid none
file_id string false none File Id none
file_size integer false none File Size none
save_path string false none Save Path none

VidToOpenIdModel#




{
  "guid": "string",
  "user_list": [],
  "appid": "",
  "corp_id": "",
  "real_appid": ""
}

VidToOpenIdModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
user_list [string] false none User List none
appid string false none Appid none
corp_id string false none Corp Id none
real_appid string false none Real Appid none

ValidationError#




{
  "loc": [
    "string"
  ],
  "msg": "string",
  "type": "string"
}

ValidationError

属性#

名称 类型 必选 约束 中文名 说明
loc [anyOf] true none Location none

anyOf

名称 类型 必选 约束 中文名 说明
» anonymous string false none none

or

名称 类型 必选 约束 中文名 说明
» anonymous integer false none none

continued

名称 类型 必选 约束 中文名 说明
msg string true none Message none
type string true none Error Type none

UpdateContactModel#




{
  "guid": "string",
  "user_id": "",
  "desc": "",
  "remark": "",
  "remark_url": "",
  "company_remark": "",
  "phone_list": [],
  "label_info_list": []
}

UpdateContactModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
user_id string false none User Id none
desc string false none Desc none
remark string false none Remark none
remark_url string false none Remark Url none
company_remark string false none Company Remark none
phone_list [string] false none Phone List none
label_info_list [object] false none Label Info List none

UpdateCdnRuleModel#




{
  "guid": "string"
}

UpdateCdnRuleModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none

SyncMultiDataModel#




{
  "guid": "string",
  "business_id": 1,
  "seq": "",
  "limit": 10
}

SyncMultiDataModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
business_id integer false none Business Id none
seq string false none Seq none
limit integer false none Limit none

SyncLabelListModel#




{
  "guid": "string",
  "seq": "",
  "sync_type": 2
}

SyncLabelListModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
seq string false none Seq none
sync_type integer false none Sync Type none

SyncMsgModel#




{
  "guid": "string",
  "sync_key": "",
  "limit": 100
}

SyncMsgModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
sync_key string false none Sync Key none
limit integer false none Limit none

SyncContactModel#




{
  "guid": "string",
  "seq": "",
  "limit": 10
}

SyncContactModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
seq string false none Seq none
limit integer false none Limit none

SyncArchModel#




{
  "guid": "string",
  "cli_version": "",
  "limit": 100
}

SyncArchModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
cli_version string false none Cli Version none
limit integer false none Limit none

SyncApplyContactModel#




{
  "guid": "string",
  "seq": "",
  "limit": 10
}

SyncApplyContactModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
seq string false none Seq none
limit integer false none Limit none

StopClientModel#




{
  "guid": "string"
}

StopClientModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none

SetSnsSignModel#




{
  "guid": "string",
  "sign": ""
}

SetSnsSignModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
sign string false none Sign none

SetSnsCoverModel#




{
  "guid": "string",
  "file_id": "",
  "file_md5": "",
  "file_size": 0
}

SetSnsCoverModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
file_id string false none File Id none
file_md5 string false none File Md5 none
file_size integer false none File Size none

SetAntiSpamRuleModel#




{
  "guid": "string",
  "room_id": "",
  "rule_list": []
}

SetAntiSpamRuleModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string false none Room Id none
rule_list [anyOf] false none Rule List none

anyOf

名称 类型 必选 约束 中文名 说明
» anonymous string false none none

or

名称 类型 必选 约束 中文名 说明
» anonymous integer false none none

SendWeAppModel#




{
  "guid": "string",
  "conversation_id": "",
  "username": "",
  "appid": "",
  "appname": "",
  "appicon": "",
  "title": "",
  "page_path": "",
  "file_id": "",
  "size": 0,
  "aes_key": "",
  "md5": ""
}

SendWeAppModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none
username string false none Username none
appid string false none Appid none
appname string false none Appname none
appicon string false none Appicon none
title string false none Title none
page_path string false none Page Path none
file_id string false none File Id none
size integer false none Size none
aes_key string false none Aes Key none
md5 string false none Md5 none

SendVoiceModel#




{
  "guid": "string",
  "conversation_id": "",
  "file_id": "",
  "size": 0,
  "voice_time": 0,
  "aes_key": "",
  "md5": ""
}

SendVoiceModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none
file_id string false none File Id none
size integer false none Size none
voice_time integer false none Voice Time none
aes_key string false none Aes Key none
md5 string false none Md5 none

SendRoomAtModel#




{
  "guid": "string",
  "conversation_id": "",
  "content": "",
  "at_list": []
}

SendRoomAtModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none
content string false none Content none
at_list [anyOf] false none At List none

anyOf

名称 类型 必选 约束 中文名 说明
» anonymous string false none none

or

名称 类型 必选 约束 中文名 说明
» anonymous integer false none none

SendVideoModel#




{
  "guid": "string",
  "conversation_id": "",
  "file_id": "",
  "size": 0,
  "file_name": "",
  "aes_key": "",
  "md5": "",
  "video_duration": 0,
  "video_width": 0,
  "video_height": 0
}

SendVideoModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none
file_id string false none File Id none
size integer false none Size none
file_name string false none File Name none
aes_key string false none Aes Key none
md5 string false none Md5 none
video_duration integer false none Video Duration none
video_width integer false none Video Width none
video_height integer false none Video Height none

SendTextModel#




{
  "guid": "string",
  "conversation_id": "",
  "content": ""
}

SendTextModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none
content string false none Content none

SendPersonalCardModel#




{
  "guid": "string",
  "conversation_id": "",
  "user_id": ""
}

SendPersonalCardModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none
user_id string false none User Id none

SendLocationModel#




{
  "guid": "string",
  "conversation_id": "",
  "longitude": 0,
  "latitude": 0,
  "address": "",
  "title": "",
  "zoom": 0
}

SendLocationModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none
longitude number false none Longitude none
latitude number false none Latitude none
address string false none Address none
title string false none Title none
zoom number false none Zoom none

SendLinkModel#




{
  "guid": "string",
  "conversation_id": "",
  "title": "",
  "description": "",
  "url": "",
  "image_url": ""
}

SendLinkModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none
title string false none Title none
description string false none Description none
url string false none Url none
image_url string false none Image Url none

SendImageModel#




{
  "guid": "string",
  "conversation_id": "",
  "file_id": "",
  "size": 0,
  "image_width": 0,
  "image_height": 0,
  "aes_key": "",
  "md5": ""
}

SendImageModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none
file_id string false none File Id none
size integer false none Size none
image_width integer false none Image Width none
image_height integer false none Image Height none
aes_key string false none Aes Key none
md5 string false none Md5 none

SendGifModel#




{
  "guid": "string",
  "conversation_id": "",
  "file_id": "",
  "size": 0,
  "aes_key": "",
  "md5": "",
  "url": "",
  "image_width": 0,
  "image_height": 0
}

SendGifModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none
file_id string false none File Id none
size integer false none Size none
aes_key string false none Aes Key none
md5 string false none Md5 none
url string false none Url none
image_width integer false none Image Width none
image_height integer false none Image Height none

SendFileModel#




{
  "guid": "string",
  "conversation_id": "",
  "file_id": "",
  "size": 0,
  "file_name": "",
  "aes_key": "",
  "md5": ""
}

SendFileModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none
file_id string false none File Id none
size integer false none Size none
file_name string false none File Name none
aes_key string false none Aes Key none
md5 string false none Md5 none

SendFeedVideoModel#




{
  "guid": "string",
  "conversation_id": "",
  "feed_type": 0,
  "cover_url": "",
  "thumb_url": "",
  "avatar": "",
  "nickname": "",
  "desc": "",
  "url": "",
  "extras": ""
}

SendFeedVideoModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none
feed_type integer false none Feed Type none
cover_url string false none Cover Url none
thumb_url string false none Thumb Url none
avatar string false none Avatar none
nickname string false none Nickname none
desc string false none Desc none
url string false none Url none
extras string false none Extras none

SearchContactModel#




{
  "guid": "string",
  "keyword": ""
}

SearchContactModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
keyword string false none Keyword none

RoomRemoveAdminModel#




{
  "guid": "string",
  "room_id": "",
  "user_list": []
}

RoomRemoveAdminModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string false none Room Id none
user_list [string] false none User List none

RoomIdToChatIdModel#




{
  "guid": "string",
  "room_id": "",
  "corp_app_id": "",
  "corp_id": ""
}

RoomIdToChatIdModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string false none Room Id none
corp_app_id string false none Corp App Id none
corp_id string false none Corp Id none

RoomAddAdminModel#




{
  "guid": "string",
  "room_id": "",
  "user_list": []
}

RoomAddAdminModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string false none Room Id none
user_list [string] false none User List none

RevokeMsgModel#




{
  "guid": "string",
  "conversation_id": "",
  "msgid": ""
}

RevokeMsgModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none
msgid string false none Msgid none

RestoreClientModel#




{
  "guid": "string",
  "proxy": "",
  "bridge": "",
  "sync_history_msg": true,
  "force_online": false
}

RestoreClientModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
proxy string false none Proxy none
bridge string false none Bridge none
sync_history_msg boolean false none Sync History Msg none
force_online boolean false none Force Online none

ReportUnReadModel#




{
  "guid": "string",
  "conversation_id": ""
}

ReportUnReadModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none

RemoveRoomMemberModel#




{
  "guid": "string",
  "room_id": "",
  "user_list": []
}

RemoveRoomMemberModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string false none Room Id none
user_list [string] false none User List none

QuitRoomModel#




{
  "guid": "string",
  "room_id": ""
}

QuitRoomModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string false none Room Id none

QueryVoiceToTextModel#




{
  "guid": "string",
  "conversation_id": "",
  "msgid": "",
  "voiceid": "",
  "seqid": ""
}

QueryVoiceToTextModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none
msgid string false none Msgid none
voiceid string false none Voiceid none
seqid string false none Seqid none

PostSnsModel#




{
  "guid": "string",
  "content": "",
  "user_list": [],
  "link_info": {},
  "media_list": [],
  "finder_info": {},
  "poi_info": {}
}

PostSnsModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
content string false none Content none
user_list [string] false none User List none
link_info object false none Link Info none
media_list [object] false none Media List none
finder_info object false none Finder Info none
poi_info object false none Poi Info none

OprRoomWhiteListModel#




{
  "guid": "string",
  "user_list": [
    "string"
  ],
  "status": 1
}

OprRoomWhiteListModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
user_list [string] true none User List none
status integer false none Status none

OprRoomBlackListModel#




{
  "guid": "string",
  "user_list": [
    "string"
  ],
  "status": 1
}

OprRoomBlackListModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
user_list [string] true none User List none
status integer false none Status none

OpenIdToVidModel#




{
  "guid": "string",
  "openid_list": [],
  "appid": "",
  "corp_id": "",
  "real_appid": ""
}

OpenIdToVidModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
openid_list [string] false none Openid List none
appid string false none Appid none
corp_id string false none Corp Id none
real_appid string false none Real Appid none

ModifyRoomNoticeModel#




{
  "guid": "string",
  "room_id": "",
  "notice": ""
}

ModifyRoomNoticeModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string false none Room Id none
notice string false none Notice none

ModifyRoomNameModel#




{
  "guid": "string",
  "room_id": "",
  "room_name": ""
}

ModifyRoomNameModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string false none Room Id none
room_name string false none Room Name none

ModifyRoomNameGuardModel#




{
  "guid": "string",
  "room_id": "",
  "status": 0
}

ModifyRoomNameGuardModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string false none Room Id none
status integer false none Status none

ModifyRoomInviteStatusModel#




{
  "guid": "string",
  "room_id": "",
  "status": 0
}

ModifyRoomInviteStatusModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string false none Room Id none
status integer false none Status none

ManualLoginModel#




{
  "guid": "string"
}

ManualLoginModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none

InviteRoomMemberModel#




{
  "guid": "string",
  "room_id": "",
  "user_list": []
}

InviteRoomMemberModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string false none Room Id none
user_list [string] false none User List none

HTTPValidationError#




{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

HTTPValidationError

属性#

名称 类型 必选 约束 中文名 说明
detail [ValidationError] false none Detail none

GetSnsRecordListModel#




{
  "guid": "string",
  "seq": "",
  "limit": 20
}

GetSnsRecordListModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
seq string false none Seq none
limit integer false none Limit none

GetRoomQRCodeModel#




{
  "guid": "string",
  "room_id": "",
  "get_type": 0
}

GetRoomQRCodeModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string false none Room Id none
get_type integer false none Get Type none

GetRoomWelcomeListModel#




{
  "guid": "string",
  "offset": "",
  "limit": 10,
  "welcome_type": 10
}

GetRoomWelcomeListModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
offset string false none Offset none
limit integer false none Limit none
welcome_type integer false none Welcome Type none

GetRoomListModel#




{
  "guid": "string",
  "start_index": 0,
  "limit": 10
}

GetRoomListModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
start_index integer false none Start Index none
limit integer false none Limit none

GetProfileModel#




{
  "guid": "string"
}

GetProfileModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none

GetLoginQRCodeModel#




{
  "guid": "string",
  "verify_login": false
}

GetLoginQRCodeModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
verify_login boolean false none Verify Login none

GetCorpInfoModel#




{
  "guid": "string"
}

GetCorpInfoModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none

GetBlackListModel#




{
  "guid": "string",
  "page_buff": "",
  "limit": 2000
}

GetBlackListModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
page_buff string false none Page Buff none
limit integer false none Limit none

GetArchNodeDataModel#




{
  "guid": "string",
  "node_list": []
}

GetArchNodeDataModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
node_list [object] false none Node List none

GetAntiSpamListModel#




{
  "guid": "string"
}

GetAntiSpamListModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none

DismissRoomModel#




{
  "guid": "string",
  "room_id": ""
}

DismissRoomModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string false none Room Id none

DeleteLabelModel#




{
  "guid": "string",
  "label_id": "",
  "label_groupid": ""
}

DeleteLabelModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
label_id string false none Label Id none
label_groupid string false none Label Groupid none

DeleteContactModel#




{
  "guid": "string",
  "user_id": "0",
  "corp_id": "0"
}

DeleteContactModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
user_id string false none User Id none
corp_id string false none Corp Id none

CreateRoomWelcomeModel#




{
  "guid": "string",
  "content": ""
}

CreateRoomWelcomeModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
content string false none Content none

CreateOuterRoomModel#




{
  "guid": "string",
  "user_list": []
}

CreateOuterRoomModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
user_list [string] false none User List none

CreateLabelModel#




{
  "guid": "string",
  "name": "",
  "label_groupid": ""
}

CreateLabelModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
name string false none Name none
label_groupid string false none Label Groupid none

CreateInnerRoomModel#




{
  "guid": "string",
  "user_list": []
}

CreateInnerRoomModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
user_list [string] false none User List none

CreateEmptyOuterRoomModel#




{
  "guid": "string"
}

CreateEmptyOuterRoomModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none

CreateClientModel#




{
  "client_type": 244,
  "proxy": "",
  "bridge": ""
}

CreateClientModel

属性#

名称 类型 必选 约束 中文名 说明
client_type integer false none Client Type none
proxy string false none Proxy none
bridge string false none Bridge none

ConfirmMsgModel#




{
  "guid": "string",
  "message_type": 0,
  "sender": "",
  "receiver": "",
  "roomid": "",
  "msgid": ""
}

ConfirmMsgModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
message_type integer false none Message Type none
sender string false none Sender none
receiver string false none Receiver none
roomid string false none Roomid none
msgid string false none Msgid none

ClientBridgeModel#




{
  "guid": "string",
  "bridge": "string"
}

ClientBridgeModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
bridge string true none Bridge none

CheckLoginQRCodeModel#




{
  "guid": "string"
}

CheckLoginQRCodeModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none

ChatIdToRoomIdModel#




{
  "guid": "string",
  "chatid": "",
  "corp_app_id": "",
  "corp_id": ""
}

ChatIdToRoomIdModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
chatid string false none Chatid none
corp_app_id string false none Corp App Id none
corp_id string false none Corp Id none

ChangeRoomMasterModel#




{
  "guid": "string",
  "room_id": "",
  "user_id": ""
}

ChangeRoomMasterModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string false none Room Id none
user_id string false none User Id none

BatchGetUserInfoModel#




{
  "guid": "string",
  "user_list": []
}

BatchGetUserInfoModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
user_list [string] false none User List none

BatchInsertContactLabelModel#




{
  "guid": "string",
  "user_list": [],
  "label_id": "",
  "corp_or_vid": "",
  "label_groupid": "",
  "business_type": 0
}

BatchInsertContactLabelModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
user_list [string] false none User List none
label_id string false none Label Id none
corp_or_vid string false none Corp Or Vid none
label_groupid string false none Label Groupid none
business_type integer false none Business Type none

BatchGetRoomMemberDetailModel#




{
  "guid": "string",
  "room_id": "",
  "user_list": []
}

BatchGetRoomMemberDetailModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string false none Room Id none
user_list [string] false none User List none

BatchGetRoomDetailModel#




{
  "guid": "string",
  "room_list": []
}

BatchGetRoomDetailModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_list [string] false none Room List none

ArchNodeModel#




{
  "type": 0,
  "vid": "",
  "partyid": ""
}

ArchNodeModel

属性#

名称 类型 必选 约束 中文名 说明
type integer false none Type none
vid string false none Vid none
partyid string false none Partyid none

ApplyVoiceToTextModel#




{
  "guid": "string",
  "conversation_id": "",
  "msgid": ""
}

ApplyVoiceToTextModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
conversation_id string false none Conversation Id none
msgid string false none Msgid none

AgreeContactModel#




{
  "guid": "string",
  "user_id": "0",
  "corp_id": "0"
}

AgreeContactModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
user_id string false none User Id none
corp_id string false none Corp Id none

AddSearchWxWorkContactModel#




{
  "guid": "string",
  "user_id": "0",
  "corp_id": "0",
  "verify": "",
  "ticket": ""
}

AddSearchWxWorkContactModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
user_id string false none User Id none
corp_id string false none Corp Id none
verify string false none Verify none
ticket string false none Ticket none

AddRoomContactModel#




{
  "guid": "string",
  "room_id": "",
  "user_id": "",
  "corp_id": "",
  "verify": ""
}

AddRoomContactModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
room_id string false none Room Id none
user_id string false none User Id none
corp_id string false none Corp Id none
verify string false none Verify none

AddCardContactModel#




{
  "guid": "string",
  "user_id": "0",
  "corp_id": "0",
  "room_id": "0",
  "from_user_id": "0",
  "verify": ""
}

AddCardContactModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
user_id string false none User Id none
corp_id string false none Corp Id none
room_id string false none Room Id none
from_user_id string false none From User Id none
verify string false none Verify none

AddDeletedContactModel#




{
  "guid": "string",
  "user_id": "0",
  "corp_id": "0",
  "verify": ""
}

AddDeletedContactModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
user_id string false none User Id none
corp_id string false none Corp Id none
verify string false none Verify none

AddSearchWxContactModel#




{
  "guid": "string",
  "user_id": "0",
  "openid": "",
  "wx_ticket": "",
  "verify": ""
}

AddSearchWxContactModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
user_id string false none User Id none
openid string false none Openid none
wx_ticket string false none Wx Ticket none
verify string false none Verify none

AcceptInviteUrlModel#




{
  "guid": "string",
  "invite_url": ""
}

AcceptInviteUrlModel

属性#

名称 类型 必选 约束 中文名 说明
guid string true none Guid none
invite_url string false none Invite Url none
本作品采用《CC 协议》，转载必须注明作者和本文链接
❤️ 微信生态自动智能化方案加微信：hansonskr ❤️ 备注：vbot
Hanson
VIP 752 声望
Keep Learning, Keep Running
《L04 微信小程序从零到发布》
《L04 微信小程序从零到发布》
从小程序个人账户申请开始，带你一步步进行开发一个微信小程序，直到提交微信控制台上线发布。
《L01 基础入门》
《L01 基础入门》
我们将带你从零开发一个项目并部署到线上，本课程教授 Web 开发中专业、实用的技能，如 Git 工作流、Laravel Mix 前端工作流等。
讨论数量: 0
排序：
时间 投票
(=￣ω￣=)··· 暂无内容！

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容，与人为善，比聪明更重要！
支持 MD 帮助
Hanson
未填写
文章
32
粉丝
416
喜欢
1461
收藏
469
排名：9
访问：37.3 万
私信
所有博文
文章归档
1 篇 2024 年 3 月 2 篇 2022 年 9 月 1 篇 2021 年 12 月 1 篇 2021 年 2 月 1 篇 2020 年 3 月 4 篇 2020 年 2 月 2 篇 2019 年 11 月 1 篇 2019 年 10 月 1 篇 2018 年 9 月 1 篇 2018 年 8 月 3 篇 2018 年 7 月 2 篇 2018 年 4 月 1 篇 2017 年 9 月 1 篇 2017 年 6 月 4 篇 2017 年 4 月 1 篇 2017 年 3 月 3 篇 2017 年 2 月 2 篇 2017 年 1 月
最新文章 最受欢迎
1年前 企微 2年前 基于 xbot 实现微信消息类型监听并转发 2年前 基于 xbot 实现微信关键词自动回复 3年前 Golang 源码学习（一） —— os/file 文件操作 4年前 分享个 golang 开源小项目
279 干货！手把手教你写 SDK ！ 114 SDK 开发高级版！揭开 Foundation-SDK 的神秘面纱 110 Laravel-sso 给你的系统增加单点登录 100 微信机器人 Vbot 2.0 89 利用 [微信公众号通知] 给你的网站加上异常提醒吧
博客标签
展开
社区赞助商
成为赞助商

关于 LearnKu

LearnKu 是终身编程者的修道场
做最专业、严肃的技术论坛
LearnKu 诞生的故事

资源推荐

  • 《社区使用指南》
  • 《文档撰写指南》
  • 《LearnKu 社区规范》
  • 《提问的智慧》

    • 服务提供商

    其他信息

  • 成为版主
  • 所有测验
  • 联系站长（反馈建议）

    • 粤ICP备18099781号-6 | 粤公网安备 44030502004330号 | 违法和不良信息举报

    由 Summer 设计和编码 ❤

    请登录

    内容举报
    匿名举报，为防止滥用，仅管理员可见举报者。

    我要举报该，理由是：

    取消