Documentation ¶
Index ¶
- Constants
- Variables
- func AddHttpRequestId(ctx context.Context, requestId string) context.Context
- func BoolPtr(b bool) *bool
- func BoolValue(b *bool) bool
- func Int64Ptr(i int64) *int64
- func Int64Value(i *int64) int64
- func IntPtr(i int) *int
- func IntValue(i *int) int
- func IsSDKError(err error) bool
- func NewEncodeRequestError(err error) error
- func NewSDKError(msg string) error
- func RCErrorNew(code int, text string) error
- func StringPtr(s string) *string
- func StringValue(s *string) string
- func WithKeepAlive(t time.Duration) rongCloudOption
- func WithMaxIdleConnsPerHost(n int) rongCloudOption
- func WithRongCloudSMSURI(rongCloudSMSURI string) rongCloudOption
- func WithRongCloudURI(rongCloudURI string) rongCloudOption
- func WithTimeout(t time.Duration) rongCloudOption
- func WithTransport(transport http.RoundTripper) rongCloudOption
- type CMDMsg
- type CMDNtf
- type ChatroomBanAddRequest
- type ChatroomBanAddResponse
- type ChatroomBanCheckRequest
- type ChatroomBanCheckResponse
- type ChatroomBanQueryRequest
- type ChatroomBanQueryResponse
- type ChatroomBanRequest
- type ChatroomBanRollbackRequest
- type ChatroomBanRollbackResponse
- type ChatroomCreateNewRequest
- type ChatroomCreateNewResponse
- type ChatroomDestroyRequest
- type ChatroomDestroyResponse
- type ChatroomDestroySetRequest
- type ChatroomDestroySetResponse
- type ChatroomEntry
- type ChatroomEntryBatchSetRequest
- type ChatroomEntryBatchSetResponse
- type ChatroomEntryQueryRequest
- type ChatroomEntryQueryResponse
- type ChatroomEntryRemoveRequest
- type ChatroomEntryRemoveResponse
- type ChatroomEntrySetRequest
- type ChatroomEntrySetResponse
- type ChatroomGetRequest
- type ChatroomGetResponse
- type ChatroomKeepaliveAddRequest
- type ChatroomKeepaliveAddResponse
- type ChatroomKeepaliveQueryRequest
- type ChatroomKeepaliveQueryResponse
- type ChatroomKeepaliveRemoveRequest
- type ChatroomKeepaliveRemoveResponse
- type ChatroomMessagePriorityAddRequest
- type ChatroomMessagePriorityAddResponse
- type ChatroomMessagePriorityQueryRequest
- type ChatroomMessagePriorityQueryResponse
- type ChatroomMessagePriorityRemoveRequest
- type ChatroomMessagePriorityRemoveResponse
- type ChatroomUserBanAddRequest
- type ChatroomUserBanAddResponse
- type ChatroomUserBanQueryRequest
- type ChatroomUserBanQueryResponse
- type ChatroomUserBanRemoveRequest
- type ChatroomUserBanRemoveResponse
- type ChatroomUserBanWhiteListAddResponse
- type ChatroomUserBanWhiteListRollbackResponse
- type ChatroomUserBanWhitelistAddRequest
- type ChatroomUserBanWhitelistQueryRequest
- type ChatroomUserBanWhitelistQueryResponse
- type ChatroomUserBanWhitelistRequest
- type ChatroomUserBanWhitelistRollbackRequest
- type ChatroomUserBlockAddRequest
- type ChatroomUserBlockAddResponse
- type ChatroomUserBlockListRequest
- type ChatroomUserBlockListResponse
- type ChatroomUserBlockRollbackRequest
- type ChatroomUserBlockRollbackResponse
- type ChatroomUserBlockUser
- type ChatroomUserExistRequest
- type ChatroomUserExistResponse
- type ChatroomUserExistResult
- type ChatroomUserGagAddRequest
- type ChatroomUserGagAddResponse
- type ChatroomUserGagListRequest
- type ChatroomUserGagListResponse
- type ChatroomUserGagRollbackRequest
- type ChatroomUserGagRollbackResponse
- type ChatroomUserQueryRequest
- type ChatroomUserQueryResponse
- type ChatroomUserWhitelistAddRequest
- type ChatroomUserWhitelistAddResponse
- type ChatroomUserWhitelistQueryRequest
- type ChatroomUserWhitelistQueryResponse
- type ChatroomUserWhitelistRemoveRequest
- type ChatroomUserWhitelistRemoveResponse
- type ChatroomUsersExistRequest
- type ChatroomUsersExistResponse
- type ChatroomWhitelistAddRequest
- type ChatroomWhitelistAddResponse
- type ChatroomWhitelistQueryRequest
- type ChatroomWhitelistQueryResponse
- type ChatroomWhitelistRemoveRequest
- type ChatroomWhitelistRemoveResponse
- type ChrmKVNotiMsg
- type CodeResult
- type ContactNtf
- type ConversationNotificationGetRequest
- type ConversationNotificationGetResponse
- type ConversationNotificationSetRequest
- type ConversationNotificationSetResponse
- type ConversationTopSetRequest
- type ConversationTopSetResponse
- type ConversationTypeNotificationGetRequest
- type ConversationTypeNotificationGetResponse
- type ConversationTypeNotificationSetRequest
- type ConversationTypeNotificationSetResponse
- type FileMsg
- type GagUser
- type Group
- type GroupBanAddRequest
- type GroupBanAddResponse
- type GroupBanQueryGroupInfo
- type GroupBanQueryRequest
- type GroupBanQueryResponse
- type GroupBanRollbackRequest
- type GroupBanRollbackResponse
- type GroupCreateRequest
- type GroupCreateResponse
- type GroupDismissRequest
- type GroupDismissResponse
- type GroupJoinRequest
- type GroupJoinResponse
- type GroupQuitRequest
- type GroupQuitResponse
- type GroupRefreshRequest
- type GroupRefreshResponse
- type GroupRemarksDelRequest
- type GroupRemarksDelResponse
- type GroupRemarksGetRequest
- type GroupRemarksGetResponse
- type GroupRemarksSetRequest
- type GroupRemarksSetResponse
- type GroupSyncRequest
- type GroupSyncResponse
- type GroupUser
- type GroupUserBanWhitelistAddRequest
- type GroupUserBanWhitelistAddResponse
- type GroupUserBanWhitelistQueryRequest
- type GroupUserBanWhitelistQueryResponse
- type GroupUserBanWhitelistRollbackRequest
- type GroupUserBanWhitelistRollbackResponse
- type GroupUserGagAddRequest
- type GroupUserGagAddResponse
- type GroupUserGagListRequest
- type GroupUserGagListResponse
- type GroupUserGagRollbackRequest
- type GroupUserGagRollbackResponse
- type GroupUserQueryRequest
- type GroupUserQueryResponse
- type GrpNtf
- type HQVCMsg
- type IMGTextMsg
- type ImgMsg
- type InfoNtf
- type LBSMsg
- type MessageBroadcastRequest
- type MessageBroadcastResponse
- type MessageChatroomBroadcastRequest
- type MessageChatroomBroadcastResponse
- type MessageChatroomPublishRequest
- type MessageChatroomPublishResponse
- type MessageExpansionDeleteRequest
- type MessageExpansionDeleteResponse
- type MessageExpansionQueryExtraContentValue
- type MessageExpansionQueryRequest
- type MessageExpansionQueryResponse
- type MessageExpansionSetRequest
- type MessageExpansionSetResponse
- type MessageGroupPublishRequest
- type MessageGroupPublishResponse
- type MessageHistoryDeleteRequest
- type MessageHistoryDeleteResponse
- type MessageHistoryRequest
- type MessageHistoryResponse
- type MessageOnlineBroadcastRequest
- type MessageOnlineBroadcastResponse
- type MessagePrivatePublishRequest
- type MessagePrivatePublishResponse
- type MessagePrivatePublishTemplateRequest
- type MessagePrivatePublishTemplateResponse
- type MessageRecallRequest
- type MessageRecallResponse
- type MessageSystemPublishRequest
- type MessageSystemPublishResponse
- type MessageSystemPublishTemplateRequest
- type MessageSystemPublishTemplateResponse
- type MessageTemplate
- type MessageUltraGroupPublishRequest
- type MessageUltraGroupPublishResponse
- type MsgUserInfo
- type ProfileNtf
- type PushAndroid
- type PushAndroidFcm
- type PushAndroidHW
- type PushAndroidHonor
- type PushAndroidMi
- type PushAndroidOppo
- type PushAndroidVivo
- type PushAudience
- type PushCustomAudience
- type PushCustomAudienceTagItem
- type PushCustomNotification
- type PushCustomNotificationIOS
- type PushCustomRequest
- type PushCustomResponse
- type PushNotification
- type PushNotificationAndroid
- type PushNotificationIOS
- type PushRequest
- type PushResponse
- type PushUserNotification
- type PushUserNotificationIOS
- type PushUserRequest
- type PushUserResponse
- type RCMsg
- type RongCloud
- func (rc *RongCloud) ChatroomBanAdd(ctx context.Context, req *ChatroomBanAddRequest) (*ChatroomBanAddResponse, error)
- func (rc *RongCloud) ChatroomBanCheck(ctx context.Context, req *ChatroomBanCheckRequest) (*ChatroomBanCheckResponse, error)
- func (rc *RongCloud) ChatroomBanQuery(ctx context.Context, req *ChatroomBanQueryRequest) (*ChatroomBanQueryResponse, error)
- func (rc *RongCloud) ChatroomBanRollback(ctx context.Context, req *ChatroomBanRollbackRequest) (*ChatroomBanRollbackResponse, error)
- func (rc *RongCloud) ChatroomCreateNew(ctx context.Context, req *ChatroomCreateNewRequest) (*ChatroomCreateNewResponse, error)
- func (rc *RongCloud) ChatroomDestroy(ctx context.Context, req *ChatroomDestroyRequest) (*ChatroomDestroyResponse, error)
- func (rc *RongCloud) ChatroomDestroySet(ctx context.Context, req *ChatroomDestroySetRequest) (*ChatroomDestroySetResponse, error)
- func (rc *RongCloud) ChatroomEntryBatchSet(ctx context.Context, req *ChatroomEntryBatchSetRequest) (*ChatroomEntryBatchSetResponse, error)
- func (rc *RongCloud) ChatroomEntryQuery(ctx context.Context, req *ChatroomEntryQueryRequest) (*ChatroomEntryQueryResponse, error)
- func (rc *RongCloud) ChatroomEntryRemove(ctx context.Context, req *ChatroomEntryRemoveRequest) (*ChatroomEntryRemoveResponse, error)
- func (rc *RongCloud) ChatroomEntrySet(ctx context.Context, req *ChatroomEntrySetRequest) (*ChatroomEntrySetResponse, error)
- func (rc *RongCloud) ChatroomGet(ctx context.Context, req *ChatroomGetRequest) (*ChatroomGetResponse, error)
- func (rc *RongCloud) ChatroomKeepaliveAdd(ctx context.Context, req *ChatroomKeepaliveAddRequest) (*ChatroomKeepaliveAddResponse, error)
- func (rc *RongCloud) ChatroomKeepaliveQuery(ctx context.Context, req *ChatroomKeepaliveQueryRequest) (*ChatroomKeepaliveQueryResponse, error)
- func (rc *RongCloud) ChatroomKeepaliveRemove(ctx context.Context, req *ChatroomKeepaliveRemoveRequest) (*ChatroomKeepaliveRemoveResponse, error)
- func (rc *RongCloud) ChatroomMessagePriorityAdd(ctx context.Context, req *ChatroomMessagePriorityAddRequest) (*ChatroomMessagePriorityAddResponse, error)
- func (rc *RongCloud) ChatroomMessagePriorityQuery(ctx context.Context, req *ChatroomMessagePriorityQueryRequest) (*ChatroomMessagePriorityQueryResponse, error)
- func (rc *RongCloud) ChatroomMessagePriorityRemove(ctx context.Context, req *ChatroomMessagePriorityRemoveRequest) (*ChatroomMessagePriorityRemoveResponse, error)
- func (rc *RongCloud) ChatroomUserBanAdd(ctx context.Context, req *ChatroomUserBanAddRequest) (*ChatroomUserBanAddResponse, error)
- func (rc *RongCloud) ChatroomUserBanQuery(ctx context.Context, req *ChatroomUserBanQueryRequest) (*ChatroomUserBanQueryResponse, error)
- func (rc *RongCloud) ChatroomUserBanRemove(ctx context.Context, req *ChatroomUserBanRemoveRequest) (*ChatroomUserBanRemoveResponse, error)
- func (rc *RongCloud) ChatroomUserBanWhitelistAdd(ctx context.Context, req *ChatroomUserBanWhitelistAddRequest) (*ChatroomUserBanWhiteListAddResponse, error)
- func (rc *RongCloud) ChatroomUserBanWhitelistQuery(ctx context.Context, req *ChatroomUserBanWhitelistQueryRequest) (*ChatroomUserBanWhitelistQueryResponse, error)
- func (rc *RongCloud) ChatroomUserBanWhitelistRollback(ctx context.Context, req *ChatroomUserBanWhitelistRollbackRequest) (*ChatroomUserBanWhiteListRollbackResponse, error)
- func (rc *RongCloud) ChatroomUserBlockAdd(ctx context.Context, req *ChatroomUserBlockAddRequest) (*ChatroomUserBlockAddResponse, error)
- func (rc *RongCloud) ChatroomUserBlockList(ctx context.Context, req *ChatroomUserBlockListRequest) (*ChatroomUserBlockListResponse, error)
- func (rc *RongCloud) ChatroomUserBlockRollback(ctx context.Context, req *ChatroomUserBlockRollbackRequest) (*ChatroomUserBlockRollbackResponse, error)
- func (rc *RongCloud) ChatroomUserExist(ctx context.Context, req *ChatroomUserExistRequest) (*ChatroomUserExistResponse, error)
- func (rc *RongCloud) ChatroomUserGagAdd(ctx context.Context, req *ChatroomUserGagAddRequest) (*ChatroomUserGagAddResponse, error)
- func (rc *RongCloud) ChatroomUserGagList(ctx context.Context, req *ChatroomUserGagListRequest) (*ChatroomUserGagListResponse, error)
- func (rc *RongCloud) ChatroomUserGagRollback(ctx context.Context, req *ChatroomUserGagRollbackRequest) (*ChatroomUserGagRollbackResponse, error)
- func (rc *RongCloud) ChatroomUserQuery(ctx context.Context, req *ChatroomUserQueryRequest) (*ChatroomUserQueryResponse, error)
- func (rc *RongCloud) ChatroomUserWhitelistAdd(ctx context.Context, req *ChatroomUserWhitelistAddRequest) (*ChatroomUserWhitelistAddResponse, error)
- func (rc *RongCloud) ChatroomUserWhitelistQuery(ctx context.Context, req *ChatroomUserWhitelistQueryRequest) (*ChatroomUserWhitelistQueryResponse, error)
- func (rc *RongCloud) ChatroomUserWhitelistRemove(ctx context.Context, req *ChatroomUserWhitelistRemoveRequest) (*ChatroomUserWhitelistRemoveResponse, error)
- func (rc *RongCloud) ChatroomUsersExist(ctx context.Context, req *ChatroomUsersExistRequest) (*ChatroomUsersExistResponse, error)
- func (rc *RongCloud) ChatroomWhitelistAdd(ctx context.Context, req *ChatroomWhitelistAddRequest) (*ChatroomWhitelistAddResponse, error)
- func (rc *RongCloud) ChatroomWhitelistQuery(ctx context.Context, req *ChatroomWhitelistQueryRequest) (*ChatroomWhitelistQueryResponse, error)
- func (rc *RongCloud) ChatroomWhitelistRemove(ctx context.Context, req *ChatroomWhitelistRemoveRequest) (*ChatroomWhitelistRemoveResponse, error)
- func (rc *RongCloud) ConversationNotificationGet(ctx context.Context, req *ConversationNotificationGetRequest) (*ConversationNotificationGetResponse, error)
- func (rc *RongCloud) ConversationNotificationSet(ctx context.Context, req *ConversationNotificationSetRequest) (*ConversationNotificationSetResponse, error)
- func (rc *RongCloud) ConversationTopSet(ctx context.Context, req *ConversationTopSetRequest) (*ConversationTopSetResponse, error)
- func (rc *RongCloud) ConversationTypeNotificationGet(ctx context.Context, req *ConversationTypeNotificationGetRequest) (*ConversationTypeNotificationGetResponse, error)
- func (rc *RongCloud) ConversationTypeNotificationSet(ctx context.Context, req *ConversationTypeNotificationSetRequest) (*ConversationTypeNotificationSetResponse, error)
- func (rc *RongCloud) GetHttpTransport() http.RoundTripper
- func (rc *RongCloud) GroupBanAdd(ctx context.Context, req *GroupBanAddRequest) (*GroupBanAddResponse, error)
- func (rc *RongCloud) GroupBanQuery(ctx context.Context, req *GroupBanQueryRequest) (*GroupBanQueryResponse, error)
- func (rc *RongCloud) GroupBanRollback(ctx context.Context, req *GroupBanRollbackRequest) (*GroupBanRollbackResponse, error)
- func (rc *RongCloud) GroupCreate(ctx context.Context, req *GroupCreateRequest) (*GroupCreateResponse, error)
- func (rc *RongCloud) GroupDismiss(ctx context.Context, req *GroupDismissRequest) (*GroupDismissResponse, error)
- func (rc *RongCloud) GroupJoin(ctx context.Context, req *GroupJoinRequest) (*GroupJoinResponse, error)
- func (rc *RongCloud) GroupQuit(ctx context.Context, req *GroupQuitRequest) (*GroupQuitResponse, error)
- func (rc *RongCloud) GroupRefresh(ctx context.Context, req *GroupRefreshRequest) (*GroupRefreshResponse, error)
- func (rc *RongCloud) GroupRemarksDel(ctx context.Context, req *GroupRemarksDelRequest) (*GroupRemarksDelResponse, error)
- func (rc *RongCloud) GroupRemarksGet(ctx context.Context, req *GroupRemarksGetRequest) (*GroupRemarksGetResponse, error)
- func (rc *RongCloud) GroupRemarksSet(ctx context.Context, req *GroupRemarksSetRequest) (*GroupRemarksSetResponse, error)
- func (rc *RongCloud) GroupSync(ctx context.Context, req *GroupSyncRequest) (*GroupSyncResponse, error)
- func (rc *RongCloud) GroupUserBanWhitelistAdd(ctx context.Context, req *GroupUserBanWhitelistAddRequest) (*GroupUserBanWhitelistAddResponse, error)
- func (rc *RongCloud) GroupUserBanWhitelistQuery(ctx context.Context, req *GroupUserBanWhitelistQueryRequest) (*GroupUserBanWhitelistQueryResponse, error)
- func (rc *RongCloud) GroupUserBanWhitelistRollback(ctx context.Context, req *GroupUserBanWhitelistRollbackRequest) (*GroupUserBanWhitelistRollbackResponse, error)
- func (rc *RongCloud) GroupUserGagAdd(ctx context.Context, req *GroupUserGagAddRequest) (*GroupUserGagAddResponse, error)
- func (rc *RongCloud) GroupUserGagList(ctx context.Context, req *GroupUserGagListRequest) (*GroupUserGagListResponse, error)
- func (rc *RongCloud) GroupUserGagRollback(ctx context.Context, req *GroupUserGagRollbackRequest) (*GroupUserGagRollbackResponse, error)
- func (rc *RongCloud) GroupUserQuery(ctx context.Context, req *GroupUserQueryRequest) (*GroupUserQueryResponse, error)
- func (rc *RongCloud) MessageBroadcast(ctx context.Context, req *MessageBroadcastRequest) (*MessageBroadcastResponse, error)
- func (rc *RongCloud) MessageChatroomBroadcast(ctx context.Context, req *MessageChatroomBroadcastRequest) (*MessageChatroomBroadcastResponse, error)
- func (rc *RongCloud) MessageChatroomPublish(ctx context.Context, req *MessageChatroomPublishRequest) (*MessageChatroomPublishResponse, error)
- func (rc *RongCloud) MessageExpansionDelete(ctx context.Context, req *MessageExpansionDeleteRequest) (*MessageExpansionDeleteResponse, error)
- func (rc *RongCloud) MessageExpansionQuery(ctx context.Context, req *MessageExpansionQueryRequest) (*MessageExpansionQueryResponse, error)
- func (rc *RongCloud) MessageExpansionSet(ctx context.Context, req *MessageExpansionSetRequest) (*MessageExpansionSetResponse, error)
- func (rc *RongCloud) MessageGroupPublish(ctx context.Context, req *MessageGroupPublishRequest) (*MessageGroupPublishResponse, error)
- func (rc *RongCloud) MessageHistory(ctx context.Context, req *MessageHistoryRequest) (*MessageHistoryResponse, error)
- func (rc *RongCloud) MessageHistoryDelete(ctx context.Context, req *MessageHistoryDeleteRequest) (*MessageHistoryDeleteResponse, error)
- func (rc *RongCloud) MessageOnlineBroadcast(ctx context.Context, req *MessageOnlineBroadcastRequest) (*MessageOnlineBroadcastResponse, error)
- func (rc *RongCloud) MessagePrivatePublish(ctx context.Context, req *MessagePrivatePublishRequest) (*MessagePrivatePublishResponse, error)
- func (rc *RongCloud) MessagePrivatePublishTemplate(ctx context.Context, req *MessagePrivatePublishTemplateRequest) (*MessagePrivatePublishTemplateResponse, error)
- func (rc *RongCloud) MessageRecall(ctx context.Context, req *MessageRecallRequest) (*MessageRecallResponse, error)
- func (rc *RongCloud) MessageSystemPublish(ctx context.Context, req *MessageSystemPublishRequest) (*MessageSystemPublishResponse, error)
- func (rc *RongCloud) MessageSystemPublishTemplate(ctx context.Context, req *MessageSystemPublishTemplateRequest) (*MessageSystemPublishTemplateResponse, error)
- func (rc *RongCloud) MessageUltraGroupPublish(ctx context.Context, req *MessageUltraGroupPublishRequest) (*MessageUltraGroupPublishResponse, error)
- func (rc *RongCloud) PrivateURI(uri, sms string)
- func (rc *RongCloud) Push(ctx context.Context, req *PushRequest) (*PushResponse, error)
- func (rc *RongCloud) PushCustom(ctx context.Context, req *PushCustomRequest) (*PushCustomResponse, error)
- func (rc *RongCloud) PushUser(ctx context.Context, req *PushUserRequest) (*PushUserResponse, error)
- func (rc *RongCloud) SensitiveWordAdd(ctx context.Context, req *SensitiveWordAddRequest) (*SensitiveWordAddResponse, error)
- func (rc *RongCloud) SensitiveWordBatchDelete(ctx context.Context, req *SensitiveWordBatchDeleteRequest) (*SensitiveWordBatchDeleteResponse, error)
- func (rc *RongCloud) SensitiveWordList(ctx context.Context, req *SensitiveWordListRequest) (*SensitiveWordListResponse, error)
- func (rc *RongCloud) SetHttpTransport(httpTransport http.RoundTripper)
- func (rc *RongCloud) StatusMessageGroupPublish(ctx context.Context, req *StatusMessageGroupPublishRequest) (*StatusMessageGroupPublishResponse, error)
- func (rc *RongCloud) StatusMessagePrivatePublish(ctx context.Context, req *StatusMessagePrivatePublishRequest) (*StatusMessagePrivatePublishResponse, error)
- func (rc *RongCloud) UltraGroupBannedWhitelistAdd(ctx context.Context, req *UltraGroupBannedWhitelistAddRequest) (*UltraGroupBannedWhitelistAddResponse, error)
- func (rc *RongCloud) UltraGroupBannedWhitelistDel(ctx context.Context, req *UltraGroupBannedWhitelistDelRequest) (*UltraGroupBannedWhitelistDelResponse, error)
- func (rc *RongCloud) UltraGroupBannedWhitelistGet(ctx context.Context, req *UltraGroupBannedWhitelistGetRequest) (*UltraGroupBannedWhitelistGetResponse, error)
- func (rc *RongCloud) UltraGroupChannelCreate(ctx context.Context, req *UltraGroupChannelCreateRequest) (*UltraGroupChannelCreateResponse, error)
- func (rc *RongCloud) UltraGroupChannelDel(ctx context.Context, req *UltraGroupChannelDelRequest) (*UltraGroupChannelDelResponse, error)
- func (rc *RongCloud) UltraGroupChannelGet(ctx context.Context, req *UltraGroupChannelGetRequest) (*UltraGroupChannelGetResponse, error)
- func (rc *RongCloud) UltraGroupChannelPrivateUsersAdd(ctx context.Context, req *UltraGroupChannelPrivateUsersAddRequest) (*UltraGroupChannelPrivateUsersAddResponse, error)
- func (rc *RongCloud) UltraGroupChannelPrivateUsersDel(ctx context.Context, req *UltraGroupChannelPrivateUsersDelRequest) (*UltraGroupChannelPrivateUsersDelResponse, error)
- func (rc *RongCloud) UltraGroupChannelPrivateUsersGet(ctx context.Context, req *UltraGroupChannelPrivateUsersGetRequest) (*UltraGroupChannelPrivateUsersGetResponse, error)
- func (rc *RongCloud) UltraGroupChannelTypeChange(ctx context.Context, req *UltraGroupChannelTypeChangeRequest) (*UltraGroupChannelTypeChangeResponse, error)
- func (rc *RongCloud) UltraGroupChannelUserGroupBind(ctx context.Context, req *UltraGroupChannelUserGroupBindRequest) (*UltraGroupChannelUserGroupBindResponse, error)
- func (rc *RongCloud) UltraGroupChannelUserGroupQuery(ctx context.Context, req *UltraGroupChannelUserGroupQueryRequest) (*UltraGroupChannelUserGroupQueryResponse, error)
- func (rc *RongCloud) UltraGroupChannelUserGroupUnbind(ctx context.Context, req *UltraGroupChannelUserGroupUnbindRequest) (*UltraGroupChannelUserGroupUnbindResponse, error)
- func (rc *RongCloud) UltraGroupCreate(ctx context.Context, req *UltraGroupCreateRequest) (*UltraGroupCreateResponse, error)
- func (rc *RongCloud) UltraGroupDis(ctx context.Context, req *UltraGroupDisRequest) (*UltraGroupDisResponse, error)
- func (rc *RongCloud) UltraGroupGlobalBannedGet(ctx context.Context, req *UltraGroupGlobalBannedGetRequest) (*UltraGroupGlobalBannedGetResponse, error)
- func (rc *RongCloud) UltraGroupGlobalBannedSet(ctx context.Context, req *UltraGroupGlobalBannedSetRequest) (*UltraGroupGlobalBannedSetResponse, error)
- func (rc *RongCloud) UltraGroupHismsgMsgIdQuery(ctx context.Context, req *UltraGroupHisMsgMsgIdQueryRequest) (*UltraGroupHisMsgMsgIdQueryResponse, error)
- func (rc *RongCloud) UltraGroupHismsgQuery(ctx context.Context, req *UltraGroupHismsgQueryRequest) (*UltraGroupHismsgQueryResponse, error)
- func (rc *RongCloud) UltraGroupJoin(ctx context.Context, req *UltraGroupJoinRequest) (*UltraGroupJoinResponse, error)
- func (rc *RongCloud) UltraGroupMemberExist(ctx context.Context, req *UltraGroupMemberExistRequest) (*UltraGroupMemberExistResponse, error)
- func (rc *RongCloud) UltraGroupMessageExpansionDelete(ctx context.Context, req *UltraGroupMessageExpansionDeleteRequest) (*UltraGroupMessageExpansionDeleteResponse, error)
- func (rc *RongCloud) UltraGroupMessageExpansionQuery(ctx context.Context, req *UltraGroupMessageExpansionQueryRequest) (*UltraGroupMessageExpansionQueryResponse, error)
- func (rc *RongCloud) UltraGroupMessageExpansionSet(ctx context.Context, req *UltraGroupMessageExpansionSetRequest) (*UltraGroupMessageExpansionSetResponse, error)
- func (rc *RongCloud) UltraGroupMsgGet(ctx context.Context, req *UltraGroupMsgGetRequest) (*UltraGroupMsgGetResponse, error)
- func (rc *RongCloud) UltraGroupMsgModify(ctx context.Context, req *UltraGroupMsgModifyRequest) (*UltraGroupMsgModifyResponse, error)
- func (rc *RongCloud) UltraGroupNotDisturbGet(ctx context.Context, req *UltraGroupNotDisturbGetRequest) (*UltraGroupNotDisturbGetResponse, error)
- func (rc *RongCloud) UltraGroupNotDisturbSet(ctx context.Context, req *UltraGroupNotDisturbSetRequest) (*UltraGroupNotDisturbSetResponse, error)
- func (rc *RongCloud) UltraGroupQuit(ctx context.Context, req *UltraGroupQuitRequest) (*UltraGroupQuitResponse, error)
- func (rc *RongCloud) UltraGroupRefresh(ctx context.Context, req *UltraGroupRefreshRequest) (*UltraGroupRefreshResponse, error)
- func (rc *RongCloud) UltraGroupUserBannedAdd(ctx context.Context, req *UltraGroupUserBannedAddRequest) (*UltraGroupUserBannedAddResponse, error)
- func (rc *RongCloud) UltraGroupUserBannedDel(ctx context.Context, req *UltraGroupUserBannedDelRequest) (*UltraGroupUserBannedDelResponse, error)
- func (rc *RongCloud) UltraGroupUserBannedGet(ctx context.Context, req *UltraGroupUserBannedGetRequest) (*UltraGroupUserBannedGetResponse, error)
- func (rc *RongCloud) UltraGroupUserChannelQuery(ctx context.Context, req *UltraGroupUserChannelQueryRequest) (*UltraGroupUserChannelQueryResponse, error)
- func (rc *RongCloud) UltraGroupUserGroupAdd(ctx context.Context, req *UltraGroupUserGroupAddRequest) (*UltraGroupUserGroupAddResponse, error)
- func (rc *RongCloud) UltraGroupUserGroupChannelQuery(ctx context.Context, req *UltraGroupUserGroupChannelQueryRequest) (*UltraGroupUserGroupChannelQueryResponse, error)
- func (rc *RongCloud) UltraGroupUserGroupDel(ctx context.Context, req *UltraGroupUserGroupDelRequest) (*UltraGroupUserGroupDelResponse, error)
- func (rc *RongCloud) UltraGroupUserGroupQuery(ctx context.Context, req *UltraGroupUserGroupQueryRequest) (*UltraGroupUserGroupQueryResponse, error)
- func (rc *RongCloud) UltraGroupUserGroupUserAdd(ctx context.Context, req *UltraGroupUserGroupUserAddRequest) (*UltraGroupUserGroupUserAddResponse, error)
- func (rc *RongCloud) UltraGroupUserGroupUserDel(ctx context.Context, req *UltraGroupUserGroupUserDelRequest) (*UltraGroupUserGroupUserDelResponse, error)
- func (rc *RongCloud) UltraGroupUserUserGroupQuery(ctx context.Context, req *UltraGroupUserUserGroupQueryRequest) (*UltraGroupUserUserGroupQueryResponse, error)
- func (rc *RongCloud) UserBlacklistAdd(ctx context.Context, req *UserBlacklistAddRequest) (*UserBlacklistAddResponse, error)
- func (rc *RongCloud) UserBlacklistQuery(ctx context.Context, req *UserBlacklistQueryRequest) (*UserBlacklistQueryResponse, error)
- func (rc *RongCloud) UserBlacklistRemove(ctx context.Context, req *UserBlacklistRemoveRequest) (*UserBlacklistRemoveResponse, error)
- func (rc *RongCloud) UserBlock(ctx context.Context, req *UserBlockRequest) (*UserBlockResponse, error)
- func (rc *RongCloud) UserBlockPushPeriodDelete(ctx context.Context, req *UserBlockPushPeriodDeleteRequest) (*UserBlockPushPeriodDeleteResponse, error)
- func (rc *RongCloud) UserBlockPushPeriodGet(ctx context.Context, req *UserBlockPushPeriodGetRequest) (*UserBlockPushPeriodGetResponse, error)
- func (rc *RongCloud) UserBlockPushPeriodSet(ctx context.Context, req *UserBlockPushPeriodSetRequest) (*UserBlockPushPeriodSetResponse, error)
- func (rc *RongCloud) UserBlockQuery(ctx context.Context, req *UserBlockQueryRequest) (*UserBlockQueryResponse, error)
- func (rc *RongCloud) UserChatFBQueryList(ctx context.Context, req *UserChatFBQueryListRequest) (*UserChatFBQueryListResponse, error)
- func (rc *RongCloud) UserChatFBSet(ctx context.Context, req *UserChatFBSetRequest) (*UserChatFBSetResponse, error)
- func (rc *RongCloud) UserCheckOnline(ctx context.Context, req *UserCheckOnlineRequest) (*UserCheckOnlineResponse, error)
- func (rc *RongCloud) UserDeactivate(ctx context.Context, req *UserDeactivateRequest) (*UserDeactivateResponse, error)
- func (rc *RongCloud) UserDeactivateQuery(ctx context.Context, req *UserDeactivateQueryRequest) (*UserDeactivateQueryResponse, error)
- func (rc *RongCloud) UserGetToken(ctx context.Context, req *UserGetTokenRequest) (*UserGetTokenResponse, error)
- func (rc *RongCloud) UserGroupQuery(ctx context.Context, req *UserGroupQueryRequest) (*UserGroupQueryResponse, error)
- func (rc *RongCloud) UserReactivate(ctx context.Context, req *UserReactivateRequest) (*UserReactivateResponse, error)
- func (rc *RongCloud) UserRefresh(ctx context.Context, req *UserRefreshRequest) (*UserRefreshResponse, error)
- func (rc *RongCloud) UserRemarksDel(ctx context.Context, req *UserRemarksDelRequest) (*UserRemarksDelResponse, error)
- func (rc *RongCloud) UserRemarksGet(ctx context.Context, req *UserRemarksGetRequest) (*UserRemarksGetResponse, error)
- func (rc *RongCloud) UserRemarksSet(ctx context.Context, req *UserRemarksSetRequest) (*UserRemarksSetResponse, error)
- func (rc *RongCloud) UserTagBatchSet(ctx context.Context, req *UserTagBatchSetRequest) (*UserTagBatchSetResponse, error)
- func (rc *RongCloud) UserTagSet(ctx context.Context, req *UserTagSetRequest) (*UserTagSetResponse, error)
- func (rc *RongCloud) UserTagsGet(ctx context.Context, req *UserTagsGetRequest) (*UserTagsGetResponse, error)
- func (rc *RongCloud) UserTokenExpire(ctx context.Context, req *UserTokenExpireRequest) (*UserTokenExpireResponse, error)
- func (rc *RongCloud) UserUnBlock(ctx context.Context, req *UserUnBlockRequest) (*UserUnBlockResponse, error)
- func (rc *RongCloud) UserWhitelistAdd(ctx context.Context, req *UserWhitelistAddRequest) (*UserWhitelistAddResponse, error)
- func (rc *RongCloud) UserWhitelistQuery(ctx context.Context, req *UserWhitelistQueryRequest) (*UserWhitelistQueryResponse, error)
- func (rc *RongCloud) UserWhitelistRemove(ctx context.Context, req *UserWhitelistRemoveRequest) (*UserWhitelistRemoveResponse, error)
- type SDKError
- type SensitiveWord
- type SensitiveWordAddRequest
- type SensitiveWordAddResponse
- type SensitiveWordBatchDeleteRequest
- type SensitiveWordBatchDeleteResponse
- type SensitiveWordListRequest
- type SensitiveWordListResponse
- type StatusMessageGroupPublishRequest
- type StatusMessageGroupPublishResponse
- type StatusMessagePrivatePublishRequest
- type StatusMessagePrivatePublishResponse
- type SyncGroups
- type TXTMsg
- type UltraGroupBannedWhitelistAddRequest
- type UltraGroupBannedWhitelistAddResponse
- type UltraGroupBannedWhitelistDelRequest
- type UltraGroupBannedWhitelistDelResponse
- type UltraGroupBannedWhitelistGetRequest
- type UltraGroupBannedWhitelistGetResponse
- type UltraGroupBannedWhitelistUser
- type UltraGroupChannel
- type UltraGroupChannelCreateRequest
- type UltraGroupChannelCreateResponse
- type UltraGroupChannelDelRequest
- type UltraGroupChannelDelResponse
- type UltraGroupChannelGetRequest
- type UltraGroupChannelGetResponse
- type UltraGroupChannelPrivateUsersAddRequest
- type UltraGroupChannelPrivateUsersAddResponse
- type UltraGroupChannelPrivateUsersDelRequest
- type UltraGroupChannelPrivateUsersDelResponse
- type UltraGroupChannelPrivateUsersGetRequest
- type UltraGroupChannelPrivateUsersGetResponse
- type UltraGroupChannelTypeChangeRequest
- type UltraGroupChannelTypeChangeResponse
- type UltraGroupChannelUserGroupBindRequest
- type UltraGroupChannelUserGroupBindResponse
- type UltraGroupChannelUserGroupQueryRequest
- type UltraGroupChannelUserGroupQueryResponse
- type UltraGroupChannelUserGroupUnbindRequest
- type UltraGroupChannelUserGroupUnbindResponse
- type UltraGroupCreateRequest
- type UltraGroupCreateResponse
- type UltraGroupDisRequest
- type UltraGroupDisResponse
- type UltraGroupGlobalBannedGetRequest
- type UltraGroupGlobalBannedGetResponse
- type UltraGroupGlobalBannedSetRequest
- type UltraGroupGlobalBannedSetResponse
- type UltraGroupHisMsg
- type UltraGroupHisMsgMsgIdQueryRequest
- type UltraGroupHisMsgMsgIdQueryResponse
- type UltraGroupHismsgQueryRequest
- type UltraGroupHismsgQueryResponse
- type UltraGroupJoinRequest
- type UltraGroupJoinResponse
- type UltraGroupMemberExistRequest
- type UltraGroupMemberExistResponse
- type UltraGroupMessageExpansionDeleteRequest
- type UltraGroupMessageExpansionDeleteResponse
- type UltraGroupMessageExpansionQueryRequest
- type UltraGroupMessageExpansionQueryResponse
- type UltraGroupMessageExpansionSetRequest
- type UltraGroupMessageExpansionSetResponse
- type UltraGroupMsg
- type UltraGroupMsgData
- type UltraGroupMsgGetRequest
- type UltraGroupMsgGetResponse
- type UltraGroupMsgModifyRequest
- type UltraGroupMsgModifyResponse
- type UltraGroupNotDisturbGetRequest
- type UltraGroupNotDisturbGetResponse
- type UltraGroupNotDisturbSetRequest
- type UltraGroupNotDisturbSetResponse
- type UltraGroupQuitRequest
- type UltraGroupQuitResponse
- type UltraGroupRefreshRequest
- type UltraGroupRefreshResponse
- type UltraGroupUserBannedAddRequest
- type UltraGroupUserBannedAddResponse
- type UltraGroupUserBannedDelRequest
- type UltraGroupUserBannedDelResponse
- type UltraGroupUserBannedGetRequest
- type UltraGroupUserBannedGetResponse
- type UltraGroupUserBannedGetUser
- type UltraGroupUserChannelQueryRequest
- type UltraGroupUserChannelQueryResponse
- type UltraGroupUserGroup
- type UltraGroupUserGroupAddRequest
- type UltraGroupUserGroupAddResponse
- type UltraGroupUserGroupChannelQueryRequest
- type UltraGroupUserGroupChannelQueryResponse
- type UltraGroupUserGroupDelRequest
- type UltraGroupUserGroupDelResponse
- type UltraGroupUserGroupQueryRequest
- type UltraGroupUserGroupQueryResponse
- type UltraGroupUserGroupUserAddRequest
- type UltraGroupUserGroupUserAddResponse
- type UltraGroupUserGroupUserDelRequest
- type UltraGroupUserGroupUserDelResponse
- type UltraGroupUserUserGroupQueryRequest
- type UltraGroupUserUserGroupQueryResponse
- type UserBlacklistAddRequest
- type UserBlacklistAddResponse
- type UserBlacklistQueryRequest
- type UserBlacklistQueryResponse
- type UserBlacklistRemoveRequest
- type UserBlacklistRemoveResponse
- type UserBlockPushPeriodData
- type UserBlockPushPeriodDeleteRequest
- type UserBlockPushPeriodDeleteResponse
- type UserBlockPushPeriodGetRequest
- type UserBlockPushPeriodGetResponse
- type UserBlockPushPeriodSetRequest
- type UserBlockPushPeriodSetResponse
- type UserBlockQueryRequest
- type UserBlockQueryResponse
- type UserBlockQueryUser
- type UserBlockRequest
- type UserBlockResponse
- type UserChatFBQueryListRequest
- type UserChatFBQueryListResponse
- type UserChatFBSetRequest
- type UserChatFBSetResponse
- type UserCheckOnlineRequest
- type UserCheckOnlineResponse
- type UserDeactivateQueryRequest
- type UserDeactivateQueryResponse
- type UserDeactivateRequest
- type UserDeactivateResponse
- type UserGetTokenRequest
- type UserGetTokenResponse
- type UserGroupQueryRequest
- type UserGroupQueryResponse
- type UserReactivateRequest
- type UserReactivateResponse
- type UserRefreshRequest
- type UserRefreshResponse
- type UserRemark
- type UserRemarksDelRequest
- type UserRemarksDelResponse
- type UserRemarksGetRequest
- type UserRemarksGetResponse
- type UserRemarksSetRequest
- type UserRemarksSetResponse
- type UserTagBatchSetRequest
- type UserTagBatchSetResponse
- type UserTagSetRequest
- type UserTagSetResponse
- type UserTagsGetRequest
- type UserTagsGetResponse
- type UserTokenExpireRequest
- type UserTokenExpireResponse
- type UserUnBlockRequest
- type UserUnBlockResponse
- type UserWhitelistAddRequest
- type UserWhitelistAddResponse
- type UserWhitelistQueryRequest
- type UserWhitelistQueryResponse
- type UserWhitelistRemoveRequest
- type UserWhitelistRemoveResponse
- type VCMsg
Constants ¶
const ( RCHttpHeaderPrefix = "rc-http-header-" // http header context prefix for inhibiting context conflict RCRequestIdHeader = "X-Request-Id" )
const ( ConversationTypePrivate = "1" // 二人会话 ConversationTypeGroup = "3" // 群组会话 )
const ( // RONGCLOUDSMSURI 融云默认 SMS API 地址 RONGCLOUDSMSURI = "http://api.sms.ronghub.com" // RONGCLOUDURI 融云默认 API 地址 RONGCLOUDURI = "http://api-cn.ronghub.com" // RONGCLOUDURI2 融云备用 API 地址 RONGCLOUDURI2 = "http://api2-cn.ronghub.com" // USERAGENT sdk 名称 USERAGENT = "rc-go-sdk/4.0.0" // DEFAULTTIMEOUT 默认超时时间,10秒 DEFAULTTIMEOUT = 10 * time.Second // DEFAULT_KEEPALIVE http 默认保活时间,30秒 DEFAULT_KEEPALIVE = 30 * time.Second // DEFAULT_MAXIDLECONNSPERHOST http 默认每个域名连接数,100 DEFAULT_MAXIDLECONNSPERHOST = 100 // 自动切换 api 地址时间间隔,秒 DEFAULT_CHANGE_URI_DURATION = 30 )
Variables ¶
var ( // ContextRequestIdKey represent RongCloud http request id, passing to server api ContextRequestIdKey = contextHttpHeaderKey(RCRequestIdHeader) )
Functions ¶
func AddHttpRequestId ¶
func Int64Value ¶
func IsSDKError ¶
func NewEncodeRequestError ¶
NewEncodeRequestError query parse values error help function
func NewSDKError ¶
func StringValue ¶
func WithKeepAlive ¶
WithKeepAlive http client参数, 连接保活时间,最小单位为秒
func WithMaxIdleConnsPerHost ¶
func WithMaxIdleConnsPerHost(n int) rongCloudOption
WithMaxIdleConnsPerHost http client参数, 设置每个域名最大连接数
func WithRongCloudSMSURI ¶
func WithRongCloudSMSURI(rongCloudSMSURI string) rongCloudOption
WithRongCloudSMSURI 设置融云 SMS URI
func WithRongCloudURI ¶
func WithRongCloudURI(rongCloudURI string) rongCloudOption
WithRongCloudURI 设置融云 URI
func WithTimeout ¶
WithTimeout http client参数, 设置超时时间,最小单位为秒
func WithTransport ¶
func WithTransport(transport http.RoundTripper) rongCloudOption
WithTransport 自定义http client Transport, 优先级大于其他http client参数
Types ¶
type CMDMsg ¶
type CMDMsg struct { Name string `json:"name,omitempty"` Data string `json:"data,omitempty"` User *MsgUserInfo `json:"user,omitempty"` }
CMDMsg 命令消息 https://doc.rongcloud.cn/imserver/server/v1/message/objectname-callback#%E5%91%BD%E4%BB%A4%E6%B6%88%E6%81%AF
func (*CMDMsg) ObjectName ¶
type CMDNtf ¶
type CMDNtf struct { Name string `json:"operation,omitempty"` Data string `json:"data,omitempty"` User *MsgUserInfo `json:"user,omitempty"` }
func (*CMDNtf) ObjectName ¶
type ChatroomBanAddRequest ¶
type ChatroomBanAddRequest struct {
ChatroomBanRequest `json:",inline"`
}
type ChatroomBanAddResponse ¶
type ChatroomBanAddResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomBanCheckRequest ¶
type ChatroomBanCheckRequest struct {
ChatroomId *string `json:"chatroomId"` // 要查询的聊天室 ID
}
type ChatroomBanCheckResponse ¶
type ChatroomBanCheckResponse struct { CodeResult Status int `json:"status"` // 禁言状态,1 为全体禁言、0 为非全体禁言 // contains filtered or unexported fields }
type ChatroomBanQueryRequest ¶
type ChatroomBanQueryResponse ¶
type ChatroomBanQueryResponse struct { CodeResult ChatroomIds []string `json:"chatroomIds"` // 被全体禁言的聊天室数组。 // contains filtered or unexported fields }
type ChatroomBanRequest ¶
type ChatroomBanRequest struct { ChatroomId *string `json:"chatroomId"` // [必传] 需要设置为禁言的聊天室 ID。 Extra *string `json:"extra"` // 通知携带的 JSON 格式的扩展信息,仅在 NeedNotify 为 true 时有效。 NeedNotify *bool `json:"needNotify"` // 是否通知成员。默认 false 不通知。如果为 true,客户端会触发相应回调方法(要求 Android/iOS IMLib ≧ 5.4.5;Web IMLib ≧ 5.7.9)。通知范围:指定聊天室中所有成员 }
type ChatroomBanRollbackRequest ¶
type ChatroomBanRollbackRequest struct {
ChatroomBanRequest `json:",inline"`
}
type ChatroomBanRollbackResponse ¶
type ChatroomBanRollbackResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomCreateNewRequest ¶
type ChatroomCreateNewRequest struct { // [必传] 聊天室 ID。 ChatroomId *string `json:"chatroomId"` // 指定聊天室的销毁类型。0:默认值,表示不活跃时销毁。默认情况下,所有聊天室的自动销毁方式均为不活跃时销毁,一旦不活跃长达到 60 分钟即被销毁,可通过 destroyTime 延长该时间。1:固定时间销毁,设置为该类型后,聊天室默认在创建 60 分钟后自动销毁,可通过 destroyTime 设置更长的存活时间。您也可以在聊天室创建成功后再设置,详见设置聊天室销毁类型。 DestroyType *int `json:"destroyType"` // 设置聊天室销毁时间。在 destroyType=0 时,表示聊天室应在不活跃达到该时长时自动销毁。在 destroyType=1 时,表示聊天室应在创建以后存活时间达到该时长后自动销毁。单位为分钟,最小值 60 分钟,最大 10080 分钟(7 天)。如果未设置,默认 60 分钟。 DestroyTime *int `json:"destroyTime"` // 是否禁言聊天室全体成员,默认 false。您也可以在聊天室创建成功后再设置,详见设置聊天室全体禁言。 IsBan *bool `json:"isBan"` // 禁言白名单用户列表,支持批量设置,最多不超过 20 个。您也可以在聊天室创建成功后再设置,详见加入聊天室全体禁言白名单。 WhiteUserIds []string `json:"whiteUserIds"` // 聊天室自定义属性的所属用户 ID。仅在开通聊天室自定义属性服务后可使用该字段,且必须与 entryInfo 字段一起使用。如果未开启服务,或者设置该字段时未同时传入 entryInfo,API 会返回创建失败。仅支持 1 个用户 ID。您也可以在聊天室创建成功后再设置,详见聊天室属性概述。 EntryOwnerId *string `json:"entryOwnerId"` EntryInfo map[string]string `json:"entryInfo"` }
type ChatroomCreateNewResponse ¶
type ChatroomCreateNewResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomDestroyRequest ¶
type ChatroomDestroyRequest struct {
ChatroomIds []string `json:"chatroomIds"` // 要销毁的聊天室的 ID。每次可销毁多个聊天室。
}
type ChatroomDestroyResponse ¶
type ChatroomDestroyResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomDestroySetRequest ¶
type ChatroomDestroySetRequest struct { // [必传] 聊天室 ID。 ChatroomId *string `json:"chatroomId"` // 指定聊天室的销毁类型。0:默认值,表示不活跃时销毁。默认情况下,所有聊天室的自动销毁方式均为不活跃时销毁,一旦不活跃长达到 60 分钟即被销毁,可通过 destroyTime 延长该时间。1:固定时间销毁,设置为该类型后,聊天室默认在创建 60 分钟后自动销毁,可通过 destroyTime 设置更长的存活时间。您也可以在聊天室创建成功后再设置,详见设置聊天室销毁类型。 DestroyType *int `json:"destroyType"` // 设置聊天室销毁时间。在 destroyType=0 时,表示聊天室应在不活跃达到该时长时自动销毁。在 destroyType=1 时,表示聊天室应在创建以后存活时间达到该时长后自动销毁。单位为分钟,最小值 60 分钟,最大 10080 分钟(7 天)。如果未设置,默认 60 分钟。 DestroyTime *int `json:"destroyTime"` }
type ChatroomDestroySetResponse ¶
type ChatroomDestroySetResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomEntry ¶
type ChatroomEntryBatchSetRequest ¶
type ChatroomEntryBatchSetRequest struct { ChatroomId *string `json:"chatroomId"` // 聊天室 ID AutoDelete *int `json:"autoDelete"` // 用户(entryOwnerId)退出聊天室后,是否删除此 Key 值。为 1 时删除此 Key 值和对应的 Value,为 0 时用户退出后不删除,默认为 0。 EntryOwnerId *string `json:"entryOwnerId"` // 聊天室自定义属性的所属用户 ID // 聊天室自定义属性 KV 对,JSON 结构,一次最多 20 个 KV。Key 为属性名,支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式,大小写敏感。最大长度 128 字符。Value 为属性值,最大长度 4096 个字符。 EntryInfo map[string]string `json:"entryInfo"` }
type ChatroomEntryBatchSetResponse ¶
type ChatroomEntryBatchSetResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomEntryQueryResponse ¶
type ChatroomEntryQueryResponse struct { CodeResult Keys []*ChatroomEntry `json:"keys"` // contains filtered or unexported fields }
type ChatroomEntryRemoveRequest ¶
type ChatroomEntryRemoveRequest struct { ChatroomId *string `url:"chatroomId,omitempty"` // [必传] 聊天室 ID。 UserId *string `url:"userId,omitempty"` // [必传] 操作用户 ID。通过 Server API 非聊天室中用户可以进行设置。 Key *string `url:"key,omitempty"` // [必传] 聊天室属性名称,Key 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式,大小写敏感。最大长度 128 字。 RCMsg RCMsg `url:"-"` // 通聊天室属性变化通知消息的消息类型,一般为内置消息类型 ChrmKVNotiMsg,也可以是其他自定义消息类型。如果传入该字段,则在聊天室属性变化时发送一条消息。 }
type ChatroomEntryRemoveResponse ¶
type ChatroomEntryRemoveResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomEntrySetRequest ¶
type ChatroomEntrySetRequest struct { ChatroomId *string `url:"chatroomId,omitempty"` // [必传] 聊天室 ID UserId *string `url:"userId,omitempty"` // [必传] 操作用户 ID。通过 Server API 非聊天室中用户可以进行设置。 Key *string `url:"key,omitempty"` // [必传] 聊天室属性名称,Key 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式,大小写敏感。最大长度 128 字符。每个聊天室中,最多允许设置 100 个属性 Key-Value 对。 Value *string `url:"value,omitempty"` // [必传] 聊天室属性对应的值,最大长度 4096 个字符。 AutoDelete *int `url:"autoDelete,omitempty"` // 属性的操作用户退出聊天室后,是否删除此 Key 值。为 1 时删除此 Key 值和对应的 Value,为 0 时用户退出后不删除,默认为 0。 RCMsg RCMsg `url:"-"` // 聊天室属性变化通知消息的消息类型,一般为内置消息类型 RC:chrmKVNotiMsg,也可以是其他自定义消息类型。如果传入该字段,则在聊天室属性变化时发送一条消息。 }
type ChatroomEntrySetResponse ¶
type ChatroomEntrySetResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomGetRequest ¶
type ChatroomGetRequest struct {
ChatroomId *string `json:"chatroomId"` // [必传] 聊天室 ID
}
type ChatroomGetResponse ¶
type ChatroomGetResponse struct { CodeResult ChatroomId string `json:"chatroomId"` // 聊天室 ID CreateTime int64 `json:"createTime"` // 聊天室创建时间 MemberCount int `json:"memberCount"` // 聊天室当前人数 DestroyType int `json:"destroyType"` // 指定聊天室的销毁方式。0:默认值,表示不活跃时销毁。默认情况下,所有聊天室的自动销毁方式均为不活跃时销毁,一旦不活跃长达到 60 分钟即被销毁,可通过 destroyTime 延长该时间。1:固定时间销毁,设置为该类型后,聊天室默认在创建 60 分钟后自动销毁,可通过 destroyTime 设置更长的存活时间。 DestroyTime int `json:"destroyTime"` // 设置聊天室销毁等待时间。在 destroyType=0 时,表示聊天室应在不活跃达到该时长时自动销毁。在 destroyType=1 时,表示聊天室应在创建以后存活时间达到该时长后自动销毁。单位为分钟,最小值 60 分钟,最大 10080 分钟(7 天)。 IsBan bool `json:"ban"` // 是否已开启聊天室全体禁言,默认 false。 // contains filtered or unexported fields }
type ChatroomKeepaliveAddRequest ¶
type ChatroomKeepaliveAddRequest struct {
ChatroomId *string `json:"chatroomId"` // [必传]聊天室 ID。
}
type ChatroomKeepaliveAddResponse ¶
type ChatroomKeepaliveAddResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomKeepaliveQueryRequest ¶
type ChatroomKeepaliveQueryRequest struct { }
type ChatroomKeepaliveQueryResponse ¶
type ChatroomKeepaliveQueryResponse struct { CodeResult ChatroomIds []string `json:"chatroomIds,omitempty"` // 保活聊天室数组。 // contains filtered or unexported fields }
type ChatroomKeepaliveRemoveRequest ¶
type ChatroomKeepaliveRemoveRequest struct {
ChatroomId *string `json:"chatroomId"` // [必传]聊天室 ID。
}
type ChatroomKeepaliveRemoveResponse ¶
type ChatroomKeepaliveRemoveResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomMessagePriorityAddRequest ¶
type ChatroomMessagePriorityAddRequest struct {
ObjectNames []string `json:"objectNames"` // 低优先级的消息类型,每次最多提交 5 个,设置的消息类型最多不超过 20 个。
}
type ChatroomMessagePriorityAddResponse ¶
type ChatroomMessagePriorityAddResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomMessagePriorityQueryRequest ¶
type ChatroomMessagePriorityQueryRequest struct { }
type ChatroomMessagePriorityQueryResponse ¶
type ChatroomMessagePriorityQueryResponse struct { CodeResult ObjectNames []string `json:"objectNames"` // 消息类型数组。 // contains filtered or unexported fields }
type ChatroomMessagePriorityRemoveRequest ¶
type ChatroomMessagePriorityRemoveRequest struct {
ObjectNames []string `json:"objectNames"` // 低优先级的消息类型,每次最多提交 5 个
}
type ChatroomMessagePriorityRemoveResponse ¶
type ChatroomMessagePriorityRemoveResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomUserBanAddRequest ¶
type ChatroomUserBanAddRequest struct { UserIds []string `json:"userIds"` // [必传]用户 ID,可同时禁言多个用户,每次最多不超过 20 个。 Minute *int `json:"minute"` // [必传]禁言时长,以分钟为单位,最大值为 43200 分钟。 Extra *string `json:"extra"` // 通知携带的 JSON 格式的扩展信息,仅在 needNotify 为 true 时有效。 NeedNotify *bool `json:"needNotify"` // 是否通知成员。默认 false 不通知。如果为 true,客户端会触发相应回调方法(要求 Android/iOS IMLib ≧ 5.4.5;Web IMLib ≧ 5.7.9)。通知范围:指定聊天室中所有成员。 }
type ChatroomUserBanAddResponse ¶
type ChatroomUserBanAddResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomUserBanQueryRequest ¶
type ChatroomUserBanQueryRequest struct { }
type ChatroomUserBanQueryResponse ¶
type ChatroomUserBanQueryResponse struct { CodeResult Users []ChatroomUserBlockUser `json:"users"` // contains filtered or unexported fields }
type ChatroomUserBanRemoveRequest ¶
type ChatroomUserBanRemoveRequest struct { UserIds []string `json:"userIds"` // [必传]用户 ID,可同时移除多个用户,每次最多不超过 20 个。 Extra *string `json:"extra"` // 通知携带的 JSON 格式的扩展信息,仅在 needNotify 为 true 时有效。 NeedNotify *bool `json:"needNotify"` // 是否通知成员。默认 false 不通知。如果为 true,客户端会触发相应回调方法(要求 Android/iOS IMLib ≧ 5.4.5;Web IMLib ≧ 5.7.9)。通知范围:被解除全局禁言的用户。 }
type ChatroomUserBanRemoveResponse ¶
type ChatroomUserBanRemoveResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomUserBanWhiteListAddResponse ¶
type ChatroomUserBanWhiteListAddResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomUserBanWhiteListRollbackResponse ¶
type ChatroomUserBanWhiteListRollbackResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomUserBanWhitelistAddRequest ¶
type ChatroomUserBanWhitelistAddRequest struct {
ChatroomUserBanWhitelistRequest `json:",inline"`
}
type ChatroomUserBanWhitelistQueryRequest ¶
type ChatroomUserBanWhitelistQueryRequest struct {
ChatroomId *string `json:"chatroomId"` // [必传] 聊天室 ID
}
type ChatroomUserBanWhitelistQueryResponse ¶
type ChatroomUserBanWhitelistQueryResponse struct { CodeResult UserIds []string `json:"userIds"` // 聊天室中白名单用户数组。 // contains filtered or unexported fields }
type ChatroomUserBanWhitelistRequest ¶
type ChatroomUserBanWhitelistRequest struct { ChatroomId *string `json:"chatroomId"` // [必传] 聊天室 ID UserIds []string `json:"userId"` // [必传] 需要添加到白名单中的用户 ID,白名单中用户上限为 20 个,支持批量添加,单次添加上限不超过 20 个。 Extra *string `json:"extra"` // 通知携带的 JSON 格式的扩展信息,仅在 NeedNotify 为 true 时有效。 NeedNotify *bool `json:"needNotify"` // 是否通知成员。默认 false 不通知。如果为 true,客户端会触发相应回调方法(要求 Android/iOS IMLib ≧ 5.4.5;Web IMLib ≧ 5.7.9)。通知范围:指定聊天室中所有成员 }
type ChatroomUserBanWhitelistRollbackRequest ¶
type ChatroomUserBanWhitelistRollbackRequest struct {
ChatroomUserBanWhitelistRequest `json:",inline"`
}
type ChatroomUserBlockAddRequest ¶
type ChatroomUserBlockAddRequest struct { UserIds []string `json:"userIds"` // [必传]用户 ID,可同时封禁多个用户,最多不超过 20 个。 ChatroomId *string `json:"chatroomId"` // [必传] 聊天室 ID。 Minute *int `json:"minute"` // [必传] 封禁时长,以分钟为单位,最大值为43200分钟。 Extra *string `json:"extra"` // 通知携带的 JSON 格式的扩展信息,仅在 needNotify 为 true 时有效。 NeedNotify *bool `json:"needNotify"` // 是否通知成员。默认 false 不通知。如果为 true,客户端会触发相应回调方法(要求 Android/iOS IMLib ≧ 5.4.5;Web IMLib ≧ 5.7.9)。通知范围:聊天室中所有成员,包括被封禁用户。 }
type ChatroomUserBlockAddResponse ¶
type ChatroomUserBlockAddResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomUserBlockListRequest ¶
type ChatroomUserBlockListRequest struct {
ChatroomId *string `json:"chatroomId"` // [必传]聊天室 ID
}
type ChatroomUserBlockListResponse ¶
type ChatroomUserBlockListResponse struct { CodeResult Users []*ChatroomUserBlockUser `json:"users"` // 被封禁用户数组。 // contains filtered or unexported fields }
type ChatroomUserBlockRollbackRequest ¶
type ChatroomUserBlockRollbackRequest struct { UserIds []string `json:"userIds"` // [必传] 用户 ID,可同时移除多个用户,最多不超过 20 个。 ChatroomId *string `json:"chatroomId"` // [必传] 聊天室 ID。 Extra *string `json:"extra"` // 通知携带的 JSON 格式的扩展信息,仅在 needNotify 为 true 时有效。 NeedNotify *bool `json:"needNotify"` // 是否通知成员。默认 false 不通知。如果为 true,客户端会触发相应回调方法(要求 Android/iOS IMLib ≧ 5.4.5;Web IMLib ≧ 5.7.9)。通知范围:被解除封禁的成员。 }
type ChatroomUserBlockRollbackResponse ¶
type ChatroomUserBlockRollbackResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomUserBlockUser ¶
type ChatroomUserExistResponse ¶
type ChatroomUserExistResponse struct { CodeResult // 用户是否在聊天室中,true 表示在聊天室中,false 表示不在聊天室中。 IsInChrm bool `json:"isInChrm"` // contains filtered or unexported fields }
type ChatroomUserExistResult ¶
type ChatroomUserGagAddRequest ¶
type ChatroomUserGagAddRequest struct { UserIds []string `json:"userIds"` // [必传]用户 ID,可同时禁言多个用户,最多不超过 20 个。 ChatroomId *string `json:"chatroomId"` // [必传]聊天室 ID。 Minute *int `json:"minute"` // [必传]禁言时长,以分钟为单位,最大值为 43200 分钟。 Extra *string `json:"extra"` // 通知携带的 JSON 格式的扩展信息,仅在 needNotify 为 true 时有效。 NeedNotify *bool `json:"needNotify"` // 是否通知成员。默认 false 不通知。如果为 true,客户端会触发相应回调方法(要求 Android/iOS IMLib ≧ 5.4.5;Web IMLib ≧ 5.7.9)。通知范围:指定聊天室中所有成员。 }
type ChatroomUserGagAddResponse ¶
type ChatroomUserGagAddResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomUserGagListRequest ¶
type ChatroomUserGagListRequest struct {
ChatroomId *string `json:"chatroomId"` // [必传]聊天室 ID。
}
type ChatroomUserGagListResponse ¶
type ChatroomUserGagListResponse struct { CodeResult Users []*ChatroomUserBlockUser `json:"users"` // 被禁言用户数组。 // contains filtered or unexported fields }
type ChatroomUserGagRollbackRequest ¶
type ChatroomUserGagRollbackRequest struct { UserIds []string `json:"userIds"` // [必传]用户 ID,可同时移除多个用户,最多不超过 20 个。 ChatroomId *string `json:"chatroomId"` // [必传]聊天室 ID。 Extra *string `json:"extra"` // 通知携带的 JSON 格式的扩展信息,仅在 needNotify 为 true 时有效。 NeedNotify *bool `json:"needNotify"` // 是否通知成员。默认 false 不通知。如果为 true,客户端会触发相应回调方法(要求 Android/iOS IMLib ≧ 5.4.5;Web IMLib ≧ 5.7.9)。通知范围:指定聊天室中所有成员。 }
type ChatroomUserGagRollbackResponse ¶
type ChatroomUserGagRollbackResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomUserQueryResponse ¶
type ChatroomUserQueryResponse struct { CodeResult Total int `json:"total"` Users []string `json:"users"` Id string `json:"id"` Time string `json:"time"` // contains filtered or unexported fields }
type ChatroomUserWhitelistAddResponse ¶
type ChatroomUserWhitelistAddResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomUserWhitelistQueryRequest ¶
type ChatroomUserWhitelistQueryRequest struct {
ChatroomId *string `json:"chatroomId"` // [必传] 聊天室 ID。
}
type ChatroomUserWhitelistQueryResponse ¶
type ChatroomUserWhitelistQueryResponse struct { CodeResult Users []string `json:"users"` // 白名单用户数组。 // contains filtered or unexported fields }
type ChatroomUserWhitelistRemoveResponse ¶
type ChatroomUserWhitelistRemoveResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomUsersExistResponse ¶
type ChatroomUsersExistResponse struct { CodeResult Result []*ChatroomUserExistResult `json:"result"` // contains filtered or unexported fields }
type ChatroomWhitelistAddRequest ¶
type ChatroomWhitelistAddRequest struct {
ObjectNames []string `json:"objectnames"` // [必传] 消息标识,最多不超过 20 个,自定义消息类型,长度不超过 32 个字符
}
type ChatroomWhitelistAddResponse ¶
type ChatroomWhitelistAddResponse struct { CodeResult // contains filtered or unexported fields }
type ChatroomWhitelistQueryRequest ¶
type ChatroomWhitelistQueryRequest struct { }
type ChatroomWhitelistQueryResponse ¶
type ChatroomWhitelistQueryResponse struct { CodeResult WhitelistMsgType []string `json:"whitlistMsgType"` // 消息类型数组。 // contains filtered or unexported fields }
type ChatroomWhitelistRemoveRequest ¶
type ChatroomWhitelistRemoveRequest struct {
ObjectNames []string `json:"objectnames"` // [必传] 消息标识,最多不超过 20 个,自定义消息类型,长度不超过 32 个字符
}
type ChatroomWhitelistRemoveResponse ¶
type ChatroomWhitelistRemoveResponse struct { CodeResult // contains filtered or unexported fields }
type ChrmKVNotiMsg ¶
type ChrmKVNotiMsg struct { // [必传] 聊天室中对属性操作后发送通知的类型,1 为设置属性内容、2 为删除属性内容。 Type int `json:"type,omitempty"` // [必传] 聊天室中属性名称,大小不超过 128 个字符。 Key string `json:"key,omitempty"` // [必传] 属性对应的内容,大小不超过 4096 个字符。 Value string `json:"value,omitempty"` // 通过消息中携带的附加信息,对应到设置属性接口中的 notificationExtra 值。 Extra string `json:"extra,omitempty"` }
ChrmKVNotiMsg 聊天室属性通知消息 https://doc.rongcloud.cn/imserver/server/v1/message/objectname-callback#%E8%81%8A%E5%A4%A9%E5%AE%A4%E5%B1%9E%E6%80%A7%E9%80%9A%E7%9F%A5%E6%B6%88%E6%81%AF
func (*ChrmKVNotiMsg) ObjectName ¶
func (m *ChrmKVNotiMsg) ObjectName() string
func (*ChrmKVNotiMsg) ToString ¶
func (m *ChrmKVNotiMsg) ToString() (string, error)
type CodeResult ¶
type CodeResult struct { Code int `json:"code"` // 返回码,200 为正常。 ErrorMessage string `json:"errorMessage,omitempty"` // 错误信息 }
CodeResult 融云返回状态码和错误码
type ContactNtf ¶
type ContactNtf struct { Operation string `json:"operation,omitempty"` // [必传]联系人操作的指令,官方针对 operation 属性定义了 "Request", "AcceptResponse", "RejectResponse" 几个常量,也可以由开发者自行扩展。 SourceUserID string `json:"sourceUserId,omitempty"` // [必传]发出通知的用户 Id。 TargetUserID string `json:"targetUserId,omitempty"` // [必传]单聊会话为接收通知的用户 Id,群聊、聊天室会话为会话 Id。 Message string `json:"message,omitempty"` // [必传]表示请求或者响应消息,如添加理由或拒绝理由。 Extra string `json:"extra,omitempty"` User *MsgUserInfo `json:"user,omitempty"` }
ContactNtf 联系人(好友)通知消息 https://doc.rongcloud.cn/imserver/server/v1/message/objectname-notification#%E8%81%94%E7%B3%BB%E4%BA%BA%E5%A5%BD%E5%8F%8B%E9%80%9A%E7%9F%A5%E6%B6%88%E6%81%AF
func (*ContactNtf) ObjectName ¶
func (m *ContactNtf) ObjectName() string
func (*ContactNtf) ToString ¶
func (m *ContactNtf) ToString() (string, error)
type ConversationNotificationGetRequest ¶
type ConversationNotificationGetRequest struct { // [必传] 会话类型。支持的会话类型包括:1(二人会话)、3(群组会话)、6(系统会话)、10(超级群会话)。如需查询超级群指定频道的免打扰设置,请传入频道 ID(busChannel)。 ConversationType *int `url:"conversationType,omitempty"` // [必传] 设置消息免打扰的用户 ID。 RequestId *string `url:"requestId,omitempty"` // [必传] 目标 ID,根据不同的会话类型(ConversationType),可能是用户 ID、群组 ID。 TargetId *string `url:"targetId,omitempty"` // 超级群的会话频道 ID。 // 如果传入频道 ID,则查询该频道的消息免打扰级别。 // 注意:如果不指定频道 ID,则查询指定超级群会话(targetId)中不属于任何频道的消息的免打扰状态级别。 BusChannel *string `url:"busChannel,omitempty"` }
type ConversationNotificationGetResponse ¶
type ConversationNotificationGetResponse struct { CodeResult // 消息免打扰设置状态。 // -1: 全部消息通知 // 0: 未设置(用户未设置情况下,默认以群 或者 APP级别的默认设置为准,如未设置则全部消息都通知) // 1: 仅针对 @ 消息进行通知 // 2: 仅针对 @ 指定用户进行通知 // 4: 仅针对 @ 群全员进行通知。 // 5: 不接收通知 IsMuted int `json:"isMuted"` // contains filtered or unexported fields }
type ConversationNotificationSetRequest ¶
type ConversationNotificationSetRequest struct { // [必传] 会话类型。支持的会话类型包括:1(二人会话)、3(群组会话)、6(系统会话)、10(超级群会话)。 ConversationType *int `url:"conversationType,omitempty"` // [必传] 设置消息免打扰的用户 ID。 RequestId *string `url:"requestId,omitempty"` // [必传] 目标 ID,根据不同的会话类型(ConversationType),可能是用户 ID、群组 ID、超级群 ID 等。 TargetId *string `url:"targetId,omitempty"` // 消息免打扰设置状态,0 表示关闭,1 表示开启。 // 该字段已废弃,推荐使用 unpushLevel。isMuted 与 unpushLevel 只需要传一个。如果都传,使用 unpushLevel。 // Deprecated IsMuted *int `url:"isMuted,omitempty"` // 超级群的会话频道 ID。 // 如果传入频道 ID,则针对该指定频道设置消息免打扰级别。 // 注意:2022.09.01 之前开通超级群业务的客户,如果不指定频道 ID,则默认传 "" 空字符串,即仅针对指定超级群会话(targetId)中不属于任何频道的消息设置免打扰状态级别。如需修改请提交工单。 BusChannel *string `url:"busChannel,omitempty"` // -1: 全部消息通知 // 0: 未设置(用户未设置情况下,默认以群 或者 APP级别的默认设置为准,如未设置则全部消息都通知) // 1: 仅针对 @ 消息进行通知 // 2: 仅针对 @ 指定用户进行通知 // 如:@张三 则张三可以收到推送,@所有人 时不会收到推送。 // 4: 仅针对 @ 群全员进行通知,只接收 @所有人 的推送信息。 // 5: 不接收通知 UnpushLevel *int `url:"unpushLevel,omitempty"` }
type ConversationNotificationSetResponse ¶
type ConversationNotificationSetResponse struct { CodeResult // contains filtered or unexported fields }
type ConversationTopSetRequest ¶
type ConversationTopSetRequest struct { // [必传] 用户 ID,会话所属的用户 UserId *string `url:"userId,omitempty"` // [必传] 会话类型。支持的会话类型包括:1(二人会话)、3(群组会话)、6(系统会话)、10(超级群会话)。 ConversationType *int `url:"conversationType,omitempty"` // [必传] 需要设置的目标 ID,根据会话类型不同为单聊用户 ID、群聊 ID、系统目标 ID TargetId *string `url:"targetId,omitempty"` // [必传] true 表示置顶,false 表示取消置顶。 SetTop *bool `url:"setTop,omitempty"` }
type ConversationTopSetResponse ¶
type ConversationTopSetResponse struct { CodeResult // contains filtered or unexported fields }
type ConversationTypeNotificationGetResponse ¶
type ConversationTypeNotificationGetResponse struct { CodeResult // -1: 全部消息通知 // 0: 未设置(用户未设置情况下,默认以群 或者 APP级别的默认设置为准,如未设置则全部消息都通知) // 1: 仅针对 @ 消息进行通知 // 2: 仅针对 @ 指定用户进行通知 // 4: 仅针对 @ 群全员进行通知。 // 5: 不接收通知 IsMuted int `json:"isMuted"` // contains filtered or unexported fields }
type ConversationTypeNotificationSetRequest ¶
type ConversationTypeNotificationSetRequest struct { // [必传] 会话类型。支持的会话类型包括:1(二人会话)、3(群组会话)、6(系统会话)、10(超级群会话)。 ConversationType *int `url:"conversationType,omitempty"` // [必传] 设置消息免打扰的用户 ID。 RequestId *string `url:"requestId,omitempty"` // [必传] -1: 全部消息通知 //0: 未设置(用户未设置情况下,默认以群或者 APP 级别的默认设置为准,如未设置则全部消息都通知) //1: 仅针对 @ 消息进行通知 //2: 仅针对 @ 指定用户进行通知 //如:@张三 则张三可以收到推送,@所有人 时不会收到推送。 //4: 仅针对 @ 群全员进行通知,只接收 @所有人 的推送信息。 //5: 不接收通知 UnpushLevel *int `url:"unpushLevel,omitempty"` }
type ConversationTypeNotificationSetResponse ¶
type ConversationTypeNotificationSetResponse struct { CodeResult // contains filtered or unexported fields }
type FileMsg ¶
type FileMsg struct { Name string `json:"name,omitempty"` // 文件名称。如不传,调用客户端 SDK 中的 downloadMediaMessage 方法下载后会默认生成一个名称。 Size string `json:"size,omitempty"` // [必传参数] 文件大小,单位:Byte。 Type string `json:"type,omitempty"` // [必传参数] 文件类型 FileURL string `json:"fileUrl,omitempty"` // [必传参数] 文件的服务器地址。通过 IM Server API 发送文件消息时,需要自行上传文件到应用的文件服务器,生成文件地址后进行发送。 User *MsgUserInfo `json:"user,omitempty"` }
FileMsg 文件消息 https://doc.rongcloud.cn/imserver/server/v1/message/objectname#%E6%96%87%E4%BB%B6%E6%B6%88%E6%81%AF
func (*FileMsg) ObjectName ¶
type GroupBanAddRequest ¶
type GroupBanAddRequest struct { // [必传] 群组 ID,支持一次设置多个,最多不超过 20 个。 GroupIds []string `url:"groupId,omitempty"` }
type GroupBanAddResponse ¶
type GroupBanAddResponse struct { CodeResult // contains filtered or unexported fields }
type GroupBanQueryGroupInfo ¶
type GroupBanQueryRequest ¶
type GroupBanQueryRequest struct { // 群组 ID。单次可查询指定单个或多个群组,单次查询最多不超过 20 个群组。不传时,表示查询所有设置禁言的群组列表。 GroupIds []string `url:"groupId,omitempty"` }
type GroupBanQueryResponse ¶
type GroupBanQueryResponse struct { CodeResult GroupInfo []GroupBanQueryGroupInfo `json:"groupinfo"` // 禁言群组信息数据。 // contains filtered or unexported fields }
type GroupBanRollbackRequest ¶
type GroupBanRollbackRequest struct { // [必传] 群组 ID,支持一次设置多个,最多不超过 20 个。 GroupIds []string `url:"groupId,omitempty"` }
type GroupBanRollbackResponse ¶
type GroupBanRollbackResponse struct { CodeResult // contains filtered or unexported fields }
type GroupCreateRequest ¶
type GroupCreateRequest struct { // [必传] 要加入群的用户 ID,最多不超过 1000 个。 UserId []string `url:"userId,omitempty"` // [必传] 创建群组 ID,最大长度 64 个字符。支持大小写英文字母与数字的组合。 GroupId *string `url:"groupId,omitempty"` // [必传] 群组 ID 对应的名称,用于在发送群组消息显示远程 Push 通知时使用,如群组名称改变需要调用刷新群组信息接口同步。 GroupName *string `url:"groupName,omitempty"` }
type GroupCreateResponse ¶
type GroupCreateResponse struct { CodeResult // contains filtered or unexported fields }
type GroupDismissRequest ¶
type GroupDismissResponse ¶
type GroupDismissResponse struct { CodeResult // contains filtered or unexported fields }
type GroupJoinRequest ¶
type GroupJoinResponse ¶
type GroupJoinResponse struct { CodeResult // contains filtered or unexported fields }
type GroupQuitRequest ¶
type GroupQuitResponse ¶
type GroupQuitResponse struct { CodeResult // contains filtered or unexported fields }
type GroupRefreshRequest ¶
type GroupRefreshResponse ¶
type GroupRefreshResponse struct { CodeResult // contains filtered or unexported fields }
type GroupRemarksDelRequest ¶
type GroupRemarksDelResponse ¶
type GroupRemarksDelResponse struct { CodeResult // contains filtered or unexported fields }
type GroupRemarksGetRequest ¶
type GroupRemarksGetResponse ¶
type GroupRemarksGetResponse struct { CodeResult Remark string `json:"remark"` // 备注名称。 // contains filtered or unexported fields }
type GroupRemarksSetRequest ¶
type GroupRemarksSetResponse ¶
type GroupRemarksSetResponse struct { CodeResult // contains filtered or unexported fields }
type GroupSyncRequest ¶
type GroupSyncRequest struct { // [必传] 被同步群信息的用户 ID。 UserId *string `url:"userId,omitempty"` // 该用户所属的群信息,如群组 ID 已经存在,则同时刷新对应群组名称。此参数可传多个,参见下面示例。 Groups SyncGroups `url:"group,omitempty"` }
type GroupSyncResponse ¶
type GroupSyncResponse struct { CodeResult // contains filtered or unexported fields }
type GroupUserBanWhitelistAddResponse ¶
type GroupUserBanWhitelistAddResponse struct { CodeResult // contains filtered or unexported fields }
type GroupUserBanWhitelistQueryRequest ¶
type GroupUserBanWhitelistQueryRequest struct { // [必传] 群组 ID。 GroupId *string `url:"groupId,omitempty"` }
type GroupUserBanWhitelistQueryResponse ¶
type GroupUserBanWhitelistQueryResponse struct { CodeResult UserIds []string `json:"userIds"` // contains filtered or unexported fields }
type GroupUserBanWhitelistRollbackResponse ¶
type GroupUserBanWhitelistRollbackResponse struct { CodeResult // contains filtered or unexported fields }
type GroupUserGagAddRequest ¶
type GroupUserGagAddResponse ¶
type GroupUserGagAddResponse struct { CodeResult // contains filtered or unexported fields }
type GroupUserGagListRequest ¶
type GroupUserGagListRequest struct { // 群组 ID,为空时则设置用户在加入的所有群组中都不能发送消息。 GroupId *string `url:"groupId,omitempty"` }
type GroupUserGagListResponse ¶
type GroupUserGagListResponse struct { CodeResult Users []*GagUser `json:"users"` // 禁言成员列表。 // contains filtered or unexported fields }
type GroupUserGagRollbackResponse ¶
type GroupUserGagRollbackResponse struct { CodeResult // contains filtered or unexported fields }
type GroupUserQueryRequest ¶
type GroupUserQueryRequest struct {
GroupId *string `url:"groupId,omitempty"`
}
type GroupUserQueryResponse ¶
type GroupUserQueryResponse struct { CodeResult Users []*GroupUser `json:"users"` // 群成员数组。 // contains filtered or unexported fields }
type GrpNtf ¶
type GrpNtf struct { OperatorUserID string `json:"operatorUserId,omitempty"` // [必传] 操作人用户 Id Operation string `json:"operation,omitempty"` // [必传] 群组中各种通知的操作名称。 Data string `json:"data,omitempty"` // [必传] 操作数据 Message string `json:"message,omitempty"` // [必传] 消息内容 Extra string `json:"extra,omitempty"` User *MsgUserInfo `json:"user,omitempty"` }
func (*GrpNtf) ObjectName ¶
type HQVCMsg ¶
type HQVCMsg struct { RemoteUrl string `json:"remoteUrl,omitempty"` // 必传参数, 媒体内容上传服务器后的网络地址。通过 IM 服务端 API 发送高质量语音消息时,需要自行生成 AAC 格式文件并上传文件到应用的文件服务器,生成地址后进行发送。 Duration int `json:"duration,omitempty"` // 必传参数, 语音消息的时长,最长为 60 秒(单位:秒)。 User *MsgUserInfo `json:"user,omitempty"` Extra string `json:"extra,omitempty"` // 扩展信息,可以放置任意的数据内容,也可以去掉此属性。 }
func (*HQVCMsg) ObjectName ¶
type IMGTextMsg ¶
type IMGTextMsg struct { Title string `json:"title,omitempty"` // 消息的标题。 Content string `json:"content,omitempty"` // 消息的文字内容。 User *MsgUserInfo `json:"user,omitempty"` Extra string `json:"extra,omitempty"` ImageUri string `json:"imageUri,omitempty"` // 消息中图片地址,图片尺寸为:120 x 120 像素。通过 IM Server API 发送图片消息时,需要自行上传文件到应用的文件服务器,生成图片地址后进行发送。 URL string `json:"url,omitempty"` // 点击图片消息后跳转的 URL 地址。 }
IMGTextMsg 图文消息 https://doc.rongcloud.cn/imserver/server/v1/message/objectname#%E5%9B%BE%E6%96%87%E6%B6%88%E6%81%AF%E5%86%85%E5%AE%B9%E7%BB%93%E6%9E%84%E4%BD%93
func (*IMGTextMsg) ObjectName ¶
func (m *IMGTextMsg) ObjectName() string
func (*IMGTextMsg) ToString ¶
func (m *IMGTextMsg) ToString() (string, error)
type ImgMsg ¶
type ImgMsg struct { Content string `json:"content,omitempty"` // [必传] 图片缩略图进行 Base64 编码的结果值。Base64 字符串长度建议为 5k,最大不超过 10k。注意在 Base64 进行 Encode 后需要将所有 \r\n 和 \r 和 \n 替换成空。 User *MsgUserInfo `json:"user,omitempty"` // 消息中携带的消息发送者的用户信息。一般情况下不建议在消息中携带用户信息。建议仅在直播场景下使用。 ImageURI string `json:"imageUri,omitempty"` // [必传] 图片上传到图片存储服务器后的地址。通过 IM Server API 发送图片消息时,需要自行上传文件到应用的文件服务器,生成图片地址后进行发送。 Extra string `json:"extra,omitempty"` }
ImgMsg 消息
func (*ImgMsg) ObjectName ¶
type InfoNtf ¶
type InfoNtf struct { Message string `json:"message,omitempty"` User *MsgUserInfo `json:"user,omitempty"` Extra string `json:"extra,omitempty"` }
InfoNtf 提示(小灰条)通知消息 https://doc.rongcloud.cn/imserver/server/v1/message/objectname-notification
func (*InfoNtf) ObjectName ¶
type LBSMsg ¶
type LBSMsg struct { Content string `json:"content,omitempty"` Extra string `json:"extra,omitempty"` POI string `json:"poi,omitempty"` Latitude float64 `json:"latitude,omitempty"` Longitude float64 `json:"longitude,omitempty"` User *MsgUserInfo `json:"user,omitempty"` }
LBSMsg 位置消息 https://doc.rongcloud.cn/imserver/server/v1/message/objectname#%E4%BD%8D%E7%BD%AE%E6%B6%88%E6%81%AF
func (*LBSMsg) ObjectName ¶
type MessageBroadcastRequest ¶
type MessageBroadcastRequest struct { // [必传] 发送人用户 ID。 // 注意:发送消息所使用的用户 ID 必须已获取过用户 Token,否则消息一旦触发离线推送,通知内无法正确显示发送者的用户信息。 FromUserId *string `url:"fromUserId,omitempty"` // [必传] 消息类型参数的SDK封装, 例如: TXTMsg(文本消息), HQVCMsg(高清语音消息) RCMsg RCMsg `url:"-"` // 指定收件人离线时触发的远程推送通知中的通知内容。注意:对于部分消息类型,该字段是否有值决定了是否触发远程推送通知。 // 如果消息类型(objectName 字段)为即时通讯服务预定义消息类型中的用户内容类消息格式,可不填写该字段,远程推送通知默认使用服务端预置的推送通知内容。 // 如果消息类型(objectName 字段)为即时通讯服务预定义消息类型中通知类、信令类("撤回命令消息" 除外),且需要支持远程推送通知,则必须填写 pushContent,否则收件人不在线时无法收到远程推送通知。如无需触发远程推送,可不填该字段。 // 如果消息类型为自定义消息类型,且需要支持远程推送通知,则必须填写 pushContent 字段,否则收件人不在线时无法收到远程推送通知。 // 如果消息类型为自定义消息类型,但不需要支持远程推送通知(例如通过自定义消息类型实现的 App 业务层操作指令),可将 pushContent 字段留空禁用远程推送通知。 PushContent *string `url:"pushContent,omitempty"` // iOS 平台收到推送消息时,可从 payload 中获取 APNs 推送数据,对应字段名为 appData(提示:rc 字段中默认携带了消息基本信息)。Android 平台收到推送消息时对应字段名为 appData。 PushData *string `url:"pushData,omitempty"` // 针对 iOS 平台,对 SDK 处于后台暂停状态时为静默推送,是 iOS7 之后推出的一种推送方式。 允许应用在收到通知后在后台运行一段代码,且能够马上执行。详情请查看知识库文档。1 表示为开启,0 表示为关闭,默认为 0 ContentAvailable *int `url:"contentAvailable,omitempty"` // 配置消息的推送通知,如推送通知的标题等。disablePush 属性为 true 时此属性无效。具体请查看下方 pushExt 参数说明。json string PushExt *string `url:"pushExt,omitempty"` }
type MessageBroadcastResponse ¶
type MessageBroadcastResponse struct { CodeResult // contains filtered or unexported fields }
type MessageChatroomBroadcastRequest ¶
type MessageChatroomBroadcastRequest struct { // [必传] 发送人用户 ID。 FromUserId *string `url:"fromUserId,omitempty"` // [必传] 消息类型参数的SDK封装, 例如: TXTMsg(文本消息) RCMsg RCMsg `url:"-"` // 是否向发件人客户端同步已发消息。1 表示同步,默认值为 0,即不同步。注意,仅设置该参数无法确保发件人客户端一定能获取到该条已发消息,您可能还需要启用其他服务。详见发件人客户端如何同步已发消息。 IsIncludeSender *int `url:"isIncludeSender,omitempty"` }
type MessageChatroomBroadcastResponse ¶
type MessageChatroomBroadcastResponse struct { CodeResult // contains filtered or unexported fields }
type MessageChatroomPublishRequest ¶
type MessageChatroomPublishRequest struct { // [必传] 发送人用户 ID。 FromUserId *string `url:"fromUserId,omitempty"` // [必传] 接收聊天室 ID,提供多个本参数可以实现向多个聊天室发送消息,建议最多不超过 10 个聊天室。 ToChatroomId []string `url:"toChatroomId,omitempty"` // [必传] 消息类型参数的SDK封装, 例如: TXTMsg(文本消息) RCMsg RCMsg `url:"-"` // 是否需要为收件人在历史消息云端存储服务中存储此条消息。0 表示不存储;1 表示存储。默认值为 1,存储(依赖聊天室消息云端存储服务)。 // 一般情况下(第 1、2 种情况),客户端是否存储消息不依赖此参数。以下第 3 种情况属于例外: // 如果消息属于内置消息类型,客户端 SDK 会根据消息类型本身的存储属性标识判断是否存入本地数据库。详见消息类型概述。 // 如果消息属于自定义消息类型,则客户端 SDK 会根据该类型在客户端上注册时的存储属性标识判断是否需要存入本地数据库。 // 如果消息属于客户端 App 上未注册自定义消息类型(例如客户端使用的 App 版本过旧),则客户端 SDK 会根据当前参数值确定是否将消息存储在本地。但因消息类型未注册,客户端无法解析显示该消息。 // 注意:客户端会在用户退出聊天室时自动清除本地的聊天室历史消息记录。 IsPersisted *int `url:"isPersisted,omitempty"` // 是否向发件人客户端同步已发消息。1 表示同步,默认值为 0,即不同步。注意,仅设置该参数无法确保发件人客户端一定能获取到该条已发消息,您可能还需要启用其他服务。详见发件人客户端如何同步已发消息。 IsIncludeSender *int `url:"isIncludeSender,omitempty"` }
type MessageChatroomPublishResponse ¶
type MessageChatroomPublishResponse struct { CodeResult // contains filtered or unexported fields }
type MessageExpansionDeleteRequest ¶
type MessageExpansionDeleteRequest struct { // [必传] 消息唯一标识 ID,可通过全量消息路由功能获取。详见[全量消息路由](https://doc.rongcloud.cn/imserver/server/v1/message/sync)。 MsgUID *string `url:"msgUID,omitempty"` // [必传] 操作者用户 ID,即需要为指定消息(msgUID)设置扩展信息的用户 ID。 UserId *string `url:"userId,omitempty"` // [必传] 会话类型。支持的会话类型包括:"1" ConversationTypePrivate(二人会话)、"3" ConversationTypeGroup(群组会话)。 ConversationType *string `url:"conversationType,omitempty"` // [必传] 目标 ID,根据不同的 conversationType,可能是用户 ID 或群组 ID。 TargetId *string `url:"targetId,omitempty"` // [必传] 需要删除的扩展信息的 Key 值,一次最多可以删除 100 个扩展信息。 ExtraKey []string `url:"-"` // 删除操作会生成一条「扩展操作消息」。该字段指定是否将该「扩展操作消息」同步到发件人(扩展操作者)的客户端。1 表示同步,默认值为 0,即不同步。注意,仅设置该参数无法确保发件人客户端一定能获取到该条已发消息,您可能还需要启用其他服务。详见[发件人客户端如何同步已发消息](https://doc.rongcloud.cn/imserver/server/v1/message/how-to-sync-to-sender-client)。 IsSyncSender *int `url:"isSyncSender,omitempty"` }
type MessageExpansionDeleteResponse ¶
type MessageExpansionDeleteResponse struct { CodeResult // contains filtered or unexported fields }
type MessageExpansionQueryRequest ¶
type MessageExpansionQueryRequest struct { // [必传] 消息唯一标识 ID,可通过全量消息路由功能获取。详见[全量消息路由](https://doc.rongcloud.cn/imserver/server/v1/message/sync) MsgUID *string `url:"msgUID,omitempty"` // 页数,默认返回 300 个扩展信息。 PageNo *int `url:"pageNo,omitempty"` }
type MessageExpansionQueryResponse ¶
type MessageExpansionQueryResponse struct { CodeResult // 消息扩展的内容 ExtraContent map[string]*MessageExpansionQueryExtraContentValue `json:"extraContent"` // contains filtered or unexported fields }
type MessageExpansionSetRequest ¶
type MessageExpansionSetRequest struct { // [必传] 消息唯一标识 ID,可通过全量消息路由功能获取。详见[全量消息路由](https://doc.rongcloud.cn/imserver/server/v1/message/sync)。 MsgUID *string `url:"msgUID,omitempty"` // [必传] 操作者用户 ID,即需要为指定消息(msgUID)设置扩展信息的用户 ID。 UserId *string `url:"userId,omitempty"` // [必传] 会话类型。支持的会话类型包括:"1" ConversationTypePrivate(二人会话)、"3" ConversationTypeGroup(群组会话)。 ConversationType *string `url:"conversationType,omitempty"` // [必传] 目标 ID,根据不同的 conversationType,可能是用户 ID 或群组 ID。 TargetId *string `url:"targetId,omitempty"` // [必传] 消息扩展的内容,JSON 结构,以 Key、Value 的方式进行设置,如:{"type":"3"}。Key 最大 32 个字符,支持大小写英文字母、数字、 特殊字符+ = - _ 的组合方式,不支持汉字。Value 最大 4096 个字符。单条消息可设置 300 个扩展信息,一次最多可以设置 100 个。 ExtraKeyVal map[string]string `url:"-"` // 删除操作会生成一条「扩展操作消息」。该字段指定是否将该「扩展操作消息」同步到发件人(扩展操作者)的客户端。1 表示同步,默认值为 0,即不同步。注意,仅设置该参数无法确保发件人客户端一定能获取到该条已发消息,您可能还需要启用其他服务。详见[发件人客户端如何同步已发消息](https://doc.rongcloud.cn/imserver/server/v1/message/how-to-sync-to-sender-client)。 IsSyncSender *int `url:"isSyncSender,omitempty"` }
type MessageExpansionSetResponse ¶
type MessageExpansionSetResponse struct { CodeResult // contains filtered or unexported fields }
type MessageGroupPublishRequest ¶
type MessageGroupPublishRequest struct { // [必传] 发送人用户 ID,通过 Server API 非群成员也可以向群组中发送消息。 //注意:发送消息所使用的用户 ID 必须已获取过用户 Token,否则消息一旦触发离线推送,通知内无法正确显示发送者的用户信息。 FromUserId *string `url:"fromUserId,omitempty"` // [必传] 接收消息的群 ID。支持最多 3 个群组 ID。发送群聊定向消息时,仅支持传入一个群组 ID。 ToGroupId []string `url:"toGroupId,omitempty"` // 发送群聊定向消息时,接收消息的群成员用户 ID 列表,群中其他用户无法收到该定向消息。仅当 toGroupId 传入单个群组 ID 时有效。 ToUserId []string `url:"toUserId,omitempty"` // [必传] 消息类型参数的SDK封装, 例如: TXTMsg(文本消息) RCMsg RCMsg `url:"-"` // 指定收件人离线时触发的远程推送通知中的通知内容。注意:对于部分消息类型,该字段是否有值决定了是否触发远程推送通知。 // 如果消息类型(objectName 字段)为即时通讯服务预定义消息类型中的用户内容类消息格式,可不填写该字段,远程推送通知默认使用服务端预置的推送通知内容。 // 如果消息类型(objectName 字段)为即时通讯服务预定义消息类型中通知类、信令类("撤回命令消息" 除外),且需要支持远程推送通知,则必须填写 pushContent,否则收件人不在线时无法收到远程推送通知。如无需触发远程推送,可不填该字段。 // 如果消息类型为自定义消息类型,且需要支持远程推送通知,则必须填写 pushContent 字段,否则收件人不在线时无法收到远程推送通知。 // 如果消息类型为自定义消息类型,但不需要支持远程推送通知(例如通过自定义消息类型实现的 App 业务层操作指令),可将 pushContent 字段留空禁用远程推送通知。 PushContent *string `url:"pushContent,omitempty"` // iOS 平台收到推送消息时,可从 payload 中获取 APNs 推送数据,对应字段名为 appData(提示:rc 字段中默认携带了消息基本信息)。Android 平台收到推送消息时对应字段名为 appData。 PushData *string `url:"pushData,omitempty"` // 是否向发件人客户端同步已发消息。1 表示同步,默认值为 0,即不同步。注意,仅设置该参数无法确保发件人客户端一定能获取到该条已发消息,您可能还需要启用其他服务。详见发件人[客户端如何同步已发消息](https://doc.rongcloud.cn/imserver/server/v1/message/how-to-sync-to-sender-client)。 IsIncludeSender *int `url:"isIncludeSender,omitempty"` // 是否需要为收件人在历史消息云端存储服务中存储此条消息。0 表示不存储;1 表示存储。默认值为 1,存储(依赖单群聊消息云端存储服务)。 // 注意:即使已开通单群聊消息云存储功能,群组定向消息也不会存入服务端历史消息记录。如有需要,请提交工单申请开通群定向消息云存储服务。 // 此属性不影响离线消息功能,用户未在线时都会转为离线消息?存储。 // 提示:一般情况下(第 1、2 种情况),客户端是否存储消息不依赖此参数。以下第 3 种情况属于例外: // 如果消息属于内置消息类型,客户端 SDK 会根据消息类型本身的存储属性标识判断是否存入本地数据库。详见消息类型概述。 // 如果消息属于自定义消息类型,则客户端 SDK 会根据该类型在客户端上注册时的存储属性标识判断是否需要存入本地数据库。 // 如果消息属于客户端 App 上未注册自定义消息类型(例如客户端使用的 App 版本过旧),则客户端 SDK 会根据当前参数值确定是否将消息存储在本地。但因消息类型未注册,客户端无法解析显示该消息。 IsPersisted *int `url:"isPersisted,omitempty"` // 是否为 @ 消息,不传时默认为非 @ 消息(效果等于传 0)。如果需要发送 @ 消息,必须指定为 1,且必须在消息内容字段(content)内部携带 @ 相关信息(mentionedInfo,可参考下方请求示例)。关于 mentionedInfo 结构的详细说明,参见如何发送 @ 消息。 IsMentioned *int `url:"isMentioned,omitempty"` // 仅目标用户为 iOS 设备时有效,应用处于后台暂停状态时为静默推送,是 iOS7 之后推出的一种推送方式。允许应用在收到通知后在后台运行一段代码,且能够马上执行。详情请查看[知识库文档](https://help.rongcloud.cn/t/topic/855)。1 表示为开启,0 表示为关闭,默认为 0。 ContentAvailable *int `url:"contentAvailable,omitempty"` // 是否为可扩展消息,默认为 false,设为 true 时终端在收到该条消息后,可对该条消息设置扩展信息。移动端 SDK 4.0.3 版本、Web 端 3.0.7 版本支持此功能。仅当 toGroupId 传入单个群组 ID 时有效。 Expansion *bool `url:"expansion,omitempty"` // 仅在 expansion 为 true 时有效。 //自定义的消息扩展信息,该字段接受 JSON 字符串格式的键值对(key-value pairs)。请注意区别于消息体内的 extra 字段,extraContent 的值在消息发送后可修改,修改方式请参见服务端 API 接口文档消息扩展,或参考各客户端「消息扩展」接口文档。 //KV 详细要求:以 Key、Value 的方式进行设置,如:{"type":"3"}。Key 最大 32 个字符,支持大小写英文字母、数字、 特殊字符+ = - _ 的组合方式,不支持汉字。Value 最大 4096 个字符。单次可设置最多 100 对 KV 扩展信息,单条消息最多可设置 300 对 KV 扩展信息。 ExtraContent map[string]string `url:"-"` // 是否为静默消息,默认为 false,设为 true 时终端用户离线情况下不会收到通知提醒。仅当 toGroupId 传入单个群组 ID 时有效。 DisablePush *bool `url:"disablePush,omitempty"` // 配置消息的推送通知,如推送通知的标题等。disablePush 属性为 true 时此属性无效。仅当 toGroupId 传入单个群组 ID 时有效。json string PushExt *string `url:"pushExt,omitempty"` }
type MessageGroupPublishResponse ¶
type MessageGroupPublishResponse struct { CodeResult // contains filtered or unexported fields }
type MessageHistoryDeleteRequest ¶
type MessageHistoryDeleteRequest struct { // [必传] 指定时间,精确到某天某小时,格式为 YYYYMMDDHH。例如 2014010101 表示需要删除 2014 年 1 月 1 日凌晨 1 点至 2 点的数据。返回成功后,消息记录文件将在随后的 10 分钟内被永久删除。 // 注意:date 的值与应用所属数据中心有关。如您的 App 业务使用新加坡数据中心,则获取消息日志时使用的时间(date),及日志中的消息时间(dateTime)均为 UTC 时间。如您仍需根据北京时间下载数据,请自行转换处理。如要下载北京时间 2019120109 的日志,需要输入 2019120101。 Date *string `url:"date,omitempty"` }
type MessageHistoryDeleteResponse ¶
type MessageHistoryDeleteResponse struct { CodeResult // contains filtered or unexported fields }
type MessageHistoryRequest ¶
type MessageHistoryRequest struct { // [必传] 指定时间,精确到某天某小时,格式为 YYYYMMDDHH。例如 2014010101 表示需要获取 2014 年 1 月 1 日凌晨 1 点至 2 点的数据。 // 注意:date 的值与应用所属数据中心有关。如您的 App 业务使用新加坡数据中心,则获取消息日志时使用的时间(date),及日志中的消息时间(dateTime)均为 UTC 时间。如您仍需根据北京时间下载数据,请自行转换处理。如要下载北京时间 2019120109 的日志,需要输入 2019120101。 Date *string `url:"date,omitempty"` }
type MessageHistoryResponse ¶
type MessageHistoryResponse struct { CodeResult // 历史记录下载地址。如没有消息记录数据时,则 url 值为空。 Url string `json:"url"` // 历史记录时间。 Date string `json:"date"` // contains filtered or unexported fields }
type MessageOnlineBroadcastResponse ¶
type MessageOnlineBroadcastResponse struct { CodeResult // contains filtered or unexported fields }
type MessagePrivatePublishRequest ¶
type MessagePrivatePublishRequest struct { // 发送人用户 ID。 //注意:发送消息所使用的用户 ID 必须已获取过用户 Token,否则消息一旦触发离线推送,通知内无法正确显示发送者的用户信息。 FromUserId *string `json:"fromUserId"` // 接收用户 ID,可以实现向多人发送消息,每次上限为 1000 人。 ToUserId *string `json:"toUserId"` RCMsg RCMsg `json:"-"` // 消息类型参数的SDK封装, 例如: TXTMsg(文本消息), HQVCMsg(高清语音消息) PushData *string `json:"pushData"` // iOS 平台收到推送消息时,可从 payload 中获取 APNs 推送数据,对应字段名为 appData(提示:rc 字段中默认携带了消息基本信息)。Android 平台收到推送消息时对应字段名为 appData。 //指定收件人离线时触发的远程推送通知中的通知内容。注意:对于部分消息类型,该字段是否有值决定了是否触发远程推送通知。 //如果消息类型(objectName 字段)为即时通讯服务预定义消息类型中的用户内容类消息格式,可不填写该字段,远程推送通知默认使用服务端预置的推送通知内容。 //如果消息类型(objectName 字段)为即时通讯服务预定义消息类型中通知类、信令类("撤回命令消息" 除外),且需要支持远程推送通知,则必须填写 pushContent,否则收件人不在线时无法收到远程推送通知。如无需触发远程推送,可不填该字段。 //如果消息类型为自定义消息类型,且需要支持远程推送通知,则必须填写 pushContent 字段,否则收件人不在线时无法收到远程推送通知。 //如果消息类型为自定义消息类型,但不需要支持远程推送通知(例如通过自定义消息类型实现的 App 业务层操作指令),可将 pushContent 字段留空禁用远程推送通知 PushContent *string `json:"pushContent"` IsIncludeSender *int `json:"isIncludeSender"` // 是否向发件人客户端同步已发消息。1 表示同步,默认值为 0,即不同步。 Count *int `json:"count"` // 仅目标用户为 iOS 设备有效,Push 时用来控制桌面角标未读消息数,只有在 toUserId 为一个用户 ID 时有效,客户端获取远程推送内容时为 badge。具体参见 iOS 客户端文档「APNs 推送开发指南」目录下的集成 APNs 远程推送。为 -1 时不改变角标数,传入相应数字表示把角标数改为指定的数字,最大不超过 9999。 VerifyBlacklist *int `json:"verifyBlacklist"` // 是否过滤接收用户黑名单列表,0 表示为不过滤、 1 表示为过滤,默认为 0。 IsPersisted *int `json:"isPersisted"` // 是否需要为收件人在历史消息云端存储服务中存储此条消息。0 表示不存储;1 表示存储。默认值为 1,存储(依赖单群聊消息云端存储服务)。 ContentAvailable *int `json:"contentAvailable"` // 仅目标用户为 iOS 设备时有效,应用处于后台暂停状态时为静默推送,是 iOS7 之后推出的一种推送方式。允许应用在收到通知后在后台运行一段代码,且能够马上执行。详情请查看[知识库文档](https://help.rongcloud.cn/t/topic/855)。1 表示为开启,0 表示为关闭,默认为 0。 Expansion *bool `json:"expansion"` // 是否为可扩展消息,默认为 false,设为 true 时终端在收到该条消息后,可对该条消息设置扩展信息。移动端 SDK 4.0.3 版本、Web 端 3.0.7 版本支持此功能。 // 仅在 expansion 为 true 时有效。 //自定义的消息扩展信息,该字段接受 JSON 字符串格式的键值对(key-value pairs)。请注意区别于消息体内的 extra 字段,extraContent 的值在消息发送后可修改,修改方式请参见服务端 API 接口文档消息扩展,或参考各客户端「消息扩展」接口文档。 //KV 详细要求:以 Key、Value 的方式进行设置,如:{"type":"3"}。Key 最大 32 个字符,支持大小写英文字母、数字、 特殊字符+ = - _ 的组合方式,不支持汉字。Value 最大 4096 个字符。单次可设置最多 100 对 KV 扩展信息,单条消息最多可设置 300 对 KV 扩展信息。 ExtraContent map[string]string `json:"extraContent"` // 是否为静默消息,默认为 false,设为 true 时终端用户离线情况下不会收到通知提醒。 DisablePush *bool `json:"disablePush"` // 配置消息的推送通知,如推送通知的标题等。disablePush 属性为 true 时此属性无效。json string PushExt *string `json:"pushExt"` }
MessagePrivatePublishRequest 单聊消息
func (*MessagePrivatePublishRequest) MakeFormData ¶
func (r *MessagePrivatePublishRequest) MakeFormData() (url.Values, error)
type MessagePrivatePublishResponse ¶
type MessagePrivatePublishResponse struct { Code int `json:"code"` // 返回码,200 为正常。 // contains filtered or unexported fields }
type MessagePrivatePublishTemplateRequest ¶
type MessagePrivatePublishTemplateRequest struct { // [必传] 发送人用户 ID。 // 注意:发送消息所使用的用户 ID 必须已获取过用户 Token,否则消息一旦触发离线推送,通知内无法正确显示发送者的用户信息。 FromUserId *string `json:"fromUserId"` // [必传] 消息类型参数的SDK封装, 例如: TXTMsg(文本消息) RCMsg RCMsg `json:"-"` // [必传] SDK封装消息模板 MessageTemplate []*MessageTemplate `json:"-"` // 是否向发件人客户端同步已发消息。1 表示同步,默认值为 0,即不同步。注意,仅设置该参数无法确保发件人客户端一定能获取到该条已发消息,您可能还需要启用其他服务。详见发件人客户端如何同步已发消息。 IsIncludeSender *int `json:"isIncludeSender"` // 是否过滤发送人黑名单列表,0 为不过滤、 1 为过滤,默认为 0 不过滤。 VerifyBlacklist *int `json:"verifyBlacklist,omitempty"` // 是否需要为收件人在历史消息云端存储服务中存储此条消息。0 表示不存储;1 表示存储。默认值为 1,存储(依赖单群聊消息云端存储服务)。 // 此属性不影响离线消息功能,用户未在线时都会转为离线消息?存储。 // 提示:一般情况下(第 1、2 种情况),客户端是否存储消息不依赖此参数。以下第 3 种情况属于例外: // 如果消息属于内置消息类型,客户端 SDK 会根据消息类型本身的存储属性标识判断是否存入本地数据库。详见消息类型概述。 // 如果消息属于自定义消息类型,则客户端 SDK 会根据该类型在客户端上注册时的存储属性标识判断是否需要存入本地数据库。 // 如果消息属于客户端 App 上未注册自定义消息类型(例如客户端使用的 App 版本过旧),则客户端 SDK 会根据当前参数值确定是否将消息存储在本地。但因消息类型未注册,客户端无法解析显示该消息。 IsPersisted *int `json:"isPersisted,omitempty"` // 仅目标用户为 iOS 设备时有效,对 SDK 处于后台暂停状态时为静默推送,是 iOS7 之后推出的一种推送方式。 允许应用在收到通知后在后台运行一段代码,且能够马上执行。详情请查看知识库文档。1 表示为开启,0 表示为关闭,默认为 0 ContentAvailable *int `json:"contentAvailable,omitempty"` // 是否为可扩展消息,默认为 false,设为 true 时终端在收到该条消息后,可对该条消息设置扩展信息。 Expansion *bool `json:"expansion,omitempty"` // 是否为静默消息,默认为 false,设为 true 时终端用户离线情况下不会收到通知提醒。 DisablePush *bool `json:"disablePush,omitempty"` // 配置消息的推送通知,如推送通知的标题等。disablePush 属性为 true 时此属性无效。json string PushExt *string `json:"pushExt,omitempty"` }
func (*MessagePrivatePublishTemplateRequest) MarshalJSON ¶
func (r *MessagePrivatePublishTemplateRequest) MarshalJSON() ([]byte, error)
type MessagePrivatePublishTemplateResponse ¶
type MessagePrivatePublishTemplateResponse struct { CodeResult // contains filtered or unexported fields }
type MessageRecallRequest ¶
type MessageRecallRequest struct { // [必传] 消息发送人用户 ID。 FromUserId *string `url:"fromUserId,omitempty"` // [必传] 会话类型。支持的会话类型包括:1(二人会话)、3(群组会话)、4(聊天室会话)、6(系统会话)、10(超级群会话)。 ConversationType *int `url:"conversationType,omitempty"` // [必传] 目标 ID,根据不同的会话类型(ConversationType),可能是用户 ID、群组 ID、聊天室 ID、超级群 ID,系统目标 ID。 TargetId *string `url:"targetId,omitempty"` // 超级群频道 ID,仅适用于撤回超级群消息。使用要求如下: // 如果发送消息时指定了频道 ID,则撤回时必须指定频道 ID,否则无法撤回。 // 如果发送消息时未指定频道 ID,则撤回时不可指定频道 ID,否则无法撤回。 // 客户端发送超级群消息时,频道 ID 对应字段名称为 channelId。 BusChannel *string `url:"busChannel,omitempty"` // [必传] 消息唯一标识。 // 可通过全量消息路由服务获取消息唯一标识,对应名称为 msgUID。 // 全量消息路由服务不支持的消息,目前只能通过历史消息日志获取,对应字段名称为 msgUID。 MessageUID *string `url:"messageUID,omitempty"` // [必传] 消息发送时间。 // 可通过全量消息路由服务获取消息发送时间,对应名称为 msgTimestamp。 // 全量消息路由服务不支持的消息,目前只能通过历史消息日志获取,对应字段名称为 dateTime。 SentTime *int64 `url:"sentTime,omitempty"` // 是否为管理员,默认为 0,设为 1 时,IMKit 收到此条消息后,小灰条默认显示为“管理员 撤回了一条消息”。 IsAdmin *int `url:"isAdmin,omitempty"` // 指定移动端接收方是否需要在本地删除原始消息记录及显示撤回消息提示,默认为 0。 // 为 0 时,移动端接收方仅将原始消息内容替换为撤回提示(小灰条通知),不删除该原始消息记录。 // 为 1 时,移动端接收方会删除原始消息记录,不显示撤回提示(小灰条通知)。 // 注意:即时通讯服务端历史消息不保存已撤回的超级群消息记录。如果 isDelete 设置为 0,撤回超级群消息后,移动端本地会存有记录(显示为撤回提示),而 Web 端无记录,可能会造成用户体验差异。 IsDelete *int `url:"isDelete,omitempty"` // 是否为静默撤回,默认为 false,设为 true 时终端用户离线情况下不会收到撤回通知提醒。该字段不支持聊天室、超级群会话类型。 DisablePush *bool `url:"disablePush,omitempty"` // 扩展信息,可以放置任意的数据内容。不支持超级群会话(conversationType 为 10)。 Extra *string `url:"extra,omitempty"` }
type MessageRecallResponse ¶
type MessageRecallResponse struct { CodeResult // contains filtered or unexported fields }
type MessageSystemPublishRequest ¶
type MessageSystemPublishRequest struct { // [必传] 发送人用户 ID,通过 Server API 非群成员也可以向群组中发送消息。 //注意:发送消息所使用的用户 ID 必须已获取过用户 Token,否则消息一旦触发离线推送,通知内无法正确显示发送者的用户信息。 FromUserId *string `url:"fromUserId,omitempty"` // [必传] 接收用户 ID,提供多个本参数可以实现向多用户发送系统消息,上限为 100 人。 ToUserId []string `url:"toUserId,omitempty"` // [必传] 消息类型参数的SDK封装, 例如: TXTMsg(文本消息) RCMsg RCMsg `url:"-"` // 指定收件人离线时触发的远程推送通知中的通知内容。注意:对于部分消息类型,该字段是否有值决定了是否触发远程推送通知。 // 如果消息类型(objectName 字段)为即时通讯服务预定义消息类型中的用户内容类消息格式,可不填写该字段,远程推送通知默认使用服务端预置的推送通知内容。 // 如果消息类型(objectName 字段)为即时通讯服务预定义消息类型中通知类、信令类("撤回命令消息" 除外),且需要支持远程推送通知,则必须填写 pushContent,否则收件人不在线时无法收到远程推送通知。如无需触发远程推送,可不填该字段。 // 如果消息类型为自定义消息类型,且需要支持远程推送通知,则必须填写 pushContent 字段,否则收件人不在线时无法收到远程推送通知。 // 如果消息类型为自定义消息类型,但不需要支持远程推送通知(例如通过自定义消息类型实现的 App 业务层操作指令),可将 pushContent 字段留空禁用远程推送通知。 PushContent *string `url:"pushContent,omitempty"` // iOS 平台收到推送消息时,可从 payload 中获取 APNs 推送数据,对应字段名为 appData(提示:rc 字段中默认携带了消息基本信息)。Android 平台收到推送消息时对应字段名为 appData。 PushData *string `url:"pushData,omitempty"` // 是否需要为收件人在历史消息云端存储服务中存储此条消息。0 表示不存储;1 表示存储。默认值为 1,存储(依赖单群聊消息云端存储服务)。 // 注意:即使已开通单群聊消息云存储功能,群组定向消息也不会存入服务端历史消息记录。如有需要,请提交工单申请开通群定向消息云存储服务。 // 此属性不影响离线消息功能,用户未在线时都会转为离线消息?存储。 // 提示:一般情况下(第 1、2 种情况),客户端是否存储消息不依赖此参数。以下第 3 种情况属于例外: // 如果消息属于内置消息类型,客户端 SDK 会根据消息类型本身的存储属性标识判断是否存入本地数据库。详见消息类型概述。 // 如果消息属于自定义消息类型,则客户端 SDK 会根据该类型在客户端上注册时的存储属性标识判断是否需要存入本地数据库。 // 如果消息属于客户端 App 上未注册自定义消息类型(例如客户端使用的 App 版本过旧),则客户端 SDK 会根据当前参数值确定是否将消息存储在本地。但因消息类型未注册,客户端无法解析显示该消息。 IsPersisted *int `url:"isPersisted,omitempty"` // 仅目标用户为 iOS 设备时有效,应用处于后台暂停状态时为静默推送,是 iOS7 之后推出的一种推送方式。允许应用在收到通知后在后台运行一段代码,且能够马上执行。详情请查看[知识库文档](https://help.rongcloud.cn/t/topic/855)。1 表示为开启,0 表示为关闭,默认为 0。 ContentAvailable *int `url:"contentAvailable,omitempty"` // 是否为静默消息,默认为 false,设为 true 时终端用户离线情况下不会收到通知提醒。 DisablePush *bool `url:"disablePush,omitempty"` // 配置消息的推送通知,如推送通知的标题等。disablePush 属性为 true 时此属性无效。json string PushExt *string `url:"pushExt,omitempty"` }
type MessageSystemPublishResponse ¶
type MessageSystemPublishResponse struct { CodeResult // contains filtered or unexported fields }
type MessageSystemPublishTemplateRequest ¶
type MessageSystemPublishTemplateRequest struct { // [必传] 发送人用户 ID。 // 注意:发送消息所使用的用户 ID 必须已获取过用户 Token,否则消息一旦触发离线推送,通知内无法正确显示发送者的用户信息。 FromUserId *string `json:"fromUserId,omitempty"` // [必传] 消息类型参数的SDK封装, 例如: TXTMsg(文本消息) RCMsg RCMsg `json:"-"` // [必传] SDK封装消息模板 MessageTemplate []*MessageTemplate `json:"-"` // 针对 iOS 平台,对 SDK 处于后台暂停状态时为静默推送,是 iOS7 之后推出的一种推送方式。 允许应用在收到通知后在后台运行一段代码,且能够马上执行。详情请查看知识库文档。1 表示为开启,0 表示为关闭,默认为 0 ContentAvailable *int `json:"contentAvailable,omitempty"` // 是否为静默消息,默认为 false,设为 true 时终端用户离线情况下不会收到通知提醒。 DisablePush *bool `json:"disablePush,omitempty"` }
func (*MessageSystemPublishTemplateRequest) MarshalJSON ¶
func (r *MessageSystemPublishTemplateRequest) MarshalJSON() ([]byte, error)
type MessageSystemPublishTemplateResponse ¶
type MessageSystemPublishTemplateResponse struct { CodeResult // contains filtered or unexported fields }
type MessageTemplate ¶
type MessageTemplate struct { // [必传] 接收用户 ID。 ToUserId string // [必传] 为消息内容(content)、推送通知内容(pushContent)、推送数据(pushData)中的标识位(标识位示例:{d})提供对应的值。 Value map[string]string // [必传] 指定收件人离线时触发的远程推送通知中的通知内容。注意:对于部分消息类型,该字段是否有值决定了是否触发远程推送通知。支持定义模板标识位,使用 values 中的值进行替换。 // 如果消息类型(objectName 字段)为即时通讯服务预定义的消息类型,填写该字段后,离线推送通知中显示模板定义的推送内容,而非消息类型的默认推送内容。 // 如果消息类型为自定义消息类型,且需要支持远程推送通知,则必须填写 pushContent 字段,否则收件人不在线时无法收到远程推送通知。 // 如果消息类型为自定义消息类型,但不需要支持远程推送通知(例如通过自定义消息类型实现的 App 业务层操作指令),可将 pushContent 字段对应数组传空值禁用离线推送。 PushContent string // iOS 平台收到推送消息时,可从 payload 中获取 APNs 推送数据,对应字段名为 appData(提示:rc 字段中默认携带了消息基本信息)。Android 平台收到推送消息时对应字段名为 appData。 PushData string }
type MessageUltraGroupPublishRequest ¶
type MessageUltraGroupPublishRequest struct { // [必传] 发送人用户 ID,通过 Server API 非群成员也可以向群组中发送消息。 注意:发送消息所使用的用户 ID 必须已获取过用户 Token,否则消息一旦触发离线推送,通知内无法正确显示发送者的用户信息。 FromUserId *string `json:"fromUserId,omitempty"` // [必传] 接收群 ID,提供多个本参数可以实现向多群发送消息,最多不超过 3 个超级群。 ToGroupIds []string `json:"toGroupIds,omitempty"` // [必传] 消息类型,接受内置消息类型(见消息类型概述)或自定义消息的消息类型值。 // 注意:在自定义消息时,消息类型不可以 "RC:" 开头,以免与系统内置消息类型重名;消息类型长度不可超过 32 个字符。SDK 中必须已注册过该自定义消息,否则 SDK 收到该消息后将无法解析。 ObjectName *string `json:"objectName,omitempty"` // [必传] 所发送消息的内容,单条消息最大 128k。 //内置消息类型:将消息内容体 JSON 对象序列化为 JSON 字符串传入。消息内容 JSON 结构体详见用户内容类消息格式或其他内置消息类型的消息内容格式。 //例如,文本消息内容 JSON 结构体内部包含 content 字段(此为 JSON 结构体内的 key 值,注意区分),则需要将 {"content":"Hello world!"} 序列化后的结果作为此处 content 字段的值。 //自定义消息类型(objectName 字段必须指定为自定义消息类型):如果发送自定义消息,该参数可自定义格式,不限于 JSON。 Content *string `json:"content,omitempty"` // 指定收件人离线时触发的远程推送通知中的通知内容。注意:对于部分消息类型,该字段是否有值决定了是否触发远程推送通知。 // 如果消息类型(objectName 字段)为即时通讯服务预定义消息类型中的用户内容类消息格式,可不填写该字段,远程推送通知默认使用服务端预置的推送通知内容。 // 如果消息类型(objectName 字段)为即时通讯服务预定义消息类型中通知类、信令类("撤回命令消息" 除外),且需要支持远程推送通知,则必须填写 pushContent,否则收件人不在线时无法收到远程推送通知。如无需触发远程推送,可不填该字段。 // 如果消息类型为自定义消息类型,且需要支持远程推送通知,则必须填写 pushContent 字段,否则收件人不在线时无法收到远程推送通知。 // 如果消息类型为自定义消息类型,但不需要支持远程推送通知(例如通过自定义消息类型实现的 App 业务层操作指令),可将 pushContent 字段留空禁用远程推送通知 PushContent *string `json:"pushContent,omitempty" ` // iOS 平台收到推送消息时,可从 payload 中获取 APNs 推送数据,对应字段名为 appData(提示:rc 字段中默认携带了消息基本信息)。Android 平台收到推送消息时对应字段名为 appData。 PushData *string `json:"pushData,omitempty" ` // 是否需要为收件人在历史消息云端存储服务中存储此条消息。0 表示不存储;1 表示存储。默认值为 1,存储(依赖单群聊消息云端存储服务)。 IsPersisted *int `json:"isPersisted,omitempty" ` // 用户未在线时是否计入未读消息数。0 表示为不计数、1 表示为计数,默认为 1。 IsCounted *int `json:"isCounted,omitempty" ` // 是否为 @ 消息,不传时默认为非 @ 消息(效果等于传 0)。如果需要发送 @ 消息,必须指定为 1,且必须在消息内容字段(content)内部携带 @ 相关信息(mentionedInfo,可参考下方请求示例)。关于 mentionedInfo 结构的详细说明,参见如何发送 @ 消息。 IsMentioned *int `json:"isMentioned,omitempty" ` // 仅目标用户为 iOS 设备时有效,应用处于后台暂停状态时为静默推送,是 iOS7 之后推出的一种推送方式。允许应用在收到通知后在后台运行一段代码,且能够马上执行。详情请查看[知识库文档](https://help.rongcloud.cn/t/topic/855)。1 表示为开启,0 表示为关闭,默认为 0。 ContentAvailable *int `json:"contentAvailable,omitempty" ` // 配置消息的推送通知,如推送通知的标题等。disablePush 属性为 true 时此属性无效。json string PushExt *string `json:"pushExt,omitempty" ` // 频道 Id,发消息时会对群 ID 下的频道 ID 做合法性校验,如果群 ID 下无此频道 ID 则服务端不会下发此条消息。支持大小写英文字母、数字的组合方式,不支持特殊字符,最长为 20 个字符。 BusChannel *string `json:"busChannel,omitempty" ` // 是否为可扩展消息,默认为 false,设为 true 时终端在收到该条消息后,可对该条消息设置扩展信息 Expansion *bool `json:"expansion,omitempty" ` // 仅在 expansion 为 true 时有效。 //自定义的消息扩展信息,该字段接受 JSON 字符串格式的键值对(key-value pairs)。请注意区别于消息体内的 extra 字段,extraContent 的值在消息发送后可修改,修改方式请参见服务端 API 接口文档消息扩展,或参考各客户端「消息扩展」接口文档。 //KV 详细要求:以 Key、Value 的方式进行设置,如:{"type":"3"}。Key 最大 32 个字符,支持大小写英文字母、数字、 特殊字符+ = - _ 的组合方式,不支持汉字。Value 最大 4096 个字符。单次可设置最多 100 对 KV 扩展信息,单条消息最多可设置 300 对 KV 扩展信息。 ExtraContent *string `json:"extraContent,omitempty" ` }
type MessageUltraGroupPublishResponse ¶
type MessageUltraGroupPublishResponse struct { CodeResult // contains filtered or unexported fields }
type MsgUserInfo ¶
type MsgUserInfo struct { ID string `json:"id,omitempty"` // 消息中携带的消息发送者的用户信息。一般情况下不建议在消息中携带用户信息。建议仅在直播场景下使用。 Name string `json:"name,omitempty"` // 消息发送者的用户昵称。 Icon string `json:"icon,omitempty"` Portrait string `json:"portrait,omitempty"` // 消息发送者的头象。 Extra string `json:"extra,omitempty"` // 扩展信息,可以放置任意的数据内容。 }
MsgUserInfo 融云内置消息用户信息
type ProfileNtf ¶
type ProfileNtf struct { Operation string `json:"operation,omitempty"` Data string `json:"data,omitempty"` User *MsgUserInfo `json:"user,omitempty"` Extra string `json:"extra,omitempty"` }
ProfileNtf 资料变更通知消息 https://doc.rongcloud.cn/imserver/server/v1/message/objectname-notification#%E8%B5%84%E6%96%99%E5%8F%98%E6%9B%B4%E9%80%9A%E7%9F%A5%E6%B6%88%E6%81%AF
func (*ProfileNtf) ObjectName ¶
func (m *ProfileNtf) ObjectName() string
func (*ProfileNtf) ToString ¶
func (m *ProfileNtf) ToString() (string, error)
type PushAndroid ¶
type PushAndroid struct { Honor *PushAndroidHonor `json:"honor,omitempty"` HW *PushAndroidHW `json:"hw,omitempty"` Oppo *PushAndroidOppo `json:"oppo,omitempty"` Vivo *PushAndroidVivo `json:"vivo,omitempty"` Fcm *PushAndroidFcm `json:"fcm,omitempty"` Extras interface{} `json:"extras,omitempty"` }
type PushAndroidFcm ¶
type PushAndroidFcm struct { // Google FCM 推送通知渠道的 ID。应用程序必须先创建一个具有此频道 ID 的频道,然后才能收到具有此频道 ID 的任何通知。更多信息请参见 Android 官方文档。 ChannelId *string `json:"channelId,omitempty"` // Google FCM 推送中可以折叠的一组消息的标识符,以便在可以恢复传递时仅发送最后一条消息。 CollapseKey *string `json:"collapse_key,omitempty"` // Google FCM 推送自定义的通知栏消息右侧图标 URL,如果不设置,则不展示通知栏右侧图标。 // 图片的大小上限为 1MB。 // 要求开发者后台 FCM 推送配置为证书与通知消息方式。 ImageUrl *string `json:"imageUrl,omitempty"` }
type PushAndroidHW ¶
type PushAndroidHW struct { // 华为推送通知渠道的 ID。详见自定义通知渠道。 ChannelId *string `json:"channelId,omitempty"` // 华为推送通知栏消息优先级,取值 NORMAL、LOW,默认为 NORMAL 重要消息。 Importance *string `json:"importance,omitempty"` // 华为推送自定义的通知栏消息右侧大图标 URL,如果不设置,则不展示通知栏右侧图标。URL 使用的协议必须是 HTTPS 协议,取值样例:https://example.com/image.png。图标文件须小于 512KB,图标建议规格大小:40dp x 40dp,弧角大小为 8dp,超出建议规格大小的图标会存在图片压缩或显示不全的情况。 Image *string `json:"image,omitempty"` // 华为推送通道的消息自分类标识,category 取值必须为大写字母,例如 IM。App 根据华为要求完成自分类权益申请 或 申请特殊权限 后可传入该字段有效。详见华为推送官方文档消息分类标准。该字段优先级高于开发者后台为 App Key 下的应用标识配置的华为推送 Category。 Category *string `json:"category,omitempty"` }
type PushAndroidHonor ¶
type PushAndroidHonor struct { // 荣耀通知栏消息优先级,取值: // NORMAL(服务与通讯类消息) // LOW(咨询营销类消息)。若资讯营销类消息发送时带图片,图片不会展示。 Importance *string `json:"importance,omitempty"` // 荣耀推送自定义通知栏消息右侧的大图标 URL,若不设置,则不展示通知栏右侧图标。 // URL 使用的协议必须是 HTTPS 协议,取值样例:https://example.com/image.png。 // 图标文件须小于 512KB,图标建议规格大小:40dp x 40dp,弧角大小为 8dp。 // 超出建议规格大小的图标会存在图片压缩或显示不全的情况。 Image *string `json:"image,omitempty"` }
type PushAndroidMi ¶
type PushAndroidMi struct { // 小米推送通知渠道的 ID。详见小米推送消息分类新规。 ChannelId *string `json:"channelId,omitempty"` // (由于小米官方已停止支持该能力,该字段已失效)消息右侧图标 URL,如果不设置,则不展示通知栏右侧图标。国内版仅 MIUI12 以上版本支持,以下版本均不支持;国际版支持。图片要求:大小120 * 120px,格式为 png 或者 jpg 格式。 // Deprecated LargeIconUri *string `json:"large_icon_uri,omitempty"` }
type PushAndroidOppo ¶
type PushAndroidOppo struct { // oppo 推送通知渠道的 ID。详见推送私信通道申请。 ChannelId *string `json:"channelId,omitempty"` }
type PushAndroidVivo ¶
type PushAndroidVivo struct { // VIVO 推送服务的消息类别。可选值 0(运营消息,默认值) 和 1(系统消息)。该参数对应 VIVO 推送服务的 classification 字段,见 VIVO 推送消息分类说明 。该字段优先级高于开发者后台为 App Key 下的应用标识配置的 VIVO 推送通道类型。 Classification *string `json:"classification,omitempty"` // VIVO 推送服务的消息二级分类。例如 IM(即时消息)。该参数对应 VIVO 推送服务的 category 字段。详细的 category 取值请参见 VIVO 推送消息分类说明 。如果指定 category ,必须同时传入与当前二级分类匹配的 classification 字段的值(系统消息场景或运营消息场景)。请注意遵照 VIVO 官方要求,确保二级分类(category)取值属于 VIVO 系统消息场景或运营消息场景下允许发送的内容。该字段优先级高于开发者后台为 App Key 下的应用标识配置的 VIVO 推送 Category。 Category *string `json:"category,omitempty"` }
type PushAudience ¶
type PushAudience struct { // 用户标签,每次发送时最多发送 20 个标签,标签之间为 AND 的关系,is_to_all 为 true 时参数无效。 Tag []string `json:"tag,omitempty"` // 用户标签,每次发送时最多发送 20 个标签,标签之间为 OR 的关系,is_to_all 为 true 时参数无效,tag_or 同 tag 参数可以同时存在。 TagOr []string `json:"tag_or,omitempty"` // 用户 ID,每次发送时最多发送 1000 个用户,如果 tag 和 userid 两个条件同时存在时,则以 userid 为准,如果 userid 有值时,则 platform 参数无效,is_to_all 为 true 时参数无效。 Userid []string `json:"userid,omitempty"` // 应用包名,is_to_all 为 true 时,此参数无效。与 tag、tag_or 同时存在时为 And 的关系,向同时满足条件的用户推送。与 userid 条件同时存在时,以 userid 为准进行推送。 PackageName *string `json:"packageName,omitempty"` // 是否全部推送,false 表示按 tag 、tag_or 或 userid 条件推送,true 表示向所有用户推送,tag、tag_or 和 userid 条件无效。 IsToAll *bool `json:"is_to_all,omitempty"` }
type PushCustomAudience ¶
type PushCustomAudience struct { // 用户标签数组,标签之间为 AND 关系。数组中最多包含 20 个标签。 Tag []string `json:"tag,omitempty"` // 用户标签数组,标签之间为 OR 关系。数组中最多包含 20 个标签。 TagOr []string `json:"tag_or,omitempty"` // 应用包名。与 tag 或 tag_or 为逻辑与(AND)关系。 PackageName *string `json:"packageName,omitempty"` // [必传] 是否按指定平台(操作系统)全部推送。true 表示全部推送,此时其他推送条件字段均无效。false 表示按其他推送条件进行推送。 IsToAll *bool `json:"is_to_all,omitempty"` // [必传] 在按用户标签推送场景下,可通过 tagItems 实现复杂与或非逻辑。在 tagItems 包含有效内容的情况下,tag、tag_or 字段无效。 TagItems []*PushCustomAudienceTagItem `json:"tagItems,omitempty"` }
type PushCustomAudienceTagItem ¶
type PushCustomAudienceTagItem struct { // [必传] 用户标签数组。 Tags []string `json:"tags,omitempty"` // [必传] 是否对 tags 数组的运算结果进行非运算。默认为 false。 IsNot *bool `json:"isNot,omitempty"` // [必传] tags 数组内标签之间的运算符。 TagsOperator *string `json:"tagsOperator,omitempty"` // [必传] tagItems 数组内当前 Object 与上一个 Object 之间的运算符。注意:首个 Object 内的 itemsOperator 未被使用,为无效字段。 ItemsOperator *string `json:"itemsOperator,omitempty"` }
type PushCustomNotification ¶
type PushCustomNotification struct { // 通知栏显示标题,最长不超过 50 个字符。 Title *string `json:"title,omitempty"` // 默认推送通知内容。 Alert *string `json:"alert,omitempty"` // 设置 iOS 平台下的推送及附加信息。 IOS *PushCustomNotificationIOS `json:"ios,omitempty"` // 设置 Android 平台下的推送及附加信息。 Android *PushAndroid `json:"android,omitempty"` }
type PushCustomNotificationIOS ¶
type PushCustomNotificationIOS struct { // 通知栏显示的推送标题,仅针对 iOS 平台,支持 iOS 8.2 及以上版本,参数在 ios 节点下设置,详细可参考“设置 iOS 推送标题请求示例”,此属性优先级高于 notification 下的 title。 Title *string `json:"title,omitempty"` // 针对 iOS 平台,静默推送是 iOS7 之后推出的一种推送方式。 允许应用在收到通知后在后台运行一段代码,且能够马上执行。详情请查看知识库文档。1 表示为开启,0 表示为关闭,默认为 0 ContentAvailable *int `json:"contentAvailable,omitempty"` // 应用角标,仅针对 iOS 平台;不填时,表示不改变角标数;为 0 或负数时,表示 App 角标上的数字清零;否则传相应数字表示把角标数改为指定的数字,最大不超过 9999,参数在 ios 节点下设置,详细可参考“设置 iOS 角标数 HTTP 请求示例”。 Badge *int `json:"badge,omitempty"` // iOS 平台通知栏分组 ID,相同的 thread-id 推送分一组,单组超过 5 条推送会折叠展示 ThreadId *string `json:"thread-id,omitempty"` // iOS 平台,从 iOS10 开始支持,设置后设备收到有相同 ID 的消息,会合并成一条 ApnsCollapseId *string `json:"apns-collapse-id,omitempty"` // iOS 富文本推送的类型开发者自己定义,自己在 App 端进行解析判断,与 richMediaUri 一起使用,当设置 category 后,推送时默认携带 mutable-content 进行推送,属性值为 1。 Category *string `json:"category,omitempty"` // iOS 富文本推送内容的 URL,与 category 一起使用。 RichMediaUri *string `json:"richMediaUri,omitempty"` // 适用于 iOS 15 及之后的系统。取值为 passive,active(默认),time-sensitive,或 critical,取值说明详见对应的 APNs 的 interruption-level 字段。在 iOS 15 及以上版本中,系统的 “定时推送摘要”、“专注模式” 都可能导致重要的推送通知(例如余额变化)无法及时被用户感知的情况,可考虑设置该字段。 InterruptionLevel *string `json:"interruption-level,omitempty"` // 附加信息,如果开发者自己需要,可以自己在 App 端进行解析。 Extras interface{} `json:"extras,omitempty"` }
type PushCustomRequest ¶
type PushCustomRequest struct { // [必传] 目标平台(操作系统),可以为 ios、android 其中一个或全部。全部填写时给给 Android、iOS 两个平台推送消息。 Platform []string `json:"platform,omitempty"` // [必传] 推送条件。支持按用户标签推送(tag 、tag_or)、按应用包名推送(packageName)和按指定平台全部推送(is_to_all)。注意:如果推送条件中 is_to_all 为 true,则忽略其他推送条件。 Audience *PushCustomAudience `json:"audience,omitempty"` // [必传] 按平台(操作系统)指定推送内容。 Notification *PushCustomNotification `json:"notification,omitempty"` }
type PushCustomResponse ¶
type PushCustomResponse struct { CodeResult Id string `json:"id"` // 推送唯一标识。 // contains filtered or unexported fields }
type PushNotification ¶
type PushNotification struct { // 通知栏显示标题,最长不超过 50 个字符。 Title *string `json:"title,omitempty"` // 是否越过客户端配置,强制在推送通知内显示通知内容(pushContent)。默认值 0 表示不强制,1 表示强制。 // 说明:客户端设备可设置在接收推送通知时仅显示类似「您收到了一条通知」的提醒。从服务端发送消息时,可通过设置forceShowPushContent 为 1 越过该配置,强制客户端针在此条消息的推送通知中显示推送内容。 ForceShowPushContent *int `json:"forceShowPushContent,omitempty"` // 推送通知内容。注意,如果此处 Alert 不传,则必须在 IOS.Alert 和 Android.Alert 分别指定 IOS 和 Android 下的推送通知内容,否则无法正常推送。一旦指定了各平台推送内容,则推送内容以对应平台系统的 alert 为准。如果都不填写,则无法发起推送。 Alert *string `json:"alert,omitempty"` // 设置 IOS 平台下的推送及附加信息。 IOS *PushNotificationIOS `json:"ios,omitempty"` // 设置 Android 平台下的推送及附加信息 Android *PushNotificationAndroid `json:"android"` }
type PushNotificationAndroid ¶
type PushNotificationAndroid struct { // Android 平台下推送通知内容,传入后默认的推送通知内容失效。 Alert *string `json:"alert,omitempty"` Honor *PushAndroidHonor `json:"honor,omitempty"` HW *PushAndroidHW `json:"hw,omitempty"` Oppo *PushAndroidOppo `json:"oppo,omitempty"` Vivo *PushAndroidVivo `json:"vivo,omitempty"` Fcm *PushAndroidFcm `json:"fcm,omitempty"` Extras interface{} `json:"extras,omitempty"` }
type PushNotificationIOS ¶
type PushNotificationIOS struct { // 通知栏显示的推送标题,仅针对 iOS 平台,支持 iOS 8.2 及以上版本。该属性优先级高于 PushNotification.Title。 Title *string `json:"title,omitempty"` // 针对 iOS 平台,静默推送是 iOS7 之后推出的一种推送方式。 允许应用在收到通知后在后台运行一段代码,且能够马上执行。详情请查看知识库文档。1 表示为开启,0 表示为关闭,默认为 0 ContentAvailable *int `json:"contentAvailable,omitempty"` // 推送通知内容,传入后默认的推送通知内容失效。 Alert *string `json:"alert,omitempty"` // 应用角标,仅针对 iOS 平台;不填时,表示不改变角标数;为 0 或负数时,表示 App 角标上的数字清零;否则传相应数字表示把角标数改为指定的数字,最大不超过 9999,参数在 ios 节点下设置,详细可参考“设置 iOS 角标数 HTTP 请求示例”。 Badge *int `json:"badge,omitempty"` // iOS 平台通知栏分组 ID,相同的 thread-id 推送分一组,单组超过 5 条推送会折叠展示 ThreadId *string `json:"thread-id,omitempty"` // iOS 平台,从 iOS10 开始支持,设置后设备收到有相同 ID 的消息,会合并成一条 ApnsCollapseId *string `json:"apns-collapse-id,omitempty"` // iOS 富文本推送的类型开发者自己定义,自己在 App 端进行解析判断,与 RichMediaUri 一起使用,当设置 Category 后,推送时默认携带 mutable-content 进行推送,属性值为 1。 Category *string `json:"category,omitempty"` // iOS 富文本推送内容的 URL,与 category 一起使用。 RichMediaUri *string `json:"richMediaUri,omitempty"` // 适用于 iOS 15 及之后的系统。取值为 passive,active(默认),time-sensitive,或 critical,取值说明详见对应的 APNs 的 interruption-level 字段。在 iOS 15 及以上版本中,系统的 “定时推送摘要”、“专注模式” 都可能导致重要的推送通知(例如余额变化)无法及时被用户感知的情况,可考虑设置该字段。 InterruptionLevel *string `json:"interruption-level,omitempty"` // 附加信息,如果开发者自己需要,可以自己在 App 端进行解析。 Extras interface{} `json:"extras,omitempty"` }
type PushRequest ¶
type PushRequest struct { // [必传] 目标操作系统,iOS、Android 最少传递一个。如果需要给两个系统推送消息时,则需要全部填写,发送时如目标用户在 Web 端登录也会收到此条消息。 Platform []string `json:"platform,omitempty"` // [必传] 发送人用户 ID。 // 注意:发送消息所使用的用户 ID 必须已获取过用户 Token,否则消息一旦触发离线推送,通知内无法正确显示发送者的用户信息。 FromUserid *string `json:"fromuserid,omitempty"` // [必传] 推送条件。支持按用户 ID 推送,按用户标签推送(tag 、tag_or)、按应用包名推送(packageName)和按指定平台全部推送(is_to_all)。注意:如果推送条件中 is_to_all 为 true,则忽略其他推送条件。 Audience *PushAudience `json:"audience,omitempty"` // [必传] 消息类型参数的SDK封装, 例如: TXTMsg(文本消息), HQVCMsg(高清语音消息) Message RCMsg `json:"message,omitempty"` // 按操作系统类型推送通知内容,如 platform 中设置了给 iOS 和 Android 系统推送消息,而在 notification 中只设置了 iOS 的推送内容,则 Android 的推送内容为最初 alert 设置的内容。 Notification *PushNotification `json:"notification,omitempty"` }
func (*PushRequest) MarshalJSON ¶
func (r *PushRequest) MarshalJSON() ([]byte, error)
type PushResponse ¶
type PushResponse struct { CodeResult Id string `json:"id"` // contains filtered or unexported fields }
type PushUserNotification ¶
type PushUserNotification struct { // 通知栏显示标题,最长不超过 50 个字符。 Title *string `json:"title,omitempty"` // [必传] 推送消息内容。 PushContent *string `json:"pushContent,omitempty"` IOS *PushUserNotificationIOS `json:"ios,omitempty"` Android *PushAndroid `json:"android,omitempty"` }
type PushUserNotificationIOS ¶
type PushUserNotificationIOS struct { // 针对 iOS 平台,静默推送是 iOS7 之后推出的一种推送方式。 允许应用在收到通知后在后台运行一段代码,且能够马上执行。详情请查看知识库文档。1 表示为开启,0 表示为关闭,默认为 0 ContentAvailable *int `json:"contentAvailable,omitempty"` // 应用角标,仅针对 iOS 平台;不填时,表示不改变角标数;为 0 或负数时,表示 App 角标上的数字清零;否则传相应数字表示把角标数改为指定的数字,最大不超过 9999,参数在 ios 节点下设置,详细可参考“设置 iOS 角标数 HTTP 请求示例”。 Badge *int `json:"badge,omitempty"` // iOS 平台通知栏分组 ID,相同的 thread-id 推送分一组,单组超过 5 条推送会折叠展示 ThreadId *string `json:"thread-id,omitempty"` // iOS 平台,从 iOS10 开始支持,设置后设备收到有相同 ID 的消息,会合并成一条 ApnsCollapseId *string `json:"apns-collapse-id,omitempty"` // iOS 富文本推送的类型开发者自己定义,自己在 App 端进行解析判断,与 RichMediaUri 一起使用,当设置 Category 后,推送时默认携带 mutable-content 进行推送,属性值为 1。 Category *string `json:"category,omitempty"` // iOS 富文本推送内容的 URL,与 category 一起使用。 RichMediaUri *string `json:"richMediaUri,omitempty"` // 适用于 iOS 15 及之后的系统。取值为 passive,active(默认),time-sensitive,或 critical,取值说明详见对应的 APNs 的 interruption-level 字段。在 iOS 15 及以上版本中,系统的 “定时推送摘要”、“专注模式” 都可能导致重要的推送通知(例如余额变化)无法及时被用户感知的情况,可考虑设置该字段。 InterruptionLevel *string `json:"interruption-level,omitempty"` // 附加信息,如果开发者自己需要,可以自己在 App 端进行解析。 Extras interface{} `json:"extras,omitempty"` }
PushUserNotificationIOS Not same with PushCustomNotificationIOS, no Title field
type PushUserRequest ¶
type PushUserRequest struct { // [必传] 用户 ID,每次发送时最多发送 100 个用户。 UserIds []string `json:"userIds,omitempty"` // [必传] 按操作系统类型推送消息内容。 Notification *PushUserNotification `json:"notification,omitempty"` }
type PushUserResponse ¶
type PushUserResponse struct { CodeResult Id string `json:"id"` // contains filtered or unexported fields }
type RCMsg ¶
RCMsg 消息类型,接受内置消息类型(见消息类型概述)或自定义消息的消息类型值。 注意:在自定义消息时,消息类型不可以 "RC:" 开头,以免与系统内置消息类型重名;消息类型长度不可超过 32 个字符。SDK 中必须已注册过该自定义消息,否则 SDK 收到该消息后将无法解析。 所发送消息的内容,单条消息最大 128k。 内置消息类型:将消息内容体 JSON 对象序列化为 JSON 字符串传入。消息内容 JSON 结构体详见用户内容类消息格式或其他内置消息类型的消息内容格式。 例如,文本消息内容 JSON 结构体内部包含 content 字段(此为 JSON 结构体内的 key 值,注意区分),则需要将 {"content":"Hello world!"} 序列化后的结果作为此处 content 字段的值。 自定义消息类型(objectName 字段必须指定为自定义消息类型):如果发送自定义消息,该参数可自定义格式,不限于 JSON。
type RongCloud ¶
type RongCloud struct {
// contains filtered or unexported fields
}
RongCloud appKey appSecret extra
func NewRongCloud ¶
NewRongCloud 创建 RongCloud 对象
func (*RongCloud) ChatroomBanAdd ¶
func (rc *RongCloud) ChatroomBanAdd(ctx context.Context, req *ChatroomBanAddRequest) (*ChatroomBanAddResponse, error)
ChatroomBanAdd 设置聊天室全体禁言 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/ban-chatroom
func (*RongCloud) ChatroomBanCheck ¶
func (rc *RongCloud) ChatroomBanCheck(ctx context.Context, req *ChatroomBanCheckRequest) (*ChatroomBanCheckResponse, error)
ChatroomBanCheck 查询聊天室全体禁言状态 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/query-banned-state
func (*RongCloud) ChatroomBanQuery ¶
func (rc *RongCloud) ChatroomBanQuery(ctx context.Context, req *ChatroomBanQueryRequest) (*ChatroomBanQueryResponse, error)
ChatroomBanQuery 查询聊天室全体禁言列表 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/query-banned-list
func (*RongCloud) ChatroomBanRollback ¶
func (rc *RongCloud) ChatroomBanRollback(ctx context.Context, req *ChatroomBanRollbackRequest) (*ChatroomBanRollbackResponse, error)
ChatroomBanRollback 取消聊天室全体禁言 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/unban-chatroom
func (*RongCloud) ChatroomCreateNew ¶
func (rc *RongCloud) ChatroomCreateNew(ctx context.Context, req *ChatroomCreateNewRequest) (*ChatroomCreateNewResponse, error)
ChatroomCreateNew create new chatroom More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/create
func (*RongCloud) ChatroomDestroy ¶
func (rc *RongCloud) ChatroomDestroy(ctx context.Context, req *ChatroomDestroyRequest) (*ChatroomDestroyResponse, error)
ChatroomDestroy 销毁聊天室 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/destroy
func (*RongCloud) ChatroomDestroySet ¶
func (rc *RongCloud) ChatroomDestroySet(ctx context.Context, req *ChatroomDestroySetRequest) (*ChatroomDestroySetResponse, error)
ChatroomDestroySet 设置聊天室销毁类型 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/set-destroy-type
func (*RongCloud) ChatroomEntryBatchSet ¶
func (rc *RongCloud) ChatroomEntryBatchSet(ctx context.Context, req *ChatroomEntryBatchSetRequest) (*ChatroomEntryBatchSetResponse, error)
ChatroomEntryBatchSet batch set chatroom kv entry 批量设置聊天室属性(KV) More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/set-kv-entry-batch
func (*RongCloud) ChatroomEntryQuery ¶
func (rc *RongCloud) ChatroomEntryQuery(ctx context.Context, req *ChatroomEntryQueryRequest) (*ChatroomEntryQueryResponse, error)
ChatroomEntryQuery 查询聊天室属性(KV) More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/query-kv-entry
func (*RongCloud) ChatroomEntryRemove ¶
func (rc *RongCloud) ChatroomEntryRemove(ctx context.Context, req *ChatroomEntryRemoveRequest) (*ChatroomEntryRemoveResponse, error)
ChatroomEntryRemove 删除聊天室属性(KV) More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/remove-kv-entry
func (*RongCloud) ChatroomEntrySet ¶
func (rc *RongCloud) ChatroomEntrySet(ctx context.Context, req *ChatroomEntrySetRequest) (*ChatroomEntrySetResponse, error)
ChatroomEntrySet set chatroom entry kv (设置聊天室属性(KV)) More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/set-kv-entry
func (*RongCloud) ChatroomGet ¶
func (rc *RongCloud) ChatroomGet(ctx context.Context, req *ChatroomGetRequest) (*ChatroomGetResponse, error)
ChatroomGet 查询聊天室信息 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/get
func (*RongCloud) ChatroomKeepaliveAdd ¶
func (rc *RongCloud) ChatroomKeepaliveAdd(ctx context.Context, req *ChatroomKeepaliveAddRequest) (*ChatroomKeepaliveAddResponse, error)
ChatroomKeepaliveAdd 保活聊天室 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/add-to-keep-alive
func (*RongCloud) ChatroomKeepaliveQuery ¶
func (rc *RongCloud) ChatroomKeepaliveQuery(ctx context.Context, req *ChatroomKeepaliveQueryRequest) (*ChatroomKeepaliveQueryResponse, error)
ChatroomKeepaliveQuery 查询保活聊天室 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/query-keep-alive
func (*RongCloud) ChatroomKeepaliveRemove ¶
func (rc *RongCloud) ChatroomKeepaliveRemove(ctx context.Context, req *ChatroomKeepaliveRemoveRequest) (*ChatroomKeepaliveRemoveResponse, error)
ChatroomKeepaliveRemove 取消保活聊天室 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/remove-from-keep-alive
func (*RongCloud) ChatroomMessagePriorityAdd ¶
func (rc *RongCloud) ChatroomMessagePriorityAdd(ctx context.Context, req *ChatroomMessagePriorityAddRequest) (*ChatroomMessagePriorityAddResponse, error)
ChatroomMessagePriorityAdd 添加低级别消息类型 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/add-low-priority-message-type
func (*RongCloud) ChatroomMessagePriorityQuery ¶
func (rc *RongCloud) ChatroomMessagePriorityQuery(ctx context.Context, req *ChatroomMessagePriorityQueryRequest) (*ChatroomMessagePriorityQueryResponse, error)
ChatroomMessagePriorityQuery 查询低级别消息类型 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/query-low-priority-message-type
func (*RongCloud) ChatroomMessagePriorityRemove ¶
func (rc *RongCloud) ChatroomMessagePriorityRemove(ctx context.Context, req *ChatroomMessagePriorityRemoveRequest) (*ChatroomMessagePriorityRemoveResponse, error)
ChatroomMessagePriorityRemove 移除低级别消息类型 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/remove-low-priority-message-type
func (*RongCloud) ChatroomUserBanAdd ¶
func (rc *RongCloud) ChatroomUserBanAdd(ctx context.Context, req *ChatroomUserBanAddRequest) (*ChatroomUserBanAddResponse, error)
ChatroomUserBanAdd 全局禁言用户 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/gag-user-globally
func (*RongCloud) ChatroomUserBanQuery ¶
func (rc *RongCloud) ChatroomUserBanQuery(ctx context.Context, req *ChatroomUserBanQueryRequest) (*ChatroomUserBanQueryResponse, error)
ChatroomUserBanQuery 查询全局禁言用户列表 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/query-globally-gagged-user
func (*RongCloud) ChatroomUserBanRemove ¶
func (rc *RongCloud) ChatroomUserBanRemove(ctx context.Context, req *ChatroomUserBanRemoveRequest) (*ChatroomUserBanRemoveResponse, error)
ChatroomUserBanRemove 取消全局禁言用户 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/ungag-user-globally
func (*RongCloud) ChatroomUserBanWhitelistAdd ¶
func (rc *RongCloud) ChatroomUserBanWhitelistAdd(ctx context.Context, req *ChatroomUserBanWhitelistAddRequest) (*ChatroomUserBanWhiteListAddResponse, error)
ChatroomUserBanWhitelistAdd 加入聊天室全体禁言白名单 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/add-to-chatroom-ban-whitelist
func (*RongCloud) ChatroomUserBanWhitelistQuery ¶
func (rc *RongCloud) ChatroomUserBanWhitelistQuery(ctx context.Context, req *ChatroomUserBanWhitelistQueryRequest) (*ChatroomUserBanWhitelistQueryResponse, error)
ChatroomUserBanWhitelistQuery 查询聊天室全体禁言白名单 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/query-chatroom-ban-whitelist
func (*RongCloud) ChatroomUserBanWhitelistRollback ¶
func (rc *RongCloud) ChatroomUserBanWhitelistRollback(ctx context.Context, req *ChatroomUserBanWhitelistRollbackRequest) (*ChatroomUserBanWhiteListRollbackResponse, error)
ChatroomUserBanWhitelistRollback 移出聊天室全体禁言白名单 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/remove-from-chatroom-ban-whitelist
func (*RongCloud) ChatroomUserBlockAdd ¶
func (rc *RongCloud) ChatroomUserBlockAdd(ctx context.Context, req *ChatroomUserBlockAddRequest) (*ChatroomUserBlockAddResponse, error)
ChatroomUserBlockAdd 封禁聊天室用户 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/block-user
func (*RongCloud) ChatroomUserBlockList ¶
func (rc *RongCloud) ChatroomUserBlockList(ctx context.Context, req *ChatroomUserBlockListRequest) (*ChatroomUserBlockListResponse, error)
ChatroomUserBlockList 查询聊天室封禁用户 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/query-blocked-user
func (*RongCloud) ChatroomUserBlockRollback ¶
func (rc *RongCloud) ChatroomUserBlockRollback(ctx context.Context, req *ChatroomUserBlockRollbackRequest) (*ChatroomUserBlockRollbackResponse, error)
ChatroomUserBlockRollback 解除封禁聊天室用户 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/unblock-user
func (*RongCloud) ChatroomUserExist ¶
func (rc *RongCloud) ChatroomUserExist(ctx context.Context, req *ChatroomUserExistRequest) (*ChatroomUserExistResponse, error)
ChatroomUserExist 查询是否在聊天室中 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/check-member
func (*RongCloud) ChatroomUserGagAdd ¶
func (rc *RongCloud) ChatroomUserGagAdd(ctx context.Context, req *ChatroomUserGagAddRequest) (*ChatroomUserGagAddResponse, error)
ChatroomUserGagAdd 禁言指定聊天室用户 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/gag-user
func (*RongCloud) ChatroomUserGagList ¶
func (rc *RongCloud) ChatroomUserGagList(ctx context.Context, req *ChatroomUserGagListRequest) (*ChatroomUserGagListResponse, error)
ChatroomUserGagList 查询聊天室禁言用户列表 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/query-gagged-user
func (*RongCloud) ChatroomUserGagRollback ¶
func (rc *RongCloud) ChatroomUserGagRollback(ctx context.Context, req *ChatroomUserGagRollbackRequest) (*ChatroomUserGagRollbackResponse, error)
ChatroomUserGagRollback 取消禁言指定聊天室用户 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/ungag-user
func (*RongCloud) ChatroomUserQuery ¶
func (rc *RongCloud) ChatroomUserQuery(ctx context.Context, req *ChatroomUserQueryRequest) (*ChatroomUserQueryResponse, error)
ChatroomUserQuery 获取聊天室成员 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/query-member-list
func (*RongCloud) ChatroomUserWhitelistAdd ¶
func (rc *RongCloud) ChatroomUserWhitelistAdd(ctx context.Context, req *ChatroomUserWhitelistAddRequest) (*ChatroomUserWhitelistAddResponse, error)
ChatroomUserWhitelistAdd 加入聊天室用户白名单 https://doc.rongcloud.cn/imserver/server/v1/chatroom/add-to-user-whitelist
func (*RongCloud) ChatroomUserWhitelistQuery ¶
func (rc *RongCloud) ChatroomUserWhitelistQuery(ctx context.Context, req *ChatroomUserWhitelistQueryRequest) (*ChatroomUserWhitelistQueryResponse, error)
ChatroomUserWhitelistQuery 查询聊天室用户白名单 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/query-user-whitelist
func (*RongCloud) ChatroomUserWhitelistRemove ¶
func (rc *RongCloud) ChatroomUserWhitelistRemove(ctx context.Context, req *ChatroomUserWhitelistRemoveRequest) (*ChatroomUserWhitelistRemoveResponse, error)
ChatroomUserWhitelistRemove 移出聊天室用户白名单 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/remove-from-user-whitelist
func (*RongCloud) ChatroomUsersExist ¶
func (rc *RongCloud) ChatroomUsersExist(ctx context.Context, req *ChatroomUsersExistRequest) (*ChatroomUsersExistResponse, error)
ChatroomUsersExist 批量查询是否在聊天室中 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/check-members
func (*RongCloud) ChatroomWhitelistAdd ¶
func (rc *RongCloud) ChatroomWhitelistAdd(ctx context.Context, req *ChatroomWhitelistAddRequest) (*ChatroomWhitelistAddResponse, error)
ChatroomWhitelistAdd 加入聊天室消息白名单 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/add-to-message-type-whitelist
func (*RongCloud) ChatroomWhitelistQuery ¶
func (rc *RongCloud) ChatroomWhitelistQuery(ctx context.Context, req *ChatroomWhitelistQueryRequest) (*ChatroomWhitelistQueryResponse, error)
ChatroomWhitelistQuery 查询聊天室消息白名单 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/query-message-type-whitelist
func (*RongCloud) ChatroomWhitelistRemove ¶
func (rc *RongCloud) ChatroomWhitelistRemove(ctx context.Context, req *ChatroomWhitelistRemoveRequest) (*ChatroomWhitelistRemoveResponse, error)
ChatroomWhitelistRemove 移出聊天室消息白名单 More details see https://doc.rongcloud.cn/imserver/server/v1/chatroom/remove-from-message-type-whitelist
func (*RongCloud) ConversationNotificationGet ¶
func (rc *RongCloud) ConversationNotificationGet(ctx context.Context, req *ConversationNotificationGetRequest) (*ConversationNotificationGetResponse, error)
ConversationNotificationGet 查询指定会话免打扰 More details see https://doc.rongcloud.cn/imserver/server/v1/conversation/get-do-not-disturb-by-id
func (*RongCloud) ConversationNotificationSet ¶
func (rc *RongCloud) ConversationNotificationSet(ctx context.Context, req *ConversationNotificationSetRequest) (*ConversationNotificationSetResponse, error)
ConversationNotificationSet 设置指定会话免打扰 More details see https://doc.rongcloud.cn/imserver/server/v1/conversation/set-do-not-disturb-by-id
func (*RongCloud) ConversationTopSet ¶
func (rc *RongCloud) ConversationTopSet(ctx context.Context, req *ConversationTopSetRequest) (*ConversationTopSetResponse, error)
ConversationTopSet 会话置顶 More details see https://doc.rongcloud.cn/imserver/server/v1/conversation/top
func (*RongCloud) ConversationTypeNotificationGet ¶
func (rc *RongCloud) ConversationTypeNotificationGet(ctx context.Context, req *ConversationTypeNotificationGetRequest) (*ConversationTypeNotificationGetResponse, error)
ConversationTypeNotificationGet 查询指定会话类型免打扰 More details see https://doc.rongcloud.cn/imserver/server/v1/conversation/get-do-not-disturb-by-type
func (*RongCloud) ConversationTypeNotificationSet ¶
func (rc *RongCloud) ConversationTypeNotificationSet(ctx context.Context, req *ConversationTypeNotificationSetRequest) (*ConversationTypeNotificationSetResponse, error)
ConversationTypeNotificationSet 设置指定会话类型免打扰 More details see https://doc.rongcloud.cn/imserver/server/v1/conversation/set-do-not-disturb-by-type
func (*RongCloud) GetHttpTransport ¶
func (rc *RongCloud) GetHttpTransport() http.RoundTripper
GetHttpTransport 获取http Client 传输层参数
func (*RongCloud) GroupBanAdd ¶
func (rc *RongCloud) GroupBanAdd(ctx context.Context, req *GroupBanAddRequest) (*GroupBanAddResponse, error)
GroupBanAdd 设置群组全体禁言 More details see https://doc.rongcloud.cn/imserver/server/v1/group/ban-group
func (*RongCloud) GroupBanQuery ¶
func (rc *RongCloud) GroupBanQuery(ctx context.Context, req *GroupBanQueryRequest) (*GroupBanQueryResponse, error)
GroupBanQuery 查询群组全体禁言 More details see https://doc.rongcloud.cn/imserver/server/v1/group/query-banned-state-or-list
func (*RongCloud) GroupBanRollback ¶
func (rc *RongCloud) GroupBanRollback(ctx context.Context, req *GroupBanRollbackRequest) (*GroupBanRollbackResponse, error)
GroupBanRollback 取消群组全体禁言 More details see https://doc.rongcloud.cn/imserver/server/v1/group/unban-group
func (*RongCloud) GroupCreate ¶
func (rc *RongCloud) GroupCreate(ctx context.Context, req *GroupCreateRequest) (*GroupCreateResponse, error)
GroupCreate 创建群组 More details see https://doc.rongcloud.cn/imserver/server/v1/group/create-group
func (*RongCloud) GroupDismiss ¶
func (rc *RongCloud) GroupDismiss(ctx context.Context, req *GroupDismissRequest) (*GroupDismissResponse, error)
GroupDismiss 解散群组 More details see https://doc.rongcloud.cn/imserver/server/v1/group/dismiss-group
func (*RongCloud) GroupJoin ¶
func (rc *RongCloud) GroupJoin(ctx context.Context, req *GroupJoinRequest) (*GroupJoinResponse, error)
GroupJoin 加入群组 More details see https://doc.rongcloud.cn/imserver/server/v1/group/join-group
func (*RongCloud) GroupQuit ¶
func (rc *RongCloud) GroupQuit(ctx context.Context, req *GroupQuitRequest) (*GroupQuitResponse, error)
GroupQuit 退出群组 More details see https://doc.rongcloud.cn/imserver/server/v1/group/quit-group
func (*RongCloud) GroupRefresh ¶
func (rc *RongCloud) GroupRefresh(ctx context.Context, req *GroupRefreshRequest) (*GroupRefreshResponse, error)
GroupRefresh 刷新群组信息 More details see https://doc.rongcloud.cn/imserver/server/v1/group/refresh-group-info
func (*RongCloud) GroupRemarksDel ¶
func (rc *RongCloud) GroupRemarksDel(ctx context.Context, req *GroupRemarksDelRequest) (*GroupRemarksDelResponse, error)
GroupRemarksDel 删除群成员推送备注名 More details see https://doc.rongcloud.cn/imserver/server/v1/group/delete-remark-for-group-push
func (*RongCloud) GroupRemarksGet ¶
func (rc *RongCloud) GroupRemarksGet(ctx context.Context, req *GroupRemarksGetRequest) (*GroupRemarksGetResponse, error)
GroupRemarksGet 查询群成员推送备注名 More details see https://doc.rongcloud.cn/imserver/server/v1/group/get-remark-for-group-push
func (*RongCloud) GroupRemarksSet ¶
func (rc *RongCloud) GroupRemarksSet(ctx context.Context, req *GroupRemarksSetRequest) (*GroupRemarksSetResponse, error)
GroupRemarksSet 设置群成员推送备注名 More details see https://doc.rongcloud.cn/imserver/server/v1/group/set-remark-for-group-push
func (*RongCloud) GroupSync ¶
func (rc *RongCloud) GroupSync(ctx context.Context, req *GroupSyncRequest) (*GroupSyncResponse, error)
GroupSync 同步用户所在群组 More details see https://doc.rongcloud.cn/imserver/server/v1/group/sync-group
func (*RongCloud) GroupUserBanWhitelistAdd ¶
func (rc *RongCloud) GroupUserBanWhitelistAdd(ctx context.Context, req *GroupUserBanWhitelistAddRequest) (*GroupUserBanWhitelistAddResponse, error)
GroupUserBanWhitelistAdd 加入群组全体禁言白名单 More details see https://doc.rongcloud.cn/imserver/server/v1/group/add-to-group-ban-whitelist
func (*RongCloud) GroupUserBanWhitelistQuery ¶
func (rc *RongCloud) GroupUserBanWhitelistQuery(ctx context.Context, req *GroupUserBanWhitelistQueryRequest) (*GroupUserBanWhitelistQueryResponse, error)
GroupUserBanWhitelistQuery 查询群组全体禁言白名单 More details see https://doc.rongcloud.cn/imserver/server/v1/group/query-group-ban-whitelist
func (*RongCloud) GroupUserBanWhitelistRollback ¶
func (rc *RongCloud) GroupUserBanWhitelistRollback(ctx context.Context, req *GroupUserBanWhitelistRollbackRequest) (*GroupUserBanWhitelistRollbackResponse, error)
GroupUserBanWhitelistRollback 移出群组全体禁言白名单 More details see https://doc.rongcloud.cn/imserver/server/v1/group/remove-from-group-ban-whitelist
func (*RongCloud) GroupUserGagAdd ¶
func (rc *RongCloud) GroupUserGagAdd(ctx context.Context, req *GroupUserGagAddRequest) (*GroupUserGagAddResponse, error)
GroupUserGagAdd 禁言指定群成员 More details see https://doc.rongcloud.cn/imserver/server/v1/group/gag-user
func (*RongCloud) GroupUserGagList ¶
func (rc *RongCloud) GroupUserGagList(ctx context.Context, req *GroupUserGagListRequest) (*GroupUserGagListResponse, error)
GroupUserGagList 查询群成员禁言列表 More details see https://doc.rongcloud.cn/imserver/server/v1/group/query-gagged-user
func (*RongCloud) GroupUserGagRollback ¶
func (rc *RongCloud) GroupUserGagRollback(ctx context.Context, req *GroupUserGagRollbackRequest) (*GroupUserGagRollbackResponse, error)
GroupUserGagRollback 取消指定群成员禁言 More details see https://doc.rongcloud.cn/imserver/server/v1/group/ungag-user
func (*RongCloud) GroupUserQuery ¶
func (rc *RongCloud) GroupUserQuery(ctx context.Context, req *GroupUserQueryRequest) (*GroupUserQueryResponse, error)
GroupUserQuery 查询群组成员 More details see https://doc.rongcloud.cn/imserver/server/v1/group/query-group-member
func (*RongCloud) MessageBroadcast ¶
func (rc *RongCloud) MessageBroadcast(ctx context.Context, req *MessageBroadcastRequest) (*MessageBroadcastResponse, error)
MessageBroadcast 发送全量用户落地通知 More details see https://doc.rongcloud.cn/imserver/server/v1/system/send-message-broadcast-to-all
func (*RongCloud) MessageChatroomBroadcast ¶
func (rc *RongCloud) MessageChatroomBroadcast(ctx context.Context, req *MessageChatroomBroadcastRequest) (*MessageChatroomBroadcastResponse, error)
MessageChatroomBroadcast 发送全体聊天室广播消息 More details see https://doc.rongcloud.cn/imserver/server/v1/message/send-chatroom-broadcast
func (*RongCloud) MessageChatroomPublish ¶
func (rc *RongCloud) MessageChatroomPublish(ctx context.Context, req *MessageChatroomPublishRequest) (*MessageChatroomPublishResponse, error)
MessageChatroomPublish 发送聊天室消息 More details see https://doc.rongcloud.cn/imserver/server/v1/message/send-chatroom
func (*RongCloud) MessageExpansionDelete ¶
func (rc *RongCloud) MessageExpansionDelete(ctx context.Context, req *MessageExpansionDeleteRequest) (*MessageExpansionDeleteResponse, error)
MessageExpansionDelete 删除单群聊消息扩展 More details see https://doc.rongcloud.cn/imserver/server/v1/message/delete-expansion
func (*RongCloud) MessageExpansionQuery ¶
func (rc *RongCloud) MessageExpansionQuery(ctx context.Context, req *MessageExpansionQueryRequest) (*MessageExpansionQueryResponse, error)
MessageExpansionQuery 获取单群聊消息扩展 More details see https://doc.rongcloud.cn/imserver/server/v1/message/get-expansion
func (*RongCloud) MessageExpansionSet ¶
func (rc *RongCloud) MessageExpansionSet(ctx context.Context, req *MessageExpansionSetRequest) (*MessageExpansionSetResponse, error)
MessageExpansionSet 设置单群聊消息扩展 More details see https://doc.rongcloud.cn/imserver/server/v1/message/set-expansion
func (*RongCloud) MessageGroupPublish ¶
func (rc *RongCloud) MessageGroupPublish(ctx context.Context, req *MessageGroupPublishRequest) (*MessageGroupPublishResponse, error)
MessageGroupPublish 发送群聊消息 More details see https://doc.rongcloud.cn/imserver/server/v1/message/send-group
func (*RongCloud) MessageHistory ¶
func (rc *RongCloud) MessageHistory(ctx context.Context, req *MessageHistoryRequest) (*MessageHistoryResponse, error)
MessageHistory 获取历史消息日志 More details see https://doc.rongcloud.cn/imserver/server/v1/message/get-message-history-log
func (*RongCloud) MessageHistoryDelete ¶
func (rc *RongCloud) MessageHistoryDelete(ctx context.Context, req *MessageHistoryDeleteRequest) (*MessageHistoryDeleteResponse, error)
MessageHistoryDelete 删除历史消息日志 More details see https://doc.rongcloud.cn/imserver/server/v1/message/delete-message-history-log
func (*RongCloud) MessageOnlineBroadcast ¶
func (rc *RongCloud) MessageOnlineBroadcast(ctx context.Context, req *MessageOnlineBroadcastRequest) (*MessageOnlineBroadcastResponse, error)
MessageOnlineBroadcast 发送在线用户广播 More details see https://doc.rongcloud.cn/imserver/server/v1/system/send-message-broadcast-online
func (*RongCloud) MessagePrivatePublish ¶
func (rc *RongCloud) MessagePrivatePublish(ctx context.Context, req *MessagePrivatePublishRequest) (*MessagePrivatePublishResponse, error)
MessagePrivatePublish 发送单聊普通消息 More details see https://doc.rongcloud.cn/imserver/server/v1/message/send-private
func (*RongCloud) MessagePrivatePublishTemplate ¶
func (rc *RongCloud) MessagePrivatePublishTemplate(ctx context.Context, req *MessagePrivatePublishTemplateRequest) (*MessagePrivatePublishTemplateResponse, error)
MessagePrivatePublishTemplate 发送单聊模板消息 More details see https://doc.rongcloud.cn/imserver/server/v1/message/send-private-template
func (*RongCloud) MessageRecall ¶
func (rc *RongCloud) MessageRecall(ctx context.Context, req *MessageRecallRequest) (*MessageRecallResponse, error)
MessageRecall 撤回消息 More details see https://doc.rongcloud.cn/imserver/server/v1/message/msgrecall
func (*RongCloud) MessageSystemPublish ¶
func (rc *RongCloud) MessageSystemPublish(ctx context.Context, req *MessageSystemPublishRequest) (*MessageSystemPublishResponse, error)
MessageSystemPublish 发送系统通知普通消息 More details see https://doc.rongcloud.cn/imserver/server/v1/system/send-private
func (*RongCloud) MessageSystemPublishTemplate ¶
func (rc *RongCloud) MessageSystemPublishTemplate(ctx context.Context, req *MessageSystemPublishTemplateRequest) (*MessageSystemPublishTemplateResponse, error)
MessageSystemPublishTemplate 发送系统通知模板消息 More details see https://doc.rongcloud.cn/imserver/server/v1/system/send-private-template
func (*RongCloud) MessageUltraGroupPublish ¶
func (rc *RongCloud) MessageUltraGroupPublish(ctx context.Context, req *MessageUltraGroupPublishRequest) (*MessageUltraGroupPublishResponse, error)
MessageUltraGroupPublish 发送超级群消息 More details see https://doc.rongcloud.cn/imserver/server/v1/message/send-ultragroup
func (*RongCloud) PrivateURI ¶
PrivateURI 私有云设置 Api 地址
func (*RongCloud) Push ¶
func (rc *RongCloud) Push(ctx context.Context, req *PushRequest) (*PushResponse, error)
Push 发送全量用户不落地通知 More details see https://doc.rongcloud.cn/imserver/server/v1/system/send-push-to-all
func (*RongCloud) PushCustom ¶
func (rc *RongCloud) PushCustom(ctx context.Context, req *PushCustomRequest) (*PushCustomResponse, error)
PushCustom 推送Plus专用推送接口,发送不落地通知 More details see https://doc.rongcloud.cn/imserver/server/v1/push/push-plus
func (*RongCloud) PushUser ¶
func (rc *RongCloud) PushUser(ctx context.Context, req *PushUserRequest) (*PushUserResponse, error)
PushUser 发送指定用户不落地通知 More details see https://doc.rongcloud.cn/imserver/server/v1/system/send-push-by-user
func (*RongCloud) SensitiveWordAdd ¶
func (rc *RongCloud) SensitiveWordAdd(ctx context.Context, req *SensitiveWordAddRequest) (*SensitiveWordAddResponse, error)
SensitiveWordAdd 添加消息敏感词 More details see https://doc.rongcloud.cn/imserver/server/v1/moderation/add-sensitive-word
func (*RongCloud) SensitiveWordBatchDelete ¶
func (rc *RongCloud) SensitiveWordBatchDelete(ctx context.Context, req *SensitiveWordBatchDeleteRequest) (*SensitiveWordBatchDeleteResponse, error)
SensitiveWordBatchDelete 批量移除消息敏感词 More details see https://doc.rongcloud.cn/imserver/server/v1/moderation/batch-remove-sensitive-word
func (*RongCloud) SensitiveWordList ¶
func (rc *RongCloud) SensitiveWordList(ctx context.Context, req *SensitiveWordListRequest) (*SensitiveWordListResponse, error)
SensitiveWordList 查询消息敏感词 More details see https://doc.rongcloud.cn/imserver/server/v1/moderation/query-sensitive-word
func (*RongCloud) SetHttpTransport ¶
func (rc *RongCloud) SetHttpTransport(httpTransport http.RoundTripper)
SetHttpTransport 自定义 http client 传输层参数
func (*RongCloud) StatusMessageGroupPublish ¶
func (rc *RongCloud) StatusMessageGroupPublish(ctx context.Context, req *StatusMessageGroupPublishRequest) (*StatusMessageGroupPublishResponse, error)
StatusMessageGroupPublish 发送群聊状态消息 More details see https://doc.rongcloud.cn/imserver/server/v1/message/send-status-group
func (*RongCloud) StatusMessagePrivatePublish ¶
func (rc *RongCloud) StatusMessagePrivatePublish(ctx context.Context, req *StatusMessagePrivatePublishRequest) (*StatusMessagePrivatePublishResponse, error)
StatusMessagePrivatePublish 发送单聊状态消息 More details see https://doc.rongcloud.cn/imserver/server/v1/message/send-status-private
func (*RongCloud) UltraGroupBannedWhitelistAdd ¶
func (rc *RongCloud) UltraGroupBannedWhitelistAdd(ctx context.Context, req *UltraGroupBannedWhitelistAddRequest) (*UltraGroupBannedWhitelistAddResponse, error)
UltraGroupBannedWhitelistAdd 加入超级群全体禁言白名单 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/add-to-global-ban-whitelist
func (*RongCloud) UltraGroupBannedWhitelistDel ¶
func (rc *RongCloud) UltraGroupBannedWhitelistDel(ctx context.Context, req *UltraGroupBannedWhitelistDelRequest) (*UltraGroupBannedWhitelistDelResponse, error)
UltraGroupBannedWhitelistDel 移出超级群全体禁言白名单 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/remove-from-global-ban-whitelist
func (*RongCloud) UltraGroupBannedWhitelistGet ¶
func (rc *RongCloud) UltraGroupBannedWhitelistGet(ctx context.Context, req *UltraGroupBannedWhitelistGetRequest) (*UltraGroupBannedWhitelistGetResponse, error)
UltraGroupBannedWhitelistGet 查询超级群全体禁言白名单 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/query-global-ban-whitelist
func (*RongCloud) UltraGroupChannelCreate ¶
func (rc *RongCloud) UltraGroupChannelCreate(ctx context.Context, req *UltraGroupChannelCreateRequest) (*UltraGroupChannelCreateResponse, error)
UltraGroupChannelCreate 创建频道 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/create-channel
func (*RongCloud) UltraGroupChannelDel ¶
func (rc *RongCloud) UltraGroupChannelDel(ctx context.Context, req *UltraGroupChannelDelRequest) (*UltraGroupChannelDelResponse, error)
UltraGroupChannelDel 删除频道 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/delete-channel
func (*RongCloud) UltraGroupChannelGet ¶
func (rc *RongCloud) UltraGroupChannelGet(ctx context.Context, req *UltraGroupChannelGetRequest) (*UltraGroupChannelGetResponse, error)
UltraGroupChannelGet 查询频道列表 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/get-channel-list
func (*RongCloud) UltraGroupChannelPrivateUsersAdd ¶
func (rc *RongCloud) UltraGroupChannelPrivateUsersAdd(ctx context.Context, req *UltraGroupChannelPrivateUsersAddRequest) (*UltraGroupChannelPrivateUsersAddResponse, error)
UltraGroupChannelPrivateUsersAdd 添加私有频道成员 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/add-to-private-channel-users
func (*RongCloud) UltraGroupChannelPrivateUsersDel ¶
func (rc *RongCloud) UltraGroupChannelPrivateUsersDel(ctx context.Context, req *UltraGroupChannelPrivateUsersDelRequest) (*UltraGroupChannelPrivateUsersDelResponse, error)
UltraGroupChannelPrivateUsersDel 删除私有频道成员 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/delete-from-private-channel-users
func (*RongCloud) UltraGroupChannelPrivateUsersGet ¶
func (rc *RongCloud) UltraGroupChannelPrivateUsersGet(ctx context.Context, req *UltraGroupChannelPrivateUsersGetRequest) (*UltraGroupChannelPrivateUsersGetResponse, error)
UltraGroupChannelPrivateUsersGet 查询私有频道成员列表 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/get-private-channel-users
func (*RongCloud) UltraGroupChannelTypeChange ¶
func (rc *RongCloud) UltraGroupChannelTypeChange(ctx context.Context, req *UltraGroupChannelTypeChangeRequest) (*UltraGroupChannelTypeChangeResponse, error)
UltraGroupChannelTypeChange 变更频道类型 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/change-channel-type
func (*RongCloud) UltraGroupChannelUserGroupBind ¶
func (rc *RongCloud) UltraGroupChannelUserGroupBind(ctx context.Context, req *UltraGroupChannelUserGroupBindRequest) (*UltraGroupChannelUserGroupBindResponse, error)
UltraGroupChannelUserGroupBind 超级群绑定频道与用户组 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/bind-channel-to-usergroup
func (*RongCloud) UltraGroupChannelUserGroupQuery ¶
func (rc *RongCloud) UltraGroupChannelUserGroupQuery(ctx context.Context, req *UltraGroupChannelUserGroupQueryRequest) (*UltraGroupChannelUserGroupQueryResponse, error)
UltraGroupChannelUserGroupQuery 超级群查询频道绑定的用户组 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/query-channel-bound-usergroup
func (*RongCloud) UltraGroupChannelUserGroupUnbind ¶
func (rc *RongCloud) UltraGroupChannelUserGroupUnbind(ctx context.Context, req *UltraGroupChannelUserGroupUnbindRequest) (*UltraGroupChannelUserGroupUnbindResponse, error)
UltraGroupChannelUserGroupUnbind 超级群解绑频道与用户组 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/unbind-channel-from-usergroup
func (*RongCloud) UltraGroupCreate ¶
func (rc *RongCloud) UltraGroupCreate(ctx context.Context, req *UltraGroupCreateRequest) (*UltraGroupCreateResponse, error)
UltraGroupCreate 创建超级群 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/create-ultragroup
func (*RongCloud) UltraGroupDis ¶
func (rc *RongCloud) UltraGroupDis(ctx context.Context, req *UltraGroupDisRequest) (*UltraGroupDisResponse, error)
UltraGroupDis 解散超级群 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/dismiss-ultragroup
func (*RongCloud) UltraGroupGlobalBannedGet ¶
func (rc *RongCloud) UltraGroupGlobalBannedGet(ctx context.Context, req *UltraGroupGlobalBannedGetRequest) (*UltraGroupGlobalBannedGetResponse, error)
UltraGroupGlobalBannedGet 查询超级群全体禁言 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/query-ultragroup-global-ban
func (*RongCloud) UltraGroupGlobalBannedSet ¶
func (rc *RongCloud) UltraGroupGlobalBannedSet(ctx context.Context, req *UltraGroupGlobalBannedSetRequest) (*UltraGroupGlobalBannedSetResponse, error)
UltraGroupGlobalBannedSet 设置超级群全体禁言 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/set-ultragroup-global-ban
func (*RongCloud) UltraGroupHismsgMsgIdQuery ¶
func (rc *RongCloud) UltraGroupHismsgMsgIdQuery(ctx context.Context, req *UltraGroupHisMsgMsgIdQueryRequest) (*UltraGroupHisMsgMsgIdQueryResponse, error)
UltraGroupHismsgMsgIdQuery 搜索超级群消息上下文 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/query-history-by-message-uid
func (*RongCloud) UltraGroupHismsgQuery ¶
func (rc *RongCloud) UltraGroupHismsgQuery(ctx context.Context, req *UltraGroupHismsgQueryRequest) (*UltraGroupHismsgQueryResponse, error)
UltraGroupHismsgQuery 搜索超级群消息 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/query-history-messages
func (*RongCloud) UltraGroupJoin ¶
func (rc *RongCloud) UltraGroupJoin(ctx context.Context, req *UltraGroupJoinRequest) (*UltraGroupJoinResponse, error)
UltraGroupJoin 加入超级群 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/join-ultragroup
func (*RongCloud) UltraGroupMemberExist ¶
func (rc *RongCloud) UltraGroupMemberExist(ctx context.Context, req *UltraGroupMemberExistRequest) (*UltraGroupMemberExistResponse, error)
UltraGroupMemberExist 查询用户是否为群成员 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/query-member
func (*RongCloud) UltraGroupMessageExpansionDelete ¶
func (rc *RongCloud) UltraGroupMessageExpansionDelete(ctx context.Context, req *UltraGroupMessageExpansionDeleteRequest) (*UltraGroupMessageExpansionDeleteResponse, error)
UltraGroupMessageExpansionDelete 删除超级群消息扩展 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/delete-expansion
func (*RongCloud) UltraGroupMessageExpansionQuery ¶
func (rc *RongCloud) UltraGroupMessageExpansionQuery(ctx context.Context, req *UltraGroupMessageExpansionQueryRequest) (*UltraGroupMessageExpansionQueryResponse, error)
UltraGroupMessageExpansionQuery 获取超级群消息扩展 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/get-expansion
func (*RongCloud) UltraGroupMessageExpansionSet ¶
func (rc *RongCloud) UltraGroupMessageExpansionSet(ctx context.Context, req *UltraGroupMessageExpansionSetRequest) (*UltraGroupMessageExpansionSetResponse, error)
UltraGroupMessageExpansionSet 设置超级群消息扩展 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/set-expansion
func (*RongCloud) UltraGroupMsgGet ¶
func (rc *RongCloud) UltraGroupMsgGet(ctx context.Context, req *UltraGroupMsgGetRequest) (*UltraGroupMsgGetResponse, error)
UltraGroupMsgGet 获取指定超级群消息内容 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/get-messages-by-uid
func (*RongCloud) UltraGroupMsgModify ¶
func (rc *RongCloud) UltraGroupMsgModify(ctx context.Context, req *UltraGroupMsgModifyRequest) (*UltraGroupMsgModifyResponse, error)
UltraGroupMsgModify 修改超级群消息 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/modify-message
func (*RongCloud) UltraGroupNotDisturbGet ¶
func (rc *RongCloud) UltraGroupNotDisturbGet(ctx context.Context, req *UltraGroupNotDisturbGetRequest) (*UltraGroupNotDisturbGetResponse, error)
UltraGroupNotDisturbGet 查询默认免打扰配置 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/get-do-not-disturb
func (*RongCloud) UltraGroupNotDisturbSet ¶
func (rc *RongCloud) UltraGroupNotDisturbSet(ctx context.Context, req *UltraGroupNotDisturbSetRequest) (*UltraGroupNotDisturbSetResponse, error)
UltraGroupNotDisturbSet 设置群/频道默认免打扰 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/set-do-not-disturb
func (*RongCloud) UltraGroupQuit ¶
func (rc *RongCloud) UltraGroupQuit(ctx context.Context, req *UltraGroupQuitRequest) (*UltraGroupQuitResponse, error)
UltraGroupQuit 退出超级群 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/quit-ultragroup
func (*RongCloud) UltraGroupRefresh ¶
func (rc *RongCloud) UltraGroupRefresh(ctx context.Context, req *UltraGroupRefreshRequest) (*UltraGroupRefreshResponse, error)
UltraGroupRefresh 刷新超级群信息 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/refresh-ultragroup-info
func (*RongCloud) UltraGroupUserBannedAdd ¶
func (rc *RongCloud) UltraGroupUserBannedAdd(ctx context.Context, req *UltraGroupUserBannedAddRequest) (*UltraGroupUserBannedAddResponse, error)
UltraGroupUserBannedAdd 禁言指定超级群成员 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/ban-user
func (*RongCloud) UltraGroupUserBannedDel ¶
func (rc *RongCloud) UltraGroupUserBannedDel(ctx context.Context, req *UltraGroupUserBannedDelRequest) (*UltraGroupUserBannedDelResponse, error)
UltraGroupUserBannedDel 取消指定超级群成员禁言 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/unban-user
func (*RongCloud) UltraGroupUserBannedGet ¶
func (rc *RongCloud) UltraGroupUserBannedGet(ctx context.Context, req *UltraGroupUserBannedGetRequest) (*UltraGroupUserBannedGetResponse, error)
UltraGroupUserBannedGet 查询超级群成员禁言列表 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/query-banned-user-list
func (*RongCloud) UltraGroupUserChannelQuery ¶
func (rc *RongCloud) UltraGroupUserChannelQuery(ctx context.Context, req *UltraGroupUserChannelQueryRequest) (*UltraGroupUserChannelQueryResponse, error)
UltraGroupUserChannelQuery 查询用户所属的私有频道 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/query-channel-by-user
func (*RongCloud) UltraGroupUserGroupAdd ¶
func (rc *RongCloud) UltraGroupUserGroupAdd(ctx context.Context, req *UltraGroupUserGroupAddRequest) (*UltraGroupUserGroupAddResponse, error)
UltraGroupUserGroupAdd 超级群创建用户组 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/create-usergroup
func (*RongCloud) UltraGroupUserGroupChannelQuery ¶
func (rc *RongCloud) UltraGroupUserGroupChannelQuery(ctx context.Context, req *UltraGroupUserGroupChannelQueryRequest) (*UltraGroupUserGroupChannelQueryResponse, error)
UltraGroupUserGroupChannelQuery 超级群查询用户组绑定的频道 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/query-usergroup-bound-channel
func (*RongCloud) UltraGroupUserGroupDel ¶
func (rc *RongCloud) UltraGroupUserGroupDel(ctx context.Context, req *UltraGroupUserGroupDelRequest) (*UltraGroupUserGroupDelResponse, error)
UltraGroupUserGroupDel 超级群删除用户组 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/delete-usergroup
func (*RongCloud) UltraGroupUserGroupQuery ¶
func (rc *RongCloud) UltraGroupUserGroupQuery(ctx context.Context, req *UltraGroupUserGroupQueryRequest) (*UltraGroupUserGroupQueryResponse, error)
UltraGroupUserGroupQuery 超级群查询用户组列表 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/query-usergroup
func (*RongCloud) UltraGroupUserGroupUserAdd ¶
func (rc *RongCloud) UltraGroupUserGroupUserAdd(ctx context.Context, req *UltraGroupUserGroupUserAddRequest) (*UltraGroupUserGroupUserAddResponse, error)
UltraGroupUserGroupUserAdd 超级群用户组添加用户 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/add-user-to-usergroup
func (*RongCloud) UltraGroupUserGroupUserDel ¶
func (rc *RongCloud) UltraGroupUserGroupUserDel(ctx context.Context, req *UltraGroupUserGroupUserDelRequest) (*UltraGroupUserGroupUserDelResponse, error)
UltraGroupUserGroupUserDel 超级群用户组移出用户 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/remove-user-from-usergroup
func (*RongCloud) UltraGroupUserUserGroupQuery ¶
func (rc *RongCloud) UltraGroupUserUserGroupQuery(ctx context.Context, req *UltraGroupUserUserGroupQueryRequest) (*UltraGroupUserUserGroupQueryResponse, error)
UltraGroupUserUserGroupQuery 超级群查询用户所属用户组 More details see https://doc.rongcloud.cn/imserver/server/v1/ultragroup/query-usergroup-by-user
func (*RongCloud) UserBlacklistAdd ¶
func (rc *RongCloud) UserBlacklistAdd(ctx context.Context, req *UserBlacklistAddRequest) (*UserBlacklistAddResponse, error)
UserBlacklistAdd 添加用户到黑名单 More details see https://doc.rongcloud.cn/imserver/server/v1/user/add-to-blacklist
func (*RongCloud) UserBlacklistQuery ¶
func (rc *RongCloud) UserBlacklistQuery(ctx context.Context, req *UserBlacklistQueryRequest) (*UserBlacklistQueryResponse, error)
UserBlacklistQuery 获取黑名单用户列表 More details see https://doc.rongcloud.cn/imserver/server/v1/user/query-blacklist
func (*RongCloud) UserBlacklistRemove ¶
func (rc *RongCloud) UserBlacklistRemove(ctx context.Context, req *UserBlacklistRemoveRequest) (*UserBlacklistRemoveResponse, error)
UserBlacklistRemove 移除黑名单中用户 More details see https://doc.rongcloud.cn/imserver/server/v1/user/remove-from-blacklist
func (*RongCloud) UserBlock ¶
func (rc *RongCloud) UserBlock(ctx context.Context, req *UserBlockRequest) (*UserBlockResponse, error)
UserBlock 封禁用户 More details see https://doc.rongcloud.cn/imserver/server/v1/user/block
func (*RongCloud) UserBlockPushPeriodDelete ¶
func (rc *RongCloud) UserBlockPushPeriodDelete(ctx context.Context, req *UserBlockPushPeriodDeleteRequest) (*UserBlockPushPeriodDeleteResponse, error)
UserBlockPushPeriodDelete 删除用户免打扰时段 More details see https://doc.rongcloud.cn/imserver/server/v1/push/delete-push-disabled-period
func (*RongCloud) UserBlockPushPeriodGet ¶
func (rc *RongCloud) UserBlockPushPeriodGet(ctx context.Context, req *UserBlockPushPeriodGetRequest) (*UserBlockPushPeriodGetResponse, error)
UserBlockPushPeriodGet 查询用户免打扰时段 More details see https://doc.rongcloud.cn/imserver/server/v1/push/get-push-disabled-period
func (*RongCloud) UserBlockPushPeriodSet ¶
func (rc *RongCloud) UserBlockPushPeriodSet(ctx context.Context, req *UserBlockPushPeriodSetRequest) (*UserBlockPushPeriodSetResponse, error)
UserBlockPushPeriodSet 设置用户免打扰时段 More details see https://doc.rongcloud.cn/imserver/server/v1/push/set-push-disabled-period
func (*RongCloud) UserBlockQuery ¶
func (rc *RongCloud) UserBlockQuery(ctx context.Context, req *UserBlockQueryRequest) (*UserBlockQueryResponse, error)
UserBlockQuery 获取封禁用户列表 More details see https://doc.rongcloud.cn/imserver/server/v1/user/query-blocked-list
func (*RongCloud) UserChatFBQueryList ¶
func (rc *RongCloud) UserChatFBQueryList(ctx context.Context, req *UserChatFBQueryListRequest) (*UserChatFBQueryListResponse, error)
UserChatFBQueryList 查询单聊禁言用户列表 More details see https://doc.rongcloud.cn/imserver/server/v1/user/query-banned-list
func (*RongCloud) UserChatFBSet ¶
func (rc *RongCloud) UserChatFBSet(ctx context.Context, req *UserChatFBSetRequest) (*UserChatFBSetResponse, error)
UserChatFBSet 设置用户单聊禁言 More details see https://doc.rongcloud.cn/imserver/server/v1/user/ban
func (*RongCloud) UserCheckOnline ¶
func (rc *RongCloud) UserCheckOnline(ctx context.Context, req *UserCheckOnlineRequest) (*UserCheckOnlineResponse, error)
UserCheckOnline 查询用户在线状态 More details see https://doc.rongcloud.cn/imserver/server/v1/user/check-online-status-by-user
func (*RongCloud) UserDeactivate ¶
func (rc *RongCloud) UserDeactivate(ctx context.Context, req *UserDeactivateRequest) (*UserDeactivateResponse, error)
UserDeactivate 注销用户 More details see https://doc.rongcloud.cn/imserver/server/v1/user/deactivate
func (*RongCloud) UserDeactivateQuery ¶
func (rc *RongCloud) UserDeactivateQuery(ctx context.Context, req *UserDeactivateQueryRequest) (*UserDeactivateQueryResponse, error)
UserDeactivateQuery 查询已注销用户 More details see https://doc.rongcloud.cn/imserver/server/v1/user/query-deactivated-list
func (*RongCloud) UserGetToken ¶
func (rc *RongCloud) UserGetToken(ctx context.Context, req *UserGetTokenRequest) (*UserGetTokenResponse, error)
UserGetToken 注册用户 More details see https://doc.rongcloud.cn/imserver/server/v1/user/register
func (*RongCloud) UserGroupQuery ¶
func (rc *RongCloud) UserGroupQuery(ctx context.Context, req *UserGroupQueryRequest) (*UserGroupQueryResponse, error)
UserGroupQuery 查询用户所在群组 More details see https://doc.rongcloud.cn/imserver/server/v1/group/query-group-by-user
func (*RongCloud) UserReactivate ¶
func (rc *RongCloud) UserReactivate(ctx context.Context, req *UserReactivateRequest) (*UserReactivateResponse, error)
UserReactivate 重新激活用户 ID More details see https://doc.rongcloud.cn/imserver/server/v1/user/reactivate
func (*RongCloud) UserRefresh ¶
func (rc *RongCloud) UserRefresh(ctx context.Context, req *UserRefreshRequest) (*UserRefreshResponse, error)
UserRefresh 修改用户信息 More details see https://doc.rongcloud.cn/imserver/server/v1/user/modify
func (*RongCloud) UserRemarksDel ¶
func (rc *RongCloud) UserRemarksDel(ctx context.Context, req *UserRemarksDelRequest) (*UserRemarksDelResponse, error)
UserRemarksDel 删除用户级推送备注名 More details see https://doc.rongcloud.cn/imserver/server/v1/user/delete-remark-for-push
func (*RongCloud) UserRemarksGet ¶
func (rc *RongCloud) UserRemarksGet(ctx context.Context, req *UserRemarksGetRequest) (*UserRemarksGetResponse, error)
UserRemarksGet 查询用户级推送备注名 More details see https://doc.rongcloud.cn/imserver/server/v1/user/get-remark-for-push
func (*RongCloud) UserRemarksSet ¶
func (rc *RongCloud) UserRemarksSet(ctx context.Context, req *UserRemarksSetRequest) (*UserRemarksSetResponse, error)
UserRemarksSet 设置用户级推送备注名 More details see https://doc.rongcloud.cn/imserver/server/v1/user/set-remark-for-push
func (*RongCloud) UserTagBatchSet ¶
func (rc *RongCloud) UserTagBatchSet(ctx context.Context, req *UserTagBatchSetRequest) (*UserTagBatchSetResponse, error)
UserTagBatchSet 批量设置用户标签 More details see https://doc.rongcloud.cn/imserver/server/v1/user/batch-set-user-tag
func (*RongCloud) UserTagSet ¶
func (rc *RongCloud) UserTagSet(ctx context.Context, req *UserTagSetRequest) (*UserTagSetResponse, error)
UserTagSet 设置用户标签 More details see https://doc.rongcloud.cn/imserver/server/v1/user/set-user-tag
func (*RongCloud) UserTagsGet ¶
func (rc *RongCloud) UserTagsGet(ctx context.Context, req *UserTagsGetRequest) (*UserTagsGetResponse, error)
UserTagsGet 获取用户标签 More details see https://doc.rongcloud.cn/imserver/server/v1/user/get-user-tag
func (*RongCloud) UserTokenExpire ¶
func (rc *RongCloud) UserTokenExpire(ctx context.Context, req *UserTokenExpireRequest) (*UserTokenExpireResponse, error)
UserTokenExpire 作废Token More details see https://doc.rongcloud.cn/imserver/server/v1/user/expire
func (*RongCloud) UserUnBlock ¶
func (rc *RongCloud) UserUnBlock(ctx context.Context, req *UserUnBlockRequest) (*UserUnBlockResponse, error)
UserUnBlock 解除封禁 More details see https://doc.rongcloud.cn/imserver/server/v1/user/block
func (*RongCloud) UserWhitelistAdd ¶
func (rc *RongCloud) UserWhitelistAdd(ctx context.Context, req *UserWhitelistAddRequest) (*UserWhitelistAddResponse, error)
UserWhitelistAdd 添加用户到白名单 More details see https://doc.rongcloud.cn/imserver/server/v1/user/add-to-whitelist
func (*RongCloud) UserWhitelistQuery ¶
func (rc *RongCloud) UserWhitelistQuery(ctx context.Context, req *UserWhitelistQueryRequest) (*UserWhitelistQueryResponse, error)
UserWhitelistQuery 查询白名单中用户列表 More details see https://doc.rongcloud.cn/imserver/server/v1/user/query-whitelist
func (*RongCloud) UserWhitelistRemove ¶
func (rc *RongCloud) UserWhitelistRemove(ctx context.Context, req *UserWhitelistRemoveRequest) (*UserWhitelistRemoveResponse, error)
UserWhitelistRemove 移除白名单中用户 More details see https://doc.rongcloud.cn/imserver/server/v1/user/remove-from-whitelist
type SensitiveWord ¶
type SensitiveWordAddRequest ¶
type SensitiveWordAddResponse ¶
type SensitiveWordAddResponse struct { CodeResult // contains filtered or unexported fields }
type SensitiveWordBatchDeleteRequest ¶
type SensitiveWordBatchDeleteRequest struct { // [必传] 敏感词数组,一次最多移除 50 个敏感词。 Words []string `url:"words,omitempty"` }
type SensitiveWordBatchDeleteResponse ¶
type SensitiveWordBatchDeleteResponse struct { CodeResult // contains filtered or unexported fields }
type SensitiveWordListRequest ¶
type SensitiveWordListRequest struct { // 查询敏感词的类型。0 为查询替换敏感词。1 为查询屏蔽敏感词。2 为查询全部敏感词。默认为 1。 Type *string `url:"type,omitempty"` }
type SensitiveWordListResponse ¶
type SensitiveWordListResponse struct { CodeResult Words []*SensitiveWord `json:"words"` // contains filtered or unexported fields }
type StatusMessageGroupPublishRequest ¶
type StatusMessageGroupPublishRequest struct { // [必传] 发送人用户 ID,通过 Server API 非群成员也可以向群组中发送消息。 FromUserId *string `url:"fromUserId,omitempty"` // [必传] 接收群ID,提供多个本参数可以实现向多群发送消息,最多不超过 3 个群组。 ToGroupId []string `url:"toGroupId,omitempty"` // [必传] 消息类型参数的SDK封装, 例如: TXTMsg(文本消息) RCMsg RCMsg `url:"-"` // 是否向发件人客户端同步已发消息。1 表示同步,默认值为 0,即不同步。注意,该接口用于发送状态消息,因此仅支持在发件人已登陆客户端(在线)的情况下同步已发消息。 IsIncludeSender *int `url:"isIncludeSender,omitempty"` }
type StatusMessageGroupPublishResponse ¶
type StatusMessageGroupPublishResponse struct { CodeResult // contains filtered or unexported fields }
type StatusMessagePrivatePublishRequest ¶
type StatusMessagePrivatePublishRequest struct { // [必传] 发送人用户 ID。 FromUserId *string `url:"fromUserId,omitempty"` // [必传] 接收用户 ID,支持向多人发送消息,每次上限为 1000 人。 ToUserIds []string `url:"toUserId,omitempty"` // [必传] 消息类型参数的SDK封装, 例如: TXTMsg(文本消息), HQVCMsg(高清语音消息) RCMsg RCMsg `url:"-"` // 是否过滤发送人黑名单列表,0 表示为不过滤、 1 表示为过滤,默认为 0 不过滤。 VerifyBlacklist *int `url:"verifyBlacklist,omitempty"` // 是否向发件人客户端同步已发消息。1 表示同步,默认值为 0,即不同步。注意,该接口用于发送状态消息,因此仅支持在发件人已登陆客户端(在线)的情况下同步已发消息。 IsIncludeSender *int `url:"isIncludeSender,omitempty"` }
type StatusMessagePrivatePublishResponse ¶
type StatusMessagePrivatePublishResponse struct { CodeResult // contains filtered or unexported fields }
type SyncGroups ¶
type SyncGroups []Group
func (SyncGroups) EncodeValues ¶
func (r SyncGroups) EncodeValues(key string, v *url.Values) error
type TXTMsg ¶
type TXTMsg struct { Content string `json:"content,omitempty"` // [必传] 文字消息的文字内容,包括表情。 User *MsgUserInfo `json:"user,omitempty"` // 消息中携带的消息发送者的用户信息。一般情况下不建议在消息中携带用户信息。建议仅在直播场景下使用。 Extra string `json:"extra,omitempty"` // 扩展信息,可以放置任意的数据内容,也可以去掉此属性。 }
TXTMsg 消息
func (*TXTMsg) ObjectName ¶
type UltraGroupBannedWhitelistAddResponse ¶
type UltraGroupBannedWhitelistAddResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupBannedWhitelistDelResponse ¶
type UltraGroupBannedWhitelistDelResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupBannedWhitelistGetResponse ¶
type UltraGroupBannedWhitelistGetResponse struct { CodeResult Users []*UltraGroupBannedWhitelistUser `json:"users"` // 用户列表 // contains filtered or unexported fields }
type UltraGroupBannedWhitelistUser ¶
type UltraGroupBannedWhitelistUser struct {
Id string `json:"id"` // 用户 ID
}
type UltraGroupChannel ¶
type UltraGroupChannelCreateResponse ¶
type UltraGroupChannelCreateResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupChannelDelResponse ¶
type UltraGroupChannelDelResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupChannelGetResponse ¶
type UltraGroupChannelGetResponse struct { CodeResult ChannelList []*UltraGroupChannel `json:"channelList"` // 频道列表 // contains filtered or unexported fields }
type UltraGroupChannelPrivateUsersAddResponse ¶
type UltraGroupChannelPrivateUsersAddResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupChannelPrivateUsersDelResponse ¶
type UltraGroupChannelPrivateUsersDelResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupChannelPrivateUsersGetResponse ¶
type UltraGroupChannelPrivateUsersGetResponse struct { CodeResult Users []string `json:"users"` // 用户 ID 列表 // contains filtered or unexported fields }
type UltraGroupChannelTypeChangeResponse ¶
type UltraGroupChannelTypeChangeResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupChannelUserGroupBindResponse ¶
type UltraGroupChannelUserGroupBindResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupChannelUserGroupQueryResponse ¶
type UltraGroupChannelUserGroupQueryResponse struct { CodeResult Data []string `json:"data"` // 用户组 ID 列表。 // contains filtered or unexported fields }
type UltraGroupChannelUserGroupUnbindResponse ¶
type UltraGroupChannelUserGroupUnbindResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupCreateRequest ¶
type UltraGroupCreateRequest struct { UserId *string `url:"userId,omitempty"` // [必传] 需要加入的用户 ID,创建后同时加入超级群。仅支持传入一个用户 ID。 GroupId *string `url:"groupId,omitempty"` // [必传] 超级群 ID,最大长度 64 个字符。支持大小写英文字母与数字的组合。 GroupName *string `url:"groupName,omitempty"` // [必传] 超级群 ID 对应的名称,用于在发送群组消息显示远程 Push 通知时使用,如超级群名称改变需要调用刷新超级群信息接口同步。 }
type UltraGroupCreateResponse ¶
type UltraGroupCreateResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupDisRequest ¶
type UltraGroupDisRequest struct { // [必传] 要解散的超级群 ID。 GroupId *string `url:"groupId,omitempty"` }
type UltraGroupDisResponse ¶
type UltraGroupDisResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupGlobalBannedGetResponse ¶
type UltraGroupGlobalBannedGetResponse struct { CodeResult Status bool `json:"status"` // true 为禁言,false 未禁言 // contains filtered or unexported fields }
type UltraGroupGlobalBannedSetResponse ¶
type UltraGroupGlobalBannedSetResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupHisMsg ¶
type UltraGroupHisMsg struct { GroupId string `json:"groupId"` // 超级群 ID。 BusChannel string `json:"busChannel"` // 超级群频道 ID。 FromUserId string `json:"fromUserId"` // 消息发送方用户 ID。 MsgUID string `json:"msgUID"` // 消息 UID。 MsgTime int64 `json:"msgTime"` // 发送消息的时间戳。Unix 时间戳(毫秒)。 ObjectName string `json:"objectName"` // 消息类型。详见消息类型概述。 ConversationType int `json:"conversationType"` // 会话类型。超级群的会话类型为 10。 Content string `json:"content"` // 消息内容,JSON 格式。具体结构可通过 objectName 字段在 消息类型概述 中查询。 Expansion bool `json:"expansion"` // 消息是否已被设置为可扩展消息。true 表示可扩展。false 表示不可扩展。 ExtraContent map[string]string `json:"extraContent"` // 消息扩展的内容,JSON 结构的 Key、Value 对,如:{"type":"3"}。Key 最大 32 个字符,支持大小写英文字母、数字、 特殊字符+ = - _ 的组合方式,不支持汉字。Value 最大 4096 个字符。 }
type UltraGroupHisMsgMsgIdQueryRequest ¶
type UltraGroupHisMsgMsgIdQueryRequest struct { // [必传] 超级群 ID,请确保该超级群 ID 已存在。 GroupId *string `url:"groupId,omitempty"` // [必传] 频道 ID。 BusChannel *string `url:"busChannel,omitempty"` // [必传] 消息的 UID。返回结果中会包含该 msgUID 的消息。例如,该接口默认查询该消息前面 10 条和后面 10 条消息,默认情况下返回 21 条消息。 MsgUID *string `url:"msgUID,omitempty"` // 需要查询的上文消息数量。例如传入 20,即表示需要获取 msgUID 前的 20 消息数量。取值范围:0-50,默认 10。0 表示不需要获取 msgUID 前的消息。 PrevNum *int `url:"prevNum,omitempty"` // 需要查询的下文消息数量。例如传入 20,即表示需要获取 msgUID 前的 20 消息数量。取值范围:0-50,默认 10。0 表示不需要获取 msgUID 后的消息。 LastNum *int `url:"lastNum,omitempty"` }
type UltraGroupHisMsgMsgIdQueryResponse ¶
type UltraGroupHisMsgMsgIdQueryResponse struct { CodeResult Data []*UltraGroupHisMsg `json:"data"` // 查询结果。按消息时间戳升序排列。 // contains filtered or unexported fields }
type UltraGroupHismsgQueryRequest ¶
type UltraGroupHismsgQueryRequest struct { // [必传] 超级群 ID,请确保该超级群 ID 已存在。 GroupId *string `url:"groupId,omitempty"` // [必传] 频道 ID。 BusChannel *string `url:"busChannel,omitempty"` // [必传] 查询开始时间。Unix 时间戳(毫秒)。 StartTime *int64 `url:"startTime,omitempty"` // [必传] 查询结束时间。Unix 时间戳(毫秒)。需要保证比 startTime 大,且两者之间时间跨度最大14 天。 EndTime *int64 `url:"endTime,omitempty"` // 发送者用户 ID。不传该字段,查所有用户发送的历史消息。如果传入该参数,表示只查该用户 ID 发的历史消息。 FromUserId *string `url:"fromUserId,omitempty"` // 分页返回的页面大小。默认 20 条,最大 100 条。 PageSize *int `url:"pageSize,omitempty"` }
type UltraGroupHismsgQueryResponse ¶
type UltraGroupHismsgQueryResponse struct { CodeResult Data []*UltraGroupMsgData `json:"data"` // 查询结果。按消息时间戳升序排列。 // contains filtered or unexported fields }
type UltraGroupJoinRequest ¶
type UltraGroupJoinResponse ¶
type UltraGroupJoinResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupMemberExistResponse ¶
type UltraGroupMemberExistResponse struct { CodeResult Status bool `json:"status"` // 用户是否在超级群中。true 表示在超级群中,false 表示不在超级群中。 // contains filtered or unexported fields }
type UltraGroupMessageExpansionDeleteRequest ¶
type UltraGroupMessageExpansionDeleteRequest struct { // [必传] 消息唯一标识 ID,可通过全量消息路由功能获取。详见全量消息路由。 MsgUID *string `url:"msgUID,omitempty"` // [必传] 操作者用户 ID,即需要为指定消息(msgUID)删除扩展信息的用户 ID。 UserId *string `url:"userId,omitempty"` // 超级群频道 ID。具体使用要求如下: // 如果发送消息时指定了频道 ID,则必传频道 ID,否则无法成功设置扩展。 // 如果发送消息时未指定频道 ID,则不可传入频道 ID,否则无法成功设置扩展。 BusChannel *string `url:"busChannel,omitempty"` // [必传] 超级群 ID。 GroupId *string `url:"groupId,omitempty"` // [必传] 需要删除的扩展信息的 Key 值,一次最多可以删除 100 个扩展信息 ExtraKey *string `url:"extraKey,omitempty"` }
type UltraGroupMessageExpansionDeleteResponse ¶
type UltraGroupMessageExpansionDeleteResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupMessageExpansionQueryRequest ¶
type UltraGroupMessageExpansionQueryRequest struct { // [必传] 消息唯一标识 ID,可通过全量消息路由功能获取。详见全量消息路由。 MsgUID *string `url:"msgUID,omitempty"` // 超级群频道 ID。具体使用要求如下: // 如果发送消息时指定了频道 ID,则必传频道 ID,否则无法成功获取扩展。 // 如果发送消息时未指定频道 ID,则不可传入频道 ID,否则无法成功获取扩展 BusChannel *string `url:"busChannel,omitempty"` // [必传] 超级群 ID。 GroupId *string `url:"groupId,omitempty"` // 页数,默认返回 300 个扩展信息。 PageNo *int `url:"pageNo,omitempty"` }
type UltraGroupMessageExpansionQueryResponse ¶
type UltraGroupMessageExpansionQueryResponse struct { CodeResult ExtraContent map[string]*MessageExpansionQueryExtraContentValue `json:"extraContent"` // contains filtered or unexported fields }
type UltraGroupMessageExpansionSetRequest ¶
type UltraGroupMessageExpansionSetRequest struct { // [必传] 消息唯一标识 ID,可通过全量消息路由功能获取。详见全量消息路由。 MsgUID *string `url:"msgUID,omitempty"` // [必传] 操作者用户 ID,即需要为指定消息(msgUID)删除扩展信息的用户 ID。 UserId *string `url:"userId,omitempty"` // 超级群频道 ID。具体使用要求如下: // 如果发送消息时指定了频道 ID,则必传频道 ID,否则无法成功设置扩展。 // 如果发送消息时未指定频道 ID,则不可传入频道 ID,否则无法成功设置扩展。 BusChannel *string `url:"busChannel,omitempty"` // [必传] 超级群 ID。 GroupId *string `url:"groupId,omitempty"` // [必传] 需要删除的扩展信息的 Key 值,一次最多可以删除 100 个扩展信息 ExtraKeyVal *string `url:"extraKeyVal,omitempty"` }
type UltraGroupMessageExpansionSetResponse ¶
type UltraGroupMessageExpansionSetResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupMsg ¶
type UltraGroupMsgData ¶
type UltraGroupMsgData struct { FromUserId string `json:"fromUserId"` // 发送人用户 ID。 GroupId string `json:"groupId"` // 超级群 ID。 SentTime int64 `json:"sentTime"` // 消息发送时间。Unix 时间戳,单位为毫秒。 BusChannel string `json:"busChannel"` // 频道 ID。 MsgUID string `json:"msgUID"` // 全局唯一消息 ID,即消息 UID。 ObjectName string `json:"objectName"` // 消息类型的唯一标识。 Content string `json:"content"` // 消息的内容。 Expansion bool `json:"expansion"` // 是否为扩展消息。 ExtraContent string `json:"extraContent"` // 消息扩展的内容,JSON 结构的 Key、Value 对,如:{"type":"3"}。Key 最大 32 个字符,支持大小写英文字母、数字、 特殊字符+ = - _ 的组合方式,不支持汉字。Value 最大 4096 个字符。 }
type UltraGroupMsgGetRequest ¶
type UltraGroupMsgGetRequest struct { GroupId *string `json:"groupId,omitempty" url:"groupId,omitempty"` // [必传] 超级群 ID Msgs []*UltraGroupMsg `json:"msgs,omitempty" url:"-"` // [必传] 消息的查询参数,单次请求最多获取 20 条消息。 }
type UltraGroupMsgGetResponse ¶
type UltraGroupMsgGetResponse struct { CodeResult Data []*UltraGroupMsgData `json:"data"` // 消息数组。 // contains filtered or unexported fields }
type UltraGroupMsgModifyRequest ¶
type UltraGroupMsgModifyRequest struct { // [必传] 消息所属的超级群 ID。 GroupId *string `url:"groupId,omitempty"` // 消息所属的超级群的会话频道 ID。仅在消息属于超级群默认频道(RCDefault)时可以不传该参数。 BusChannel *string `url:"busChannel,omitempty"` // [必传] 消息发送者 ID。 FromUserId *string `url:"fromUserId,omitempty"` // [必传] 消息唯一标识 ID,可通过全量消息路由功能获取。 MsgUID *string `url:"msgUID,omitempty"` // [必传] 修改后的消息内容,单条消息最大 128k。消息类型无法修改。如果改前为文本消息内容体,则传入的新消息内容体必须同样为文本消息内容体。 Content *string `url:"content,omitempty"` }
type UltraGroupMsgModifyResponse ¶
type UltraGroupMsgModifyResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupNotDisturbGetResponse ¶
type UltraGroupNotDisturbGetResponse struct { CodeResult // 超级群 ID GroupId string `json:"groupId"` // 频道 ID,不传时为群的默认免打扰设置 BusChannel string `json:"busChannel"` // -1:全部消息通知 // 0:未设置(用户未设置时为此状态,为全部消息都通知,在此状态下,如设置了超级群默认状态以超级群的默认设置为准) // 1:仅针对 @ 消息进行通知,包括 @指定用户 和 @所有人 // 2:仅针对 @ 指定用户消息进行通知,且仅通知被 @ 的指定的用户进行通知。 // 如:@张三 则张三可以收到推送,@所有人 时不会收到推送。 // 4:仅针对 @群全员进行通知,只接收 @所有人 的推送信息 // 5:不接收通知,即使为 @ 消息也不推送通知。 UnpushLevel int `json:"unpushLevel"` // contains filtered or unexported fields }
type UltraGroupNotDisturbSetRequest ¶
type UltraGroupNotDisturbSetRequest struct { // [必传] 超级群 ID GroupId *string `url:"groupId,omitempty"` // 频道 ID,不传时为群的默认免打扰设置 BusChannel *string `url:"busChannel,omitempty"` // [必传] -1:全部消息通知 // 0:未设置(用户未设置时为此状态,为全部消息都通知,在此状态下,如设置了超级群默认状态以超级群的默认设置为准) // 1:仅针对 @ 消息进行通知,包括 @指定用户 和 @所有人 // 2:仅针对 @ 指定用户消息进行通知,且仅通知被 @ 的指定的用户进行通知。 // 如:@张三 则张三可以收到推送,@所有人 时不会收到推送。 // 4:仅针对 @群全员进行通知,只接收 @所有人 的推送信息 // 5:不接收通知,即使为 @ 消息也不推送通知。 UnpushLevel *int `url:"unpushLevel,omitempty"` }
type UltraGroupNotDisturbSetResponse ¶
type UltraGroupNotDisturbSetResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupQuitRequest ¶
type UltraGroupQuitResponse ¶
type UltraGroupQuitResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupRefreshResponse ¶
type UltraGroupRefreshResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupUserBannedAddResponse ¶
type UltraGroupUserBannedAddResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupUserBannedDelResponse ¶
type UltraGroupUserBannedDelResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupUserBannedGetResponse ¶
type UltraGroupUserBannedGetResponse struct { CodeResult Users []*UltraGroupUserBannedGetUser `json:"users"` // contains filtered or unexported fields }
type UltraGroupUserBannedGetUser ¶
type UltraGroupUserBannedGetUser struct {
Id string `json:"id"`
}
type UltraGroupUserChannelQueryResponse ¶
type UltraGroupUserChannelQueryResponse struct { CodeResult Data []string `json:"data"` // 超级群频道 ID 列表。 // contains filtered or unexported fields }
type UltraGroupUserGroup ¶
type UltraGroupUserGroup struct { // [必传] 用户组 ID,支持大小写字母、数字的组合方式,长度不超过 64 个字符。 UserGroupId string `json:"userGroupId"` }
type UltraGroupUserGroupAddRequest ¶
type UltraGroupUserGroupAddRequest struct { // [必传] 超级群 ID,请确保超级群 ID 存在。 GroupId *string `json:"groupId,omitempty"` // [必传] 用户组信息列表,最大长度为 10。 UserGroups []*UltraGroupUserGroup `json:"userGroups,omitempty"` }
type UltraGroupUserGroupAddResponse ¶
type UltraGroupUserGroupAddResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupUserGroupChannelQueryResponse ¶
type UltraGroupUserGroupChannelQueryResponse struct { CodeResult Data []string `json:"data"` // 频道ID列表 // contains filtered or unexported fields }
type UltraGroupUserGroupDelResponse ¶
type UltraGroupUserGroupDelResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupUserGroupQueryResponse ¶
type UltraGroupUserGroupQueryResponse struct { CodeResult UserGroups []*UltraGroupUserGroup `json:"userGroups"` // 用户组列表 // contains filtered or unexported fields }
type UltraGroupUserGroupUserAddRequest ¶
type UltraGroupUserGroupUserAddRequest struct { // [必传] 超级群 ID,请确保超级群 ID 存在。 GroupId *string `url:"groupId,omitempty"` // [必传] 用户组 ID,请确保用户组 ID 存在。 UserGroupId *string `url:"userGroupId,omitempty"` // [必传] 群内用户 ID 列表,多个 ID 以逗号分隔。单次不得超过 20人,请确保用户 ID 存在,否则全部失败。 UserIds *string `url:"userIds,omitempty"` }
type UltraGroupUserGroupUserAddResponse ¶
type UltraGroupUserGroupUserAddResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupUserGroupUserDelRequest ¶
type UltraGroupUserGroupUserDelRequest struct { // [必传] 超级群 ID,请确保超级群 ID 存在。 GroupId *string `url:"groupId,omitempty"` // [必传] 用户组 ID,请确保用户组 ID 存在。 UserGroupId *string `url:"userGroupId,omitempty"` // [必传] 群内用户 ID 列表,多个 ID 以逗号分隔。单次不得超过 20人,请确保用户 ID 存在,否则全部失败。 UserIds *string `url:"userIds,omitempty"` }
type UltraGroupUserGroupUserDelResponse ¶
type UltraGroupUserGroupUserDelResponse struct { CodeResult // contains filtered or unexported fields }
type UltraGroupUserUserGroupQueryResponse ¶
type UltraGroupUserUserGroupQueryResponse struct { CodeResult Data []string `json:"data"` // 用户组 ID 列表 // contains filtered or unexported fields }
type UserBlacklistAddRequest ¶
type UserBlacklistAddResponse ¶
type UserBlacklistAddResponse struct { CodeResult // contains filtered or unexported fields }
type UserBlacklistQueryRequest ¶
type UserBlacklistQueryRequest struct { // [必传] 用户 ID。 UserId *string `url:"userId,omitempty"` }
type UserBlacklistQueryResponse ¶
type UserBlacklistQueryResponse struct { CodeResult Users []string `json:"users"` // 黑名单用户数组。 // contains filtered or unexported fields }
type UserBlacklistRemoveResponse ¶
type UserBlacklistRemoveResponse struct { CodeResult // contains filtered or unexported fields }
type UserBlockPushPeriodData ¶
type UserBlockPushPeriodData struct { // 开始时间,精确到秒。格式为 HH:MM:SS,示例:22:00:00。注意:startTime 与应用所属数据中心有关。如您的 App 业务使用国内数据中心,该时间为北京时间。如您的 App 业务使用海外数据中心,该时间为 UTC 时间。 StartTime string `json:"startTime"` // 免打扰时间窗口大小,单位为分钟。范围为 [0-1439] 的整数。0 表示未设置。 Period int `json:"period"` // 免打扰级别。1:仅 @消息进行通知,普通消息不进行通知。0:所有消息都进行通知。5:所有消息都不进行通知。 UnPushLevel int `json:"unPushLevel"` }
type UserBlockPushPeriodDeleteRequest ¶
type UserBlockPushPeriodDeleteRequest struct { // [必传] 用户ID UserId *string `url:"userId,omitempty"` }
type UserBlockPushPeriodDeleteResponse ¶
type UserBlockPushPeriodDeleteResponse struct { CodeResult // contains filtered or unexported fields }
type UserBlockPushPeriodGetRequest ¶
type UserBlockPushPeriodGetRequest struct { // [必传] 用户 ID UserId *string `url:"userId,omitempty"` }
type UserBlockPushPeriodGetResponse ¶
type UserBlockPushPeriodGetResponse struct { CodeResult Data *UserBlockPushPeriodData `json:"data"` // contains filtered or unexported fields }
type UserBlockPushPeriodSetRequest ¶
type UserBlockPushPeriodSetRequest struct { // [必传] 用户 ID UserId *string `url:"userId,omitempty"` // [必传] 开始时间,精确到秒。格式为 HH:MM:SS,示例:22:00:00。注意:startTime 与应用所属数据中心有关。如您的 App 业务使用国内数据中心,请使用北京时间。如您的 App 业务使用海外数据中心,请使用 UTC 时间。 StartTime *string `url:"startTime,omitempty"` // [必传] 免打扰时间窗口大小,单位为分钟。支持范围为 [0-1439] 的整数。0 表示未设置。 Period *int `url:"period,omitempty"` // 免打扰级别。1:仅 @消息进行通知,普通消息不进行通知。0:所有消息都进行通知。5:所有消息都不进行通知。 默认 1。 Level *int `url:"level,omitempty"` }
type UserBlockPushPeriodSetResponse ¶
type UserBlockPushPeriodSetResponse struct { CodeResult // contains filtered or unexported fields }
type UserBlockQueryRequest ¶
type UserBlockQueryResponse ¶
type UserBlockQueryResponse struct { CodeResult Users []UserBlockQueryUser `json:"users"` // 被封禁用户数组。 // contains filtered or unexported fields }
type UserBlockQueryUser ¶
type UserBlockRequest ¶
type UserBlockResponse ¶
type UserBlockResponse struct { CodeResult // contains filtered or unexported fields }
type UserChatFBQueryListResponse ¶
type UserChatFBQueryListResponse struct { CodeResult Total int `json:"total"` Users []string `json:"users"` // contains filtered or unexported fields }
type UserChatFBSetRequest ¶
type UserChatFBSetResponse ¶
type UserChatFBSetResponse struct { CodeResult // contains filtered or unexported fields }
type UserCheckOnlineRequest ¶
type UserCheckOnlineRequest struct { // [必传] 用户 ID。 UserId *string `url:"userId,omitempty"` }
type UserCheckOnlineResponse ¶
type UserCheckOnlineResponse struct { CodeResult Status string `json:"status"` // 用户状态。1 - 用户当前在线。0 - 用户当前不在线。 // contains filtered or unexported fields }
type UserDeactivateQueryResponse ¶
type UserDeactivateQueryResponse struct { CodeResult Users []string `json:"users"` // 已注销的用户 ID 列表 // contains filtered or unexported fields }
type UserDeactivateRequest ¶
type UserDeactivateRequest struct { // [必传] 被注销用户 ID,最多一次 100 个。逗号分割 UserId *string `url:"userId,omitempty"` }
type UserDeactivateResponse ¶
type UserDeactivateResponse struct { CodeResult OperateId string `json:"operateId"` // 操作 ID,为当前操作的唯一标识。开通用户注销与激活状态回调后,回调请求正文中会携带此参数。 // contains filtered or unexported fields }
type UserGetTokenRequest ¶
type UserGetTokenRequest struct { // [必传] App 自行定义的用户 ID,用于换取 Token。支持大小写英文字母与数字的组合,最大长度 64 字节。 UserId *string `url:"userId,omitempty"` // [必传] 推送服务使用的用户名称。不区分符号、英文字符、中文字符,统一限制最多 64 个字符。注意:该 name 字段仅用于推送服务,作为在移动客户端推送通知中默认显示的用户名称。因为即时通讯服务端不提供用户信息托管服务,所以不支持客户端 SDK 主动获取该用户名称数据。 Name *string `url:"name,omitempty"` // 用户头像 URI,最大长度 1024 字节。注意:因为即时通讯服务端不提供用户信息托管服务,所以不支持客户端 SDK 主动获取该用户头像数据。 PortraitUri *string `url:"portraitUri,omitempty"` }
type UserGetTokenResponse ¶
type UserGetTokenResponse struct { CodeResult // 用户身份验证 Token,长度在 256 字节以内,可以保存应用内。Token 中携带 IM 服务动态导航地址,开发者不需要进行处理。 Token string `json:"token"` // 返回输入参数中提供的用户 ID。 UserId string `json:"userId"` // contains filtered or unexported fields }
type UserGroupQueryRequest ¶
type UserGroupQueryResponse ¶
type UserGroupQueryResponse struct { CodeResult Groups []*Group `json:"groups"` // 用户加入的群信息数组。 // contains filtered or unexported fields }
type UserReactivateRequest ¶
type UserReactivateRequest struct { // [必传] 激活用户 ID,单次请求最多传入 100 个用户 ID。逗号分割 UserId *string `url:"userId,omitempty"` }
type UserReactivateResponse ¶
type UserReactivateResponse struct { CodeResult OperateId string `json:"operateId"` // 操作 ID,为当前操作的唯一标识。开通用户注销与激活状态回调后,回调请求正文中会携带此参数。 // contains filtered or unexported fields }
type UserRefreshRequest ¶
type UserRefreshRequest struct { // [必传] 用户 ID,支持大小写英文字母与数字的组合,最大长度 64 字节。 userId 是用户在 App 中的唯一标识,必须保证在同一个 App 内不重复,重复的用户 ID 将被当作是同一用户。 UserId *string `url:"userId,omitempty"` // 用户名称,最大长度 64 个字符(不区分符号、英文字符、中文字符,统一限制最多 64 个字符)。用来在 Push 推送时,显示用户的名称,不提供则不进行刷新。 Name *string `url:"name,omitempty"` // 用户头像 URI,最大长度 1024 字节。 PortraitUri *string `url:"portraitUri,omitempty"` }
type UserRefreshResponse ¶
type UserRefreshResponse struct { CodeResult // contains filtered or unexported fields }
type UserRemark ¶
type UserRemarksDelRequest ¶
type UserRemarksDelResponse ¶
type UserRemarksDelResponse struct { CodeResult // contains filtered or unexported fields }
type UserRemarksGetRequest ¶
type UserRemarksGetResponse ¶
type UserRemarksGetResponse struct { CodeResult Total int `json:"total"` // 用户的备注名总数。 Users []*UserRemark `json:"users"` // 单次最多返回 50 个用户备注名。 // contains filtered or unexported fields }
type UserRemarksSetRequest ¶
type UserRemarksSetRequest struct { // [必传] 用户 ID。 UserId *string `url:"userId,omitempty"` // [必传] 设置的目标用户推送备注名 Remarks []*UserRemark `url:"-"` }
type UserRemarksSetResponse ¶
type UserRemarksSetResponse struct { CodeResult // contains filtered or unexported fields }
type UserTagBatchSetRequest ¶
type UserTagBatchSetResponse ¶
type UserTagBatchSetResponse struct { CodeResult // contains filtered or unexported fields }
type UserTagSetRequest ¶
type UserTagSetResponse ¶
type UserTagSetResponse struct { CodeResult // contains filtered or unexported fields }
type UserTagsGetRequest ¶
type UserTagsGetRequest struct { // [必传] 用户 ID,一次最多支持 50 个用户。 UserIds []string `url:"userIds,omitempty"` }
type UserTagsGetResponse ¶
type UserTagsGetResponse struct { CodeResult Result map[string][]string `json:"result"` // 用户所有的标签数组。userId:tags // contains filtered or unexported fields }
type UserTokenExpireRequest ¶
type UserTokenExpireResponse ¶
type UserTokenExpireResponse struct { CodeResult // contains filtered or unexported fields }
type UserUnBlockRequest ¶
type UserUnBlockRequest struct { // [必传] 用户 ID,支持一次解除多个用户,最多不超过 20 个。 UserId []string `url:"userId,omitempty"` }
type UserUnBlockResponse ¶
type UserUnBlockResponse struct { CodeResult // contains filtered or unexported fields }
type UserWhitelistAddRequest ¶
type UserWhitelistAddResponse ¶
type UserWhitelistAddResponse struct { CodeResult // contains filtered or unexported fields }
type UserWhitelistQueryRequest ¶
type UserWhitelistQueryRequest struct { // [必传] 用户ID UserId *string `url:"userId,omitempty"` }
type UserWhitelistQueryResponse ¶
type UserWhitelistQueryResponse struct { CodeResult Users []string `json:"users"` // 白名单用户数组。 // contains filtered or unexported fields }
type UserWhitelistRemoveResponse ¶
type UserWhitelistRemoveResponse struct { CodeResult // contains filtered or unexported fields }
type VCMsg ¶
type VCMsg struct { Content string `json:"content,omitempty"` User *MsgUserInfo `json:"user,omitempty"` Extra string `json:"extra,omitempty"` Duration interface{} `json:"duration,omitempty"` }
VCMsg 旧版语音消息, 推荐使用高清语音消息 HQVCMsg Deprecated