1. 文档
Golem API文档
  • 文档
    • FAQ
    • 重定向到 API 文档
      GET
    • 获取 Swagger SwaggerJSON
      GET
    • 获取 Swagger SwaggerYAML
      GET
  • 登录
    • 开始登录
      GET
    • 账号密码登录
      POST
    • 首次登录初始化
      GET
    • 唤醒登录
      GET
    • 退出登录
      GET
    • 获取登录状态
      GET
  • 测试
    • html滑块
      GET
  • 联系人
    • 获取联系人列表
      GET
    • 删除联系人
      DELETE
    • 从黑名单移除
      DELETE
    • 添加到黑名单
      POST
    • 获取联系人详细信息
      POST
    • *发送好友申请
      POST
    • 通过好友验证
      POST
    • *附近的人
      POST
    • 设置联系人备注
      PUT
    • 搜索联系人
      POST
    • *上传通讯录匹配好友
      POST
  • 群聊
    • 创建群聊
      POST
    • 移除群管理员
      DELETE
    • 设置群管理员
      POST
    • 设置群公告
      PUT
    • 保存到通讯录
      PUT
    • 面对面建群
      POST
    • 获取群信息
      GET
    • 邀请群成员
      POST
    • 同意入群邀请
      POST
    • 扫码进群
      POST
    • 删除群成员
      DELETE
    • 获取群成员详情
      GET
    • 添加群成员
      POST
    • 设置群名称
      PUT
    • 获取群二维码
      GET
    • 退出群聊
      DELETE
    • 设置群备注
      PUT
    • 转让群主
      POST
  • 消息
    • 发送应用消息
    • 发送名片消息
    • 下载文件附件
    • 下载消息图片
    • 下载视频
    • 下载语音
    • 发送表情消息
    • 转发消息
    • 转发文件
    • 发送图片消息
    • 发送链接消息
    • 发送位置消息
    • 撤回消息
    • 开始输入状态
    • 停止输入状态
    • 同步消息
    • 发送文本消息
    • 发送视频消息
    • 发送语音消息
  • CDN
    • CDN 上传聊天图片
    • CDN 上传聊天视频
    • CDN 上传朋友圈图片
    • CDN 上传朋友圈视频
    • CDN 下载高清图片
    • CDN 下载朋友圈视频
    • CDN 下载聊天视频
    • CDN 下载视频封面
  • 标签
    • 修改联系人标签
    • 获取标签列表
    • 添加标签
    • 删除标签
    • 更新标签名称
  • 收藏
    • 获取收藏信息
    • 删除收藏项
    • 获取收藏项详情
    • 同步收藏列表
  • 小程序
    • 设置预设头像
    • 获取随机头像
    • 上传自定义头像图片
    • 调用小程序云函数
    • 小程序 JS 登录
    • 小程序扫码授权登录
    • 解绑手机号
    • 获取已绑定手机号列表
    • 绑定手机号
    • 校验手机验证码
    • 发送手机验证码
    • SDK OAuth 确认授权
    • 第三方 APP OAuth 授权
    • 获取用户 OpenID
    • 操作小程序数据(WebAPI)
    • 获取小程序使用记录
    • 添加小程序使用记录
    • 获取小程序会话二维码
    • 获取小程序运行时会话
  • 朋友圈
    • 发布朋友圈
    • 删除朋友圈
    • 获取单条朋友圈详情
    • 删除评论
    • 评论朋友圈
    • 取消点赞
    • 点赞朋友圈
    • 设置朋友圈隐私
    • 同步朋友圈数据
    • 获取朋友圈时间线
    • 上传朋友圈媒体
    • 获取用户朋友圈主页
  • 公众号
    • 取关公众号
    • 关注公众号
    • 获取公众号 A8Key
    • 点赞公众号文章
    • 阅读公众号文章
    • JSAPI 预验证
    • OAuth 授权
  • 支付
    • 支付-转账
      • 确认转账收款
      • 确认微信转账
      • 创建微信转账
    • 支付-红包
      • 创建微信红包
      • 查询红包领取详情
      • 抢红包(接收+打开一步完成)
      • 查询红包领取列表
      • 打开红包(第二步)
      • 接收红包(第一步)
    • 获取绑定银行卡及余额信息
    • 生成支付收款二维码(F2F)
  • 用户
    • 设置微信号
    • 上传头像
    • 获取证书信息
    • 获取绑定硬件设备列表
    • 绑定邮箱
    • 发送验证邮件
    • 绑定手机号
    • 发送手机验证码
    • 上报运动步数
    • 设置密码
    • 验证密码
    • 设置隐私选项
    • 获取个人信息
    • 更新个人信息
    • 获取个人二维码
    • 删除安全设备
    • 获取安全设备列表
  • 管理
    • 获取推送地址
    • 设置推送地址
    • 获取存储加密状态
    • 设置存储加密状态
  • 健康检查
    GET
  • 自动滑块
    POST
  • 数据模型
    • basepb.BaseRequest
    • basepb.BaseResponse
    • basepb.Buffer
    • basepb.BuiltinIPList
    • basepb.BuiltinIPList_Info
    • basepb.Gender
    • basepb.Hosts
    • basepb.Hosts_Info
    • basepb.NetworkControl
    • basepb.OperateResponse
    • basepb.OperateResponse_Result
    • chatroom.ConsentJoinResult
    • chatroom.ScanJoinResult
    • contactpb.AddChatroomMemberResponse
    • contactpb.ChatroomAdminResponse
    • contactpb.CreateChatroomResponse
    • contactpb.CustomizedInfo
    • contactpb.DeleteChatroomMemberResponse
    • contactpb.FacingCreateChatroomResponse
    • contactpb.FacingCreateChatroomResponse_FacingMember
    • contactpb.GetChatroomInfoDetailResponse
    • contactpb.GetChatroomInfoDetailResponse_Tools
    • contactpb.GetChatroomInfoDetailResponse_Tools_Todo
    • contactpb.GetContactResponse
    • contactpb.GetContactResponse_VerifyUserValidTicket
    • contactpb.GetQRCodeResponse
    • contactpb.LbsResponse
    • contactpb.LbsResponse_LbsInfo
    • contactpb.LbsResponse_LbsInfo_CustomizedInfo
    • contactpb.LbsResponse_LbsInfo_SnsUserInfo
    • contactpb.ListMembersResponse
    • contactpb.ListMembersResponse_Result
    • contactpb.ListMembersResponse_Result_MemberInfo
    • contactpb.Member
    • contactpb.OpenIMContact
    • contactpb.OpenIMContact_CustomInfo
    • contactpb.SearchContactResponse
    • contactpb.SearchContactResponse_SearchContactItem
    • contactpb.SetChatroomAnnouncementResponse
    • contactpb.SnsUserInfo
    • contactpb.UploadMContactResponse
    • contactpb.VerifyUserResponse
    • dto.AddLabelRequest
    • dto.BindEmailRequest
    • dto.BindMobileRequest
    • dto.ChatroomMembersRequest
    • dto.CollectMoneyParam
    • dto.CommentParam
    • dto.ConfirmPreTransferParam
    • dto.ConsentJoinRequest
    • dto.CreateChatroomRequest
    • dto.CreateHongBaoParam
    • dto.CreatePreTransferParam
    • dto.DelSafeDeviceRequest
    • dto.DownloadFileParam
    • dto.DownloadImageParam
    • dto.DownloadVideoParam
    • dto.DownloadVoiceParam
    • dto.FacingCreateRequest
    • dto.ForwardParam
    • dto.GrabHongBaoParam
    • dto.LbsFindRequest
    • dto.MiniappAddAvatarRequest
    • dto.MiniappAddMobileRequest
    • dto.MiniappAddRecordRequest
    • dto.MiniappCheckVerifyCodeRequest
    • dto.MiniappCloudCallFunctionRequest
    • dto.MiniappDelMobileRequest
    • dto.MiniappGetRuntimeSessionRequest
    • dto.MiniappGetSessionQRCodeRequest
    • dto.MiniappGetUserOpenIDRequest
    • dto.MiniappJSLoginRequest
    • dto.MiniappOperateWxDataRequest
    • dto.MiniappQrcodeAuthRequest
    • dto.MiniappSendVerifyCodeRequest
    • dto.MiniappUploadAvatarImgRequest
    • dto.ModifyContactLabelsRequest
    • dto.OauthSdkAppParam
    • dto.OpenHongBaoParam
    • dto.PostParam
    • dto.PrivacyOption
    • dto.PushConfig
    • dto.QueryHongBaoDetailParam
    • dto.QueryHongBaoListParam
    • dto.ReceiveHongBaoParam
    • dto.ReportMotionRequest
    • dto.RevokeParam
    • dto.ScanJoinRequest
    • dto.SearchContactRequest
    • dto.SendAppParam
    • dto.SendCardParam
    • dto.SendFriendRequest
    • dto.SendLinkParam
    • dto.SendPositionParam
    • dto.SendTextParam
    • dto.SendVerifyMobileRequest
    • dto.SetAliasRequest
    • dto.SetAnnouncementRequest
    • dto.SetPasswordRequest
    • dto.SetPrivacyParam
    • dto.SetPrivacyRequest
    • dto.SetRemarkRequest
    • dto.StorageConfig
    • dto.ThirdAppGrantParam
    • dto.UpdateLabelRequest
    • dto.UpdateProfileRequest
    • dto.UploadContactRequest
    • dto.VerifyFriendRequest
    • dto.VerifyPasswordRequest
    • favor.SyncResult
    • favoritepb.AddItemRequest
    • favoritepb.BatchDeleteItemResponse
    • favoritepb.BatchDeleteItemResponse_Result
    • favoritepb.BatchGetItemResponse
    • favoritepb.BatchGetItemResponse_Object
    • favoritepb.GetInfoResponse
    • golem_pkg_login.PasswordLoginResult
    • handler.PasswordLoginRequest
    • handler.Response
    • labelpb.AddContactResponse
    • labelpb.DeleteContactResponse
    • labelpb.GetContactListResponse
    • labelpb.ModifyContactListResponse
    • labelpb.Pair
    • labelpb.UpdateContactResponse
    • login.QRCodeResult
    • login.WakeupResult
    • messagepb.CustomizedInfo
    • messagepb.DeleteChatContact
    • messagepb.DeleteContact
    • messagepb.DeleteContactMessage
    • messagepb.DisturbSetting
    • messagepb.DisturbSetting_TimeSpan
    • messagepb.DownloadAppAttachResponse
    • messagepb.DownloadImageResponse
    • messagepb.DownloadVideoResponse
    • messagepb.DownloadVoiceResponse
    • messagepb.FunctionSwitch
    • messagepb.LinkedinContactItem
    • messagepb.ModifyChatroomMember
    • messagepb.ModifyChatroomMemberDisplayName
    • messagepb.ModifyContact
    • messagepb.ModifyContact_AdditionalContactList
    • messagepb.ModifyContact_AdditionalContactList_LinkedinItem
    • messagepb.ModifyContact_ChatroomInfo
    • messagepb.ModifyContact_ChatroomMemberData
    • messagepb.ModifyContact_ChatroomMemberData_MemberInfo
    • messagepb.ModifyContact_MobileInfo
    • messagepb.ModifyMessageStatus
    • messagepb.ModifyUserAvatar
    • messagepb.ModifyUserInfo
    • messagepb.ModifyUserInfo_GmailList
    • messagepb.ModifyUserInfo_GmailList_Info
    • messagepb.NewMessage
    • messagepb.PatternLockInfo
    • messagepb.QuitChatroom
    • messagepb.RevokeMessageResponse
    • messagepb.SafeDevice
    • messagepb.SafeDeviceList
    • messagepb.SendAppMessageResponse
    • messagepb.SendMessageResponse
    • messagepb.SendMessageResponse_Result
    • messagepb.SnsUserInfo
    • messagepb.SyncResult
    • messagepb.UploadEmojiResponse
    • messagepb.UploadEmojiResponse_Result
    • messagepb.UploadImageResponse
    • messagepb.UploadVideoResponse
    • messagepb.UploadVoiceResponse
    • messagepb.UserInfoExtend
    • miniapppb.SDKOAuthAuthorizeConfirmResponse
    • paymentpb.CGICommand
    • paymentpb.F2FQrcodeResponse
    • paymentpb.HongBaoResponse
    • paymentpb.TenPayResponse
    • userpb.BindEmailResponse
    • userpb.BindOpMobileResponse
    • userpb.BindOpMobileResponse_SafeDeviceList
    • userpb.BindOpMobileResponse_SafeDeviceList_SafeDevice
    • userpb.BindOpMobileResponse_ShowStyleKey
    • userpb.DeleteSafeDeviceResponse
    • userpb.GeneralSetResponse
    • userpb.GetBoundHardDevicesResponse
    • userpb.GetBoundHardDevicesResponse_HardDevice
    • userpb.GetBoundHardDevicesResponse_HardDevice_Attribute
    • userpb.GetBoundHardDevicesResponse_HardDevice_Device
    • userpb.GetCertResponse
    • userpb.GetCertResponse_RSACert
    • userpb.GetProfileResponse
    • userpb.GetSafetyInfoResponse
    • userpb.GetSafetyInfoResponse_SafetyDevice
    • userpb.GetSafetyInfoResponse_SafetyInfo
    • userpb.SendVerifyEmailResponse
    • userpb.SetPasswordResponse
    • userpb.SportDeviceInfo
    • userpb.UploadAvatarResponse
    • userpb.UploadDeviceStepResponse
    • userpb.VerifyPasswordResponse
    • util.SyncResult
    • wrapperspb.StringValue
  1. 文档

FAQ

Q:如何使用?#

A:下载二进制文件启动即可,第一次启动会在 data 目录下生成 config.toml 配置文件并在终端输出提示,此时请 ctrl+c 结束进程,修改或确认配置文件,然后再重启服务,终端会输出登录二维码地址,扫描二维码即可登录。

Q:重启之后需不需要重新登录#

A:不需要,登录之后设备信息与登录信息会持久化到 data 目录下,重启之后会读取文件数据并检测登录状态,如果token过期,golem也会自行刷新token,如果登录信息失效,则golem会在终端输出二维码信息,此时需要重新扫码登录。

Q:扫码出现新设备验证#

A:账号问题,处于风控期,暂时没辙。

Q:异地服务器部署要不要配置代理#

A:目前不支持,异地服务器部署可在本地运行登录以后,迁移 data 目录下的 device.json 和 session.json 文件到服务器中再启动,如需代理,请自行配置服务器全局代理或容器代理。

Q:数据加密#

A:data/config.toml 中可以进行配置,设置 storage.encrypt = true 同时设置加密密钥,即可对设备信息与会话信息进行加密。
同时,也可以通过 管理 中 设置存储加密状态 接口进行设置。

Q:心跳、刷新需要我维护吗#

A:完全不需要,golem在登录之后会自动进行心跳与token刷新。

使用要求#

请使用正常实名账号接入
避免使用异常或存在风险的账号
遵守微信平台运营规范及相关法律法规

注意事项#

修改于 2026-04-24 07:30:45
下一页
重定向到 API 文档
Built with