Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v3

v3.8.4-alpha.3

Feb 11, 2025

v3.8.4-alpha.2

Feb 7, 2025

v3.8.4-alpha.1

Jan 8, 2025

v3.8.3

Jan 7, 2025

v3.8.3-rc.2

Jan 6, 2025

v3.8.3-rc.1

Dec 14, 2024

v3.8.3-patch.9-test2

Jul 9, 2025

v3.8.3-patch.10-win7-go1.20-compat

Aug 17, 2025

v3.8.3-patch.12

Jan 7, 2026

v3.8.3-patch.11

Dec 17, 2025

v3.8.3-patch.10

Jul 16, 2025

v3.8.3-patch.9

Jun 19, 2025

v3.8.3-patch.8

Jun 4, 2025

v3.8.3-patch.7

Jun 4, 2025

v3.8.3-patch.6

May 22, 2025

v3.8.3-patch.5

May 22, 2025

v3.8.3-patch.4

May 21, 2025

v3.8.3-patch.3

Mar 7, 2025

v3.8.3-patch.2

Mar 3, 2025

v3.8.3-patch.1

Feb 25, 2025

v3.8.3-alpha.5

Dec 12, 2024

v3.8.3-alpha.3

Dec 4, 2024

v3.8.3-alpha.2

Nov 29, 2024

v3.8.3-alpha.1

Nov 27, 2024

v3.8.2

Nov 22, 2024

Changes in this version

+ var GetAdminToken = newApi[auth.GetAdminTokenReq, auth.GetAdminTokenResp]("/auth/get_admin_token")

v3.8.2-beta.2

Nov 15, 2024

v3.8.2-beta.1

Nov 7, 2024

v3.8.2-alpha.4

Nov 1, 2024

v3.8.2-alpha.3

Oct 29, 2024

v3.8.2-alpha.2

Oct 25, 2024

v3.8.2-alpha.1

Oct 15, 2024

v3.8.1

Sep 29, 2024

Changes in this version

+ var AcceptGroupApplication = newApi[group.GroupApplicationResponseReq, group.GroupApplicationResponseResp]("/group/group_application_response")

+ var AddBlack = newApi[relation.AddBlackReq, relation.AddBlackResp]("/friend/add_black")

+ var AddFriend = newApi[relation.ApplyToAddFriendReq, relation.ApplyToAddFriendResp]("/friend/add_friend")

+ var AddFriendResponse = newApi[relation.RespondFriendApplyReq, relation.RespondFriendApplyResp]("/friend/add_friend_response")

+ var CancelMuteGroup = newApi[group.CancelMuteGroupReq, group.CancelMuteGroupResp]("/group/cancel_mute_group")

+ var CancelMuteGroupMember = newApi[group.CancelMuteGroupMemberReq, group.CancelMuteGroupMemberResp]("/group/cancel_mute_group_member")

+ var ClearAllMsg = newApi[msg.UserClearAllMsgReq, msg.UserClearAllMsgResp]("/msg/user_clear_all_msg")

+ var ClearConversationMsg = newApi[msg.ClearConversationsMsgReq, msg.ClearConversationsMsgResp]("/msg/clear_conversation_msg")

+ var CreateGroup = newApi[group.CreateGroupReq, group.CreateGroupResp]("/group/create_group")

+ var DeleteFriend = newApi[relation.DeleteFriendReq, relation.DeleteFriendResp]("/friend/delete_friend")

+ var DeleteMsgs = newApi[msg.DeleteMsgsReq, msg.DeleteMsgsResp]("/msg/delete_msgs")

+ var DismissGroup = newApi[group.DismissGroupReq, group.DismissGroupResp]("/group/dismiss_group")

+ var FcmUpdateToken = newApi[third.FcmUpdateTokenReq, third.FcmUpdateTokenResp]("/third/fcm_update_token")

+ var GetAllConversations = newApi[conversation.GetAllConversationsReq, conversation.GetAllConversationsResp]("/conversation/get_all_conversations")

+ var GetBlackList = newApi[relation.GetPaginationBlacksReq, relation.GetPaginationBlacksResp]("/friend/get_black_list")

+ var GetConversations = newApi[conversation.GetConversationsReq, conversation.GetConversationsResp]("/conversation/get_conversations")

+ var GetConversationsHasReadAndMaxSeq = newApi[msg.GetConversationsHasReadAndMaxSeqReq, msg.GetConversationsHasReadAndMaxSeqResp]("/msg/get_conversations_has_read_and_max_seq")

+ var GetDesignatedFriends = newApi[relation.GetDesignatedFriendsReq, relation.GetDesignatedFriendsResp]("/friend/get_designated_friends")

+ var GetDesignatedFriendsApply = newApi[relation.GetDesignatedFriendsApplyReq, relation.GetDesignatedFriendsApplyResp]("/friend/get_designated_friend_apply")

+ var GetFriendApplicationList = newApi[relation.GetPaginationFriendsApplyToReq, relation.GetPaginationFriendsApplyToResp]("/friend/get_friend_apply_list")

+ var GetFriendList = newApi[relation.GetPaginationFriendsReq, relation.GetPaginationFriendsResp]("/friend/get_friend_list")

+ var GetFullConversationIDs = newApi[conversation.GetFullOwnerConversationIDsReq, conversation.GetFullOwnerConversationIDsResp]("/conversation/get_full_conversation_ids")

+ var GetFullFriendUserIDs = newApi[relation.GetFullFriendUserIDsReq, relation.GetFullFriendUserIDsResp]("/friend/get_full_friend_user_ids")

+ var GetFullGroupMemberUserIDs = newApi[group.GetFullGroupMemberUserIDsReq, group.GetFullGroupMemberUserIDsResp]("/group/get_full_group_member_user_ids")

+ var GetFullJoinedGroupIDs = newApi[group.GetFullJoinGroupIDsReq, group.GetFullJoinGroupIDsResp]("/group/get_full_join_group_ids")

+ var GetGroupMemberList = newApi[group.GetGroupMemberListReq, group.GetGroupMemberListResp]("/group/get_group_member_list")

+ var GetGroupMembersInfo = newApi[group.GetGroupMembersInfoReq, group.GetGroupMembersInfoResp]("/group/get_group_members_info")

+ var GetGroupsInfo = newApi[group.GetGroupsInfoReq, group.GetGroupsInfoResp]("/group/get_groups_info")

+ var GetIncrementalConversation = newApi[conversation.GetIncrementalConversationReq, conversation.GetIncrementalConversationResp]("/conversation/get_incremental_conversations")

+ var GetIncrementalFriends = newApi[relation.GetIncrementalFriendsReq, relation.GetIncrementalFriendsResp]("/friend/get_incremental_friends")

+ var GetIncrementalGroupMemberBatch = newApi[group.BatchGetIncrementalGroupMemberReq, group.BatchGetIncrementalGroupMemberResp]("/group/get_incremental_group_members_batch")

+ var GetIncrementalJoinGroup = newApi[group.GetIncrementalJoinGroupReq, group.GetIncrementalJoinGroupResp]("/group/get_incremental_join_groups")

+ var GetJoinedGroupList = newApi[group.GetJoinedGroupListReq, group.GetJoinedGroupListResp]("/group/get_joined_group_list")

+ var GetOwnerConversation = newApi[conversation.GetOwnerConversationReq, conversation.GetOwnerConversationResp]("/conversation/get_owner_conversation")

+ var GetRecvGroupApplicationList = newApi[group.GetGroupApplicationListReq, group.GetGroupApplicationListResp]("/group/get_recv_group_applicationList")

+ var GetSelfFriendApplicationList = newApi[relation.GetPaginationFriendsApplyFromReq, relation.GetPaginationFriendsApplyFromResp]("/friend/get_self_friend_apply_list")

+ var GetSendGroupApplicationList = newApi[group.GetUserReqApplicationListReq, group.GetUserReqApplicationListResp]("/group/get_user_req_group_applicationList")

+ var GetServerTime = newApi[msg.GetServerTimeReq, msg.GetServerTimeResp]("/msg/get_server_time")

+ var GetUsersInfo = newApi[user.GetDesignateUsersReq, user.GetDesignateUsersResp]("/user/get_users_info")

+ var GetUsersToken = newApi[auth.UserTokenReq, auth.UserTokenResp]("/auth/user_token")

+ var ImportFriendList = newApi[relation.ImportFriendReq, relation.ImportFriendResp]("/friend/import_friend")

+ var InviteUserToGroup = newApi[group.InviteUserToGroupReq, group.InviteUserToGroupResp]("/group/invite_user_to_group")

+ var JoinGroup = newApi[group.JoinGroupReq, group.JoinGroupResp]("/group/join_group")

+ var KickGroupMember = newApi[group.KickGroupMemberReq, group.KickGroupMemberResp]("/group/kick_group")

+ var MarkConversationAsRead = newApi[msg.MarkConversationAsReadReq, msg.MarkConversationAsReadResp]("/msg/mark_conversation_as_read")

+ var MarkMsgsAsRead = newApi[msg.MarkMsgsAsReadReq, msg.MarkMsgsAsReadResp]("/msg/mark_msgs_as_read")

+ var MuteGroup = newApi[group.MuteGroupReq, group.MuteGroupResp]("/group/mute_group")

+ var MuteGroupMember = newApi[group.MuteGroupMemberReq, group.MuteGroupMemberResp]("/group/mute_group_member")

+ var ObjectAccessURL = newApi[third.AccessURLReq, third.AccessURLResp]("/object/access_url")

+ var ObjectAuthSign = newApi[third.AuthSignReq, third.AuthSignResp]("/object/auth_sign")

+ var ObjectCompleteMultipartUpload = newApi[third.CompleteMultipartUploadReq, third.CompleteMultipartUploadResp]("/object/complete_multipart_upload")

+ var ObjectInitiateMultipartUpload = newApi[third.InitiateMultipartUploadReq, third.InitiateMultipartUploadResp]("/object/initiate_multipart_upload")

+ var ObjectPartLimit = newApi[third.PartLimitReq, third.PartLimitResp]("/object/part_limit")

+ var ParseToken = newApi[auth.ParseTokenReq, auth.ParseTokenResp]("/auth/parse_token")

+ var ProcessUserCommandAdd = newApi[user.ProcessUserCommandAddReq, user.ProcessUserCommandAddResp]("/user/process_user_command_add")

+ var ProcessUserCommandDelete = newApi[user.ProcessUserCommandDeleteReq, user.ProcessUserCommandDeleteResp]("/user/process_user_command_delete")

+ var ProcessUserCommandGet = newApi[user.ProcessUserCommandGetReq, user.ProcessUserCommandGetResp]("/user/process_user_command_get")

+ var ProcessUserCommandGetAll = newApi[user.ProcessUserCommandGetAllReq, user.ProcessUserCommandGetAllResp]("/user/process_user_command_get_all")

+ var ProcessUserCommandUpdate = newApi[user.ProcessUserCommandUpdateReq, user.ProcessUserCommandUpdateResp]("/user/process_user_command_update")

+ var QuitGroup = newApi[group.QuitGroupReq, group.QuitGroupResp]("/group/quit_group")

+ var RemoveBlack = newApi[relation.RemoveBlackReq, relation.RemoveBlackResp]("/friend/remove_black")

+ var RevokeMsg = newApi[msg.RevokeMsgReq, msg.RevokeMsgResp]("/msg/revoke_msg")

+ var SendMsg = newApi[msg.SendMsgReq, msg.SendMsgResp]("/msg/send_msg")

+ var SetAppBadge = newApi[third.SetAppBadgeReq, third.SetAppBadgeResp]("/third/set_app_badge")

+ var SetConversationHasReadSeq = newApi[msg.SetConversationHasReadSeqReq, msg.SetConversationHasReadSeqResp]("/msg/set_conversation_has_read_seq")

+ var SetConversations = newApi[conversation.SetConversationsReq, conversation.SetConversationsResp]("/conversation/set_conversations")

+ var SetFriendRemark = newApi[relation.SetFriendRemarkReq, relation.SetFriendRemarkResp]("/friend/set_friend_remark")

+ var SetGroupInfoEx = newApi[group.SetGroupInfoExReq, group.SetGroupInfoExResp]("/group/set_group_info_ex")

+ var SetGroupMemberInfo = newApi[group.SetGroupMemberInfoReq, group.SetGroupMemberInfoResp]("/group/set_group_member_info")

+ var TransferGroup = newApi[group.TransferGroupOwnerReq, group.TransferGroupOwnerResp]("/group/transfer_group")

+ var UpdateFriends = newApi[relation.UpdateFriendsReq, relation.UpdateFriendsResp]("/friend/update_friends")

+ var UpdateUserInfo = newApi[user.UpdateUserInfoReq, user.UpdateUserInfoResp]("/user/update_user_info")

+ var UpdateUserInfoEx = newApi[user.UpdateUserInfoExReq, user.UpdateUserInfoExResp]("/user/update_user_info_ex")

+ var UploadLogs = newApi[third.UploadLogsReq, third.UploadLogsResp]("/third/logs/upload")

+ var UserRegister = newApi[user.UserRegisterReq, user.UserRegisterResp]("/user/user_register")

+ func ExtractField[A, B, C any](ctx context.Context, fn func(ctx context.Context, req *A) (*B, error), req *A, ...) (C, error)

+ func Page[Req pagination, Resp any, Elem any](ctx context.Context, req Req, ...) ([]Elem, error)

+ type Api struct

+ func (a Api[Req, Resp]) Execute(ctx context.Context, req *Req) error

+ func (a Api[Req, Resp]) Invoke(ctx context.Context, req *Req) (*Resp, error)

+ func (a Api[Req, Resp]) Route() string

v3.8.1-rc.22

Sep 27, 2024

v3.8.1-rc.21

Sep 19, 2024

v3.8.1-rc.20

Sep 18, 2024

v3.8.1-rc.19

Sep 18, 2024

v3.8.1-rc.18

Sep 18, 2024