rcserversdk

package
v2.0.1+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 9, 2017 License: MIT Imports: 11 Imported by: 3

Documentation

Overview

*

  • 融云 Server API go 客户端
  • create by kitName
  • create datetime : 2017-02-09 *
  • v2.0.1

Index

Constants

View Source 
const (
	RONGCLOUDSMSURI = "http://api.sms.ronghub.com"
	RONGCLOUDURI    = "http://api.cn.ronghub.com"
	UTF8            = "UTF-8"
)

Variables

This section is empty.

Functions

func JsonParse 

func JsonParse(jsonStr string, v interface{}) error

*

  • parse json string to struct

func ToJson 

func ToJson(v interface{}) (string, error)

*

  • convert struct to json string

func ToXml 

func ToXml(v interface{}) (string, error)

*

  • convert struct to json string

func XmlParse 

func XmlParse(xmlStr string, v interface{}) error

*

  • parse json string to struct

Types

type BlockChatRoomUser 

type BlockChatRoomUser struct {
	UserId string `json:"userId"`
	Time   string `json:"time"`
}

* 

*聊天室被封禁用户信息。

type BlockUsers 

type BlockUsers struct {
	UserId       string `json:"userId"`
	BlockEndTime string `json:"blockEndTime"`
}

* 

*封禁用户信息

type ChatRoom 

type ChatRoom struct {
	ChrmId string `json:"chrmId"`
	Name   string `json:"name"`
	Time   string `json:"time"`
}

* 

*聊天室信息。

type ChatRoomInfo 

type ChatRoomInfo struct {
	Id   string `json:"id"`
	Name string `json:"name"`
}

* 

*聊天室信息。

type ChatRoomUser 

type ChatRoomUser struct {
	Id   string `json:"id"`
	Time string `json:"time"`
}

* 

*聊天室用户信息。

type Chatroom 

type Chatroom struct {
	AppKey    string
	AppSecret string
}

func (*Chatroom) AddBlockUser 

func (self *Chatroom) AddBlockUser(userId string, chatroomId string, minute string) (*CodeSuccessReslut, error)

* 

*添加封禁聊天室成员方法
*
*@param  userId:用户 Id。（必传）
*@param  chatroomId:聊天室 Id。（必传）
*@param  minute:封禁时长，以分钟为单位，最大值为43200分钟。（必传）
*
*@return CodeSuccessReslut

func (*Chatroom) AddGagUser 

func (self *Chatroom) AddGagUser(userId string, chatroomId string, minute string) (*CodeSuccessReslut, error)

* 

*添加禁言聊天室成员方法（在 App 中如果不想让某一用户在聊天室中发言时，可将此用户在聊天室中禁言，被禁言用户可以接收查看聊天室中用户聊天信息，但不能发送消息.）
*
*@param  userId:用户 Id。（必传）
*@param  chatroomId:聊天室 Id。（必传）
*@param  minute:禁言时长，以分钟为单位，最大值为43200分钟。（必传）
*
*@return CodeSuccessReslut

func (*Chatroom) AddPriority 

func (self *Chatroom) AddPriority(objectName []string) (*CodeSuccessReslut, error)

* 

*添加聊天室消息优先级方法
*
*@param  objectName:低优先级的消息类型，每次最多提交 5 个，设置的消息类型最多不超过 20 个。（必传）
*
*@return CodeSuccessReslut

func (*Chatroom) AddWhiteListUser 

func (self *Chatroom) AddWhiteListUser(chatroomId string, userId []string) (*CodeSuccessReslut, error)

* 

*添加聊天室白名单成员方法
*
*@param  chatroomId:聊天室中用户 Id，可提交多个，聊天室中白名单用户最多不超过 5 个。（必传）
*@param  userId:聊天室 Id。（必传）
*
*@return CodeSuccessReslut

func (*Chatroom) Create 

func (self *Chatroom) Create(chatRoomInfo []ChatRoomInfo) (*CodeSuccessReslut, error)

* 

*创建聊天室方法
*
*@param  chatRoomInfo:id:要创建的聊天室的id；name:要创建的聊天室的name。（必传）
*
*@return CodeSuccessReslut

func (*Chatroom) Destroy 

func (self *Chatroom) Destroy(chatroomId []string) (*CodeSuccessReslut, error)

* 

*销毁聊天室方法
*
*@param  chatroomId:要销毁的聊天室 Id。（必传）
*
*@return CodeSuccessReslut

func (*Chatroom) GetListBlockUser 

func (self *Chatroom) GetListBlockUser(chatroomId string) (*ListBlockChatroomUserReslut, error)

* 

*查询被封禁聊天室成员方法
*
*@param  chatroomId:聊天室 Id。（必传）
*
*@return ListBlockChatroomUserReslut

func (*Chatroom) Join 

func (self *Chatroom) Join(userId []string, chatroomId string) (*CodeSuccessReslut, error)

* 

*加入聊天室方法
*
*@param  userId:要加入聊天室的用户 Id，可提交多个，最多不超过 50 个。（必传）
*@param  chatroomId:要加入的聊天室 Id。（必传）
*
*@return CodeSuccessReslut

func (*Chatroom) ListGagUser 

func (self *Chatroom) ListGagUser(chatroomId string) (*ListGagChatroomUserReslut, error)

* 

*查询被禁言聊天室成员方法
*
*@param  chatroomId:聊天室 Id。（必传）
*
*@return ListGagChatroomUserReslut

func (*Chatroom) Query 

func (self *Chatroom) Query(chatroomId []string) (*ChatroomQueryReslut, error)

* 

*查询聊天室信息方法
*
*@param  chatroomId:要查询的聊天室id（必传）
*
*@return ChatroomQueryReslut

func (*Chatroom) QueryUser 

func (self *Chatroom) QueryUser(chatroomId string, count string, order string) (*ChatroomUserQueryReslut, error)

* 

*查询聊天室内用户方法
*
*@param  chatroomId:要查询的聊天室 ID。（必传）
*@param  count:要获取的聊天室成员数，上限为 500 ，超过 500 时最多返回 500 个成员。（必传）
*@param  order:加入聊天室的先后顺序， 1 为加入时间正序， 2 为加入时间倒序。（必传）
*
*@return ChatroomUserQueryReslut

func (*Chatroom) ResumeDistributionMessage 

func (self *Chatroom) ResumeDistributionMessage(chatroomId string) (*CodeSuccessReslut, error)

* 

*聊天室消息恢复分发方法
*
*@param  chatroomId:聊天室 Id。（必传）
*
*@return CodeSuccessReslut

func (*Chatroom) RollbackBlockUser 

func (self *Chatroom) RollbackBlockUser(userId string, chatroomId string) (*CodeSuccessReslut, error)

* 

*移除封禁聊天室成员方法
*
*@param  userId:用户 Id。（必传）
*@param  chatroomId:聊天室 Id。（必传）
*
*@return CodeSuccessReslut

func (*Chatroom) RollbackGagUser 

func (self *Chatroom) RollbackGagUser(userId string, chatroomId string) (*CodeSuccessReslut, error)

* 

*移除禁言聊天室成员方法
*
*@param  userId:用户 Id。（必传）
*@param  chatroomId:聊天室Id。（必传）
*
*@return CodeSuccessReslut

func (*Chatroom) StopDistributionMessage 

func (self *Chatroom) StopDistributionMessage(chatroomId string) (*CodeSuccessReslut, error)

* 

*聊天室消息停止分发方法（可实现控制对聊天室中消息是否进行分发，停止分发后聊天室中用户发送的消息，融云服务端不会再将消息发送给聊天室中其他用户。）
*
*@param  chatroomId:聊天室 Id。（必传）
*
*@return CodeSuccessReslut

type ChatroomQueryReslut 

type ChatroomQueryReslut struct {
	Code         int        `json:"code"`
	ChatRooms    []ChatRoom `json:"chatRooms"`
	ErrorMessage string     `json:"errorMessage"`
}

*

  • chatroomQuery 返回结果

type ChatroomUserQueryReslut 

type ChatroomUserQueryReslut struct {
	Code         int            `json:"code"`
	Total        int            `json:"total"`
	Users        []ChatRoomUser `json:"users"`
	ErrorMessage string         `json:"errorMessage"`
}

*

  • chatroomUserQuery 返回结果

type CheckOnlineReslut 

type CheckOnlineReslut struct {
	Code         int    `json:"code"`
	Status       string `json:"status"`
	ErrorMessage string `json:"errorMessage"`
}

* 

*checkOnlineUser返回结果

type CmdMsgMessage 

type CmdMsgMessage struct {
	Name string `json:"name"`
	Data string `json:"data"`
	// contains filtered or unexported fields
}

* 通用命令通知消息。此类型消息没有 Push 通知。此类型消息没有 Push 通知，与通用命令通知消息的区别是不存储、不计数。

func (*CmdMsgMessage) GetType 

func (self *CmdMsgMessage) GetType() string

func (*CmdMsgMessage) SetType 

func (self *CmdMsgMessage) SetType(messageType string)

type CmdNtfMessage 

type CmdNtfMessage struct {
	Name string `json:"name"`
	Data string `json:"data"`
	// contains filtered or unexported fields
}

* 通用命令通知消息。此类型消息没有 Push 通知。

func (*CmdNtfMessage) GetType 

func (self *CmdNtfMessage) GetType() string

func (*CmdNtfMessage) SetType 

func (self *CmdNtfMessage) SetType(messageType string)

type CodeSuccessReslut 

type CodeSuccessReslut struct {
	Code         int    `json:"code"`
	ErrorMessage string `json:"errorMessage"`
}

*

  • http 成功返回结果

type ContactNtfMessage 

type ContactNtfMessage struct {
	Operation    string `json:"operation"`
	Extra        string `json:"extra"`
	SourceUserId string `json:"sourceUserId"`
	TargetUserId string `json:"targetUserId"`
	Message      string `json:"message"`
	// contains filtered or unexported fields
}

* 添加联系人消息。

func (*ContactNtfMessage) GetType 

func (self *ContactNtfMessage) GetType() string

func (*ContactNtfMessage) SetType 

func (self *ContactNtfMessage) SetType(messageType string)

type CustomTxtMessage 

type CustomTxtMessage struct {
	Content string `json:"content"`
	// contains filtered or unexported fields
}

* 自定义消息

func (*CustomTxtMessage) GetType 

func (self *CustomTxtMessage) GetType() string

func (*CustomTxtMessage) SetType 

func (self *CustomTxtMessage) SetType(messageType string)

type GagChatRoomUser 

type GagChatRoomUser struct {
	Time   string `json:"time"`
	UserId string `json:"userId"`
}

* 

*聊天室被禁言用户信息。

type GagGroupUser 

type GagGroupUser struct {
	Time   string `json:"time"`
	UserId string `json:"userId"`
}

* 

*群组用户信息。

type Group 

type Group struct {
	AppKey    string
	AppSecret string
}

func (*Group) AddGagUser 

func (self *Group) AddGagUser(userId string, groupId string, minute string) (*CodeSuccessReslut, error)

* 

*添加禁言群成员方法（在 App 中如果不想让某一用户在群中发言时，可将此用户在群组中禁言，被禁言用户可以接收查看群组中用户聊天信息，但不能发送消息。）
*
*@param  userId:用户 Id。（必传）
*@param  groupId:群组 Id。（必传）
*@param  minute:禁言时长，以分钟为单位，最大值为43200分钟。（必传）
*
*@return CodeSuccessReslut

func (*Group) Create 

func (self *Group) Create(userId []string, groupId string, groupName string) (*CodeSuccessReslut, error)

* 

*创建群组方法（创建群组，并将用户加入该群组，用户将可以收到该群的消息，同一用户最多可加入 500 个群，每个群最大至 3000 人，App 内的群组数量没有限制.注：其实本方法是加入群组方法 /group/join 的别名。）
*
*@param  userId:要加入群的用户 Id。（必传）
*@param  groupId:创建群组 Id。（必传）
*@param  groupName:群组 Id 对应的名称。（必传）
*
*@return CodeSuccessReslut

func (*Group) Dismiss 

func (self *Group) Dismiss(userId string, groupId string) (*CodeSuccessReslut, error)

* 

*解散群组方法。（将该群解散，所有用户都无法再接收该群的消息。）
*
*@param  userId:操作解散群的用户 Id。（必传）
*@param  groupId:要解散的群 Id。（必传）
*
*@return CodeSuccessReslut

func (*Group) Join 

func (self *Group) Join(userId []string, groupId string, groupName string) (*CodeSuccessReslut, error)

* 

*将用户加入指定群组，用户将可以收到该群的消息，同一用户最多可加入 500 个群，每个群最大至 3000 人。
*
*@param  userId:要加入群的用户 Id，可提交多个，最多不超过 1000 个。（必传）
*@param  groupId:要加入的群 Id。（必传）
*@param  groupName:要加入的群 Id 对应的名称。（必传）
*
*@return CodeSuccessReslut

func (*Group) LisGagUser 

func (self *Group) LisGagUser(groupId string) (*ListGagGroupUserReslut, error)

* 

*查询被禁言群成员方法
*
*@param  groupId:群组Id。（必传）
*
*@return ListGagGroupUserReslut

func (*Group) QueryUser 

func (self *Group) QueryUser(groupId string) (*GroupUserQueryReslut, error)

* 

*查询群成员方法
*
*@param  groupId:群组Id。（必传）
*
*@return GroupUserQueryReslut

func (*Group) Quit 

func (self *Group) Quit(userId []string, groupId string) (*CodeSuccessReslut, error)

* 

*退出群组方法（将用户从群中移除，不再接收该群组的消息.）
*
*@param  userId:要退出群的用户 Id.（必传）
*@param  groupId:要退出的群 Id.（必传）
*
*@return CodeSuccessReslut

func (*Group) Refresh 

func (self *Group) Refresh(groupId string, groupName string) (*CodeSuccessReslut, error)

* 

*刷新群组信息方法
*
*@param  groupId:群组 Id。（必传）
*@param  groupName:群名称。（必传）
*
*@return CodeSuccessReslut

func (*Group) RollBackGagUser 

func (self *Group) RollBackGagUser(userId []string, groupId string) (*CodeSuccessReslut, error)

* 

*移除禁言群成员方法
*
*@param  userId:用户Id。支持同时移除多个群成员（必传）
*@param  groupId:群组Id。（必传）
*
*@return CodeSuccessReslut

func (*Group) Sync 

func (self *Group) Sync(userId string, groupInfo []GroupInfo) (*CodeSuccessReslut, error)

* 

*同步用户所属群组方法（当第一次连接融云服务器时，需要向融云服务器提交 userId 对应的用户当前所加入的所有群组，此接口主要为防止应用中用户群信息同融云已知的用户所属群信息不同步。）
*
*@param  userId:被同步群信息的用户 Id。（必传）
*@param  groupInfo:该用户的群信息，如群 Id 已经存在，则不会刷新对应群组名称，如果想刷新群组名称请调用刷新群组信息方法。
*
*@return CodeSuccessReslut

type GroupInfo 

type GroupInfo struct {
	Id   string `json:"id"`
	Name string `json:"name"`
}

* 

*群组信息。

type GroupUser 

type GroupUser struct {
	Id string `json:"id"`
}

* 

*群组用户信息。

type GroupUserQueryReslut 

type GroupUserQueryReslut struct {
	Code  int         `json:"code"`
	Id    string      `json:"id"`
	Users []GroupUser `json:"users"`
}

* 

*groupUserQuery返回结果

type HistoryMessageReslut 

type HistoryMessageReslut struct {
	Code         int    `json:"code"`
	Url          string `json:"url"`
	Date         string `json:"date"`
	ErrorMessage string `json:"errorMessage"`
}

* 

*historyMessage返回结果

type ImgMessage 

type ImgMessage struct {
	Content  string `json:"content"`
	Extra    string `json:"extra"`
	ImageUri string `json:"imageUri"`
	// contains filtered or unexported fields
}

* 图片消息。

func (*ImgMessage) GetType 

func (self *ImgMessage) GetType() string

func (*ImgMessage) SetType 

func (self *ImgMessage) SetType(messageType string)

type ImgTextMessage 

type ImgTextMessage struct {
	Content  string `json:"content"`
	Extra    string `json:"extra"`
	Title    string `json:"title"`
	ImageUri string `json:"imageUri"`
	Url      string `json:"url"`
	// contains filtered or unexported fields
}

* 图文消息。

func (*ImgTextMessage) GetType 

func (self *ImgTextMessage) GetType() string

func (*ImgTextMessage) SetType 

func (self *ImgTextMessage) SetType(messageType string)

type InfoNtfMessage 

type InfoNtfMessage struct {
	Message string `json:"message"`
	Extra   string `json:"extra"`
	// contains filtered or unexported fields
}

* 提示条（小灰条）通知消息。此类型消息没有 Push 通知。

func (*InfoNtfMessage) GetType 

func (self *InfoNtfMessage) GetType() string

func (*InfoNtfMessage) SetType 

func (self *InfoNtfMessage) SetType(messageType string)

type LBSMessage 

type LBSMessage struct {
	Content   string  `json:"content"`
	Extra     string  `json:"extra"`
	Latitude  float64 `json:"latitude"`
	Longitude float64 `json:"longitude"`
	Poi       string  `json:"poi"`
	// contains filtered or unexported fields
}

* 位置消息。

func (*LBSMessage) GetType 

func (self *LBSMessage) GetType() string

func (*LBSMessage) SetType 

func (self *LBSMessage) SetType(messageType string)

type ListBlockChatroomUserReslut 

type ListBlockChatroomUserReslut struct {
	Code         int                 `json:"code"`
	Users        []BlockChatRoomUser `json:"users"`
	ErrorMessage string              `json:"errorMessage"`
}

* 

*listBlockChatroomUser返回结果

type ListGagChatroomUserReslut 

type ListGagChatroomUserReslut struct {
	Code         int               `json:"code"`
	Users        []GagChatRoomUser `json:"users"`
	ErrorMessage string            `json:"errorMessage"`
}

* 

*listGagChatroomUser返回结果

type ListGagGroupUserReslut 

type ListGagGroupUserReslut struct {
	Code         int            `json:"code"`
	Users        []GagGroupUser `json:"users"`
	ErrorMessage string         `json:"errorMessage"`
}

*

  • lisitGagGroupUser 返回结果

type ListWordfilterReslut 

type ListWordfilterReslut struct {
	Code         int    `json:"code"`
	Word         string `json:"word"`
	ErrorMessage string `json:"errorMessage"`
}

* 

*listWordfilter返回结果

type Message 

type Message struct {
	AppKey    string
	AppSecret string
}

func (*Message) Broadcast 

func (self *Message) Broadcast(fromUserId string, txtMessage TxtMessage, pushContent string, pushData string, os string) (*CodeSuccessReslut, error)

* 

*发送广播消息方法（发送消息给一个应用下的所有注册用户，如用户未在线会对满足条件（绑定手机终端）的用户发送 Push 信息，单条消息最大 128k，会话类型为 SYSTEM。每小时只能发送 1 次，每天最多发送 3 次。）
*
*@param  fromUserId:发送人用户 Id。（必传）
*@param  txtMessage:文本消息。
*@param  pushContent:定义显示的 Push 内容，如果 objectName 为融云内置消息类型时，则发送后用户一定会收到 Push 信息. 如果为自定义消息，则 pushContent 为自定义消息显示的 Push 内容，如果不传则用户不会收到 Push 通知.（可选）
*@param  pushData:针对 iOS 平台为 Push 通知时附加到 payload 中，Android 客户端收到推送消息时对应字段名为 pushData。（可选）
*@param  os:针对操作系统发送 Push，值为 iOS 表示对 iOS 手机用户发送 Push ,为 Android 时表示对 Android 手机用户发送 Push ，如对所有用户发送 Push 信息，则不需要传 os 参数。（可选）
*
*@return CodeSuccessReslut

func (*Message) DeleteMessage 

func (self *Message) DeleteMessage(date string) (*CodeSuccessReslut, error)

* 

*消息历史记录删除方法（删除 APP 内指定某天某小时内的所有会话消息记录。调用该接口返回成功后，date参数指定的某小时的消息记录文件将在随后的5-10分钟内被永久删除。）
*
*@param  date:指定北京时间某天某小时，格式为2014010101,表示：2014年1月1日凌晨1点。（必传）
*
*@return CodeSuccessReslut

func (*Message) GetHistory 

func (self *Message) GetHistory(date string) (*HistoryMessageReslut, error)

* 

*消息历史记录下载地址获取 方法消息历史记录下载地址获取方法。获取 APP 内指定某天某小时内的所有会话消息记录的下载地址。（目前支持二人会话、讨论组、群组、聊天室、客服、系统通知消息历史记录下载）
*
*@param  date:指定北京时间某天某小时，格式为2014010101,表示：2014年1月1日凌晨1点。（必传）
*
*@return HistoryMessageReslut

func (*Message) PublishChatroom 

func (self *Message) PublishChatroom(fromUserId string, toChatroomId []string, txtMessage TxtMessage) (*CodeSuccessReslut, error)

* 

*发送聊天室消息方法（一个用户向聊天室发送消息，单条消息最大 128k。每秒钟限 100 次。）
*
*@param  fromUserId:发送人用户 Id。（必传）
*@param  toChatroomId:接收聊天室Id，提供多个本参数可以实现向多个聊天室发送消息。（必传）
*@param  txtMessage:发送消息内容（必传）
*
*@return CodeSuccessReslut

func (*Message) PublishDiscussion 

func (self *Message) PublishDiscussion(fromUserId string, toDiscussionId string, txtMessage TxtMessage, pushContent string, pushData string, isPersisted int, isCounted int, isIncludeSender int) (*CodeSuccessReslut, error)

* 

*发送讨论组消息方法（以一个用户身份向讨论组发送消息，单条消息最大 128k，每秒钟最多发送 20 条消息.）
*
*@param  fromUserId:发送人用户 Id。（必传）
*@param  toDiscussionId:接收讨论组 Id。（必传）
*@param  txtMessage:发送消息内容（必传）
*@param  pushContent:定义显示的 Push 内容，如果 objectName 为融云内置消息类型时，则发送后用户一定会收到 Push 信息. 如果为自定义消息，则 pushContent 为自定义消息显示的 Push 内容，如果不传则用户不会收到 Push 通知。（可选）
*@param  pushData:针对 iOS 平台为 Push 通知时附加到 payload 中，Android 客户端收到推送消息时对应字段名为 pushData.（可选）
*@param  isPersisted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行存储，0 表示为不存储、 1 表示为存储，默认为 1 存储消息.（可选）
*@param  isCounted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行未读消息计数，0 表示为不计数、 1 表示为计数，默认为 1 计数，未读消息数增加 1。（可选）
*@param  isIncludeSender:发送用户自已是否接收消息，0 表示为不接收，1 表示为接收，默认为 0 不接收。（可选）
*
*@return CodeSuccessReslut

func (*Message) PublishGroup 

func (self *Message) PublishGroup(fromUserId string, toGroupId []string, txtMessage TxtMessage, pushContent string, pushData string, isPersisted int, isCounted int, isIncludeSender int) (*CodeSuccessReslut, error)

* 

*发送群组消息方法（以一个用户身份向群组发送消息，单条消息最大 128k.每秒钟最多发送 20 条消息，每次最多向 3 个群组发送，如：一次向 3 个群组发送消息，示为 3 条消息。）
*
*@param  fromUserId:发送人用户 Id 。（必传）
*@param  toGroupId:接收群Id，提供多个本参数可以实现向多群发送消息，最多不超过 3 个群组。（必传）
*@param  txtMessage:发送消息内容（必传）
*@param  pushContent:定义显示的 Push 内容，如果 objectName 为融云内置消息类型时，则发送后用户一定会收到 Push 信息. 如果为自定义消息，则 pushContent 为自定义消息显示的 Push 内容，如果不传则用户不会收到 Push 通知。（可选）
*@param  pushData:针对 iOS 平台为 Push 通知时附加到 payload 中，Android 客户端收到推送消息时对应字段名为 pushData。（可选）
*@param  isPersisted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行存储，0 表示为不存储、 1 表示为存储，默认为 1 存储消息。（可选）
*@param  isCounted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行未读消息计数，0 表示为不计数、 1 表示为计数，默认为 1 计数，未读消息数增加 1。（可选）
*@param  isIncludeSender:发送用户自已是否接收消息，0 表示为不接收，1 表示为接收，默认为 0 不接收。（可选）
*
*@return CodeSuccessReslut

func (*Message) PublishPrivate 

func (self *Message) PublishPrivate(fromUserId string, toUserId []string, voiceMessage VoiceMessage, pushContent string, pushData string, count string, verifyBlacklist int, isPersisted int, isCounted int, isIncludeSender int) (*CodeSuccessReslut, error)

* 

*发送单聊消息方法（一个用户向另外一个用户发送消息，单条消息最大 128k。每分钟最多发送 6000 条信息，每次发送用户上限为 1000 人，如：一次发送 1000 人时，示为 1000 条消息。）
*
*@param  fromUserId:发送人用户 Id。（必传）
*@param  toUserId:接收用户 Id，可以实现向多人发送消息，每次上限为 1000 人。（必传）
*@param  voiceMessage:消息。
*@param  pushContent:定义显示的 Push 内容，如果 objectName 为融云内置消息类型时，则发送后用户一定会收到 Push 信息。如果为自定义消息，则 pushContent 为自定义消息显示的 Push 内容，如果不传则用户不会收到 Push 通知。（可选）
*@param  pushData:针对 iOS 平台为 Push 通知时附加到 payload 中，Android 客户端收到推送消息时对应字段名为 pushData。（可选）
*@param  count:针对 iOS 平台，Push 时用来控制未读消息显示数，只有在 toUserId 为一个用户 Id 的时候有效。（可选）
*@param  verifyBlacklist:是否过滤发送人黑名单列表，0 表示为不过滤、 1 表示为过滤，默认为 0 不过滤。（可选）
*@param  isPersisted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行存储，0 表示为不存储、 1 表示为存储，默认为 1 存储消息。（可选）
*@param  isCounted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行未读消息计数，0 表示为不计数、 1 表示为计数，默认为 1 计数，未读消息数增加 1。（可选）
*@param  isIncludeSender:发送用户自已是否接收消息，0 表示为不接收，1 表示为接收，默认为 0 不接收。（可选）
*
*@return CodeSuccessReslut

func (*Message) PublishSystem 

func (self *Message) PublishSystem(fromUserId string, toUserId []string, txtMessage TxtMessage, pushContent string, pushData string, isPersisted int, isCounted int) (*CodeSuccessReslut, error)

* 

*发送系统消息方法（一个用户向一个或多个用户发送系统消息，单条消息最大 128k，会话类型为 SYSTEM。每秒钟最多发送 100 条消息，每次最多同时向 100 人发送，如：一次发送 100 人时，示为 100 条消息。）
*
*@param  fromUserId:发送人用户 Id。（必传）
*@param  toUserId:接收用户 Id，提供多个本参数可以实现向多人发送消息，上限为 1000 人。（必传）
*@param  txtMessage:发送消息内容（必传）
*@param  pushContent:如果为自定义消息，定义显示的 Push 内容，内容中定义标识通过 values 中设置的标识位内容进行替换.如消息类型为自定义不需要 Push 通知，则对应数组传空值即可。（可选）
*@param  pushData:针对 iOS 平台为 Push 通知时附加到 payload 中，Android 客户端收到推送消息时对应字段名为 pushData。如不需要 Push 功能对应数组传空值即可。（可选）
*@param  isPersisted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行存储，0 表示为不存储、 1 表示为存储，默认为 1 存储消息。（可选）
*@param  isCounted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行未读消息计数，0 表示为不计数、 1 表示为计数，默认为 1 计数，未读消息数增加 1。（可选）
*
*@return CodeSuccessReslut

func (*Message) PublishSystemTemplate 

func (self *Message) PublishSystemTemplate(templateMessage TemplateMessage) (*CodeSuccessReslut, error)

* 

*发送系统模板消息方法（一个用户向一个或多个用户发送系统消息，单条消息最大 128k，会话类型为 SYSTEM.每秒钟最多发送 100 条消息，每次最多同时向 100 人发送，如：一次发送 100 人时，示为 100 条消息。）
*
*@param  templateMessage:系统模版消息。
*
*@return CodeSuccessReslut

func (*Message) PublishTemplate 

func (self *Message) PublishTemplate(templateMessage TemplateMessage) (*CodeSuccessReslut, error)

* 

*发送单聊模板消息方法（一个用户向多个用户发送不同消息内容，单条消息最大 128k。每分钟最多发送 6000 条信息，每次发送用户上限为 1000 人。）
*
*@param  templateMessage:单聊模版消息。
*
*@return CodeSuccessReslut

type MsgObj 

type MsgObj struct {
	Content    string `json:"content"`
	ObjectName string `json:"objectName"`
}

* 

*用于Push中的message。

type Notification 

type Notification struct {
	Alert   string                `json:"alert"`
	Ios     *PlatformNotification `json:"ios"`
	Android *PlatformNotification `json:"android"`
}

* 

*按操作系统类型推送消息内容，如 platform 中设置了给 ios 和 android 系统推送消息，而在 notification 中只设置了 ios 的推送内容，则 android 的推送内容为最初 alert 设置的内容。（非必传）

type PlatformNotification 

type PlatformNotification struct {
	Alert  string            `json:"alert"`
	Extras map[string]string `json:"extras"`
}

* 

*设备中的推送内容。（非必传）

type ProfileNtfMessage 

type ProfileNtfMessage struct {
	Operation string `json:"operation"`
	Data      string `json:"data"`
	Extra     string `json:"extra"`
	// contains filtered or unexported fields
}

* 资料通知消息。此类型消息没有 Push 通知。

func (*ProfileNtfMessage) GetType 

func (self *ProfileNtfMessage) GetType() string

func (*ProfileNtfMessage) SetType 

func (self *ProfileNtfMessage) SetType(messageType string)

type Push 

type Push struct {
	AppKey    string
	AppSecret string
}

func (*Push) BroadcastPush 

func (self *Push) BroadcastPush(pushMessage PushMessage) (*CodeSuccessReslut, error)

* 

*广播消息方法（fromuserid 和 message为null即为不落地的push）
*
*@param  pushMessage:json数据
*
*@return CodeSuccessReslut

func (*Push) SetUserPushTag 

func (self *Push) SetUserPushTag(userTag UserTag) (*CodeSuccessReslut, error)

* 

*添加 Push 标签方法
*
*@param  userTag:用户标签。
*
*@return CodeSuccessReslut

type PushMessage 

type PushMessage struct {
	Platform     []string      `json:"platform"`
	Fromuserid   string        `json:"fromuserid"`
	Audience     *TagObj       `json:"audience"`
	Message      *MsgObj       `json:"message"`
	Notification *Notification `json:"notification"`
}

* 

*不落地 push 消息体。

type QueryBlacklistUserReslut 

type QueryBlacklistUserReslut struct {
	Code         int      `json:"code"`
	Users        []string `json:"users"`
	ErrorMessage string   `json:"errorMessage"`
}

* 

*queryBlacklistUser返回结果

type QueryBlockUserReslut 

type QueryBlockUserReslut struct {
	Code         int          `json:"code"`
	Users        []BlockUsers `json:"users"`
	ErrorMessage string       `json:"errorMessage"`
}

* 

*queryBlockUser返回结果

type RongCloud 

type RongCloud struct {
	AppKey    string
	AppSecret string

	User       User
	Message    Message
	Wordfilter Wordfilter
	Group      Group
	Chatroom   Chatroom
	Push       Push
	SMS        SMS
}

func CreateRongCloud 

func CreateRongCloud(appKey, appSecret string) *RongCloud

type SMS 

type SMS struct {
	AppKey    string
	AppSecret string
}

func (*SMS) GetImageCode 

func (self *SMS) GetImageCode(appKey string) (*SMSImageCodeReslut, error)

* 

*获取图片验证码方法
*
*@param  appKey:应用Id
*
*@return SMSImageCodeReslut

func (*SMS) SendCode 

func (self *SMS) SendCode(mobile string, templateId string, region string, verifyId string, verifyCode string) (*SMSSendCodeReslut, error)

* 

*发送短信验证码方法。
*
*@param  mobile:接收短信验证码的目标手机号，每分钟同一手机号只能发送一次短信验证码，同一手机号 1 小时内最多发送 3 次。（必传）
*@param  templateId:短信模板 Id，在开发者后台->短信服务->服务设置->短信模版中获取。（必传）
*@param  region:手机号码所属国家区号，目前只支持中图区号 86）
*@param  verifyId:图片验证标识 Id ，开启图片验证功能后此参数必传，否则可以不传。在获取图片验证码方法返回值中获取。
*@param  verifyCode:图片验证码，开启图片验证功能后此参数必传，否则可以不传。
*
*@return SMSSendCodeReslut

func (*SMS) VerifyCode 

func (self *SMS) VerifyCode(sessionId string, code string) (*SMSVerifyCodeResult, error)

* 

*验证码验证方法
*
*@param  sessionId:短信验证码唯一标识，在发送短信验证码方法，返回值中获取。（必传）
*@param  code:短信验证码内容。（必传）
*
*@return SMSVerifyCodeResult

type SMSImageCodeReslut 

type SMSImageCodeReslut struct {
	Code         int    `json:"code"`
	Url          string `json:"url"`
	VerifyId     string `json:"verifyId"`
	ErrorMessage string `json:"errorMessage"`
}

*

  • getImageCode 成功返回结果

type SMSSendCodeReslut 

type SMSSendCodeReslut struct {
	Code         int    `json:"code"`
	SessionId    string `json:"sessionId"`
	ErrorMessage string `json:"errorMessage"`
}

*

  • SMSSendCodeReslut 成功返回结果

type SMSVerifyCodeResult 

type SMSVerifyCodeResult struct {
	Code         int    `json:"code"`
	Success      bool   `json:"success"`
	ErrorMessage string `json:"errorMessage"`
}

*

  • VerifyCode 返回结果

type TagObj 

type TagObj struct {
	Tag       []string `json:"tag"`
	Userid    []string `json:"userid"`
	Is_to_all bool     `json:"is_to_all"`
}

* 

*用于Push中的 标签。

type TemplateMessage 

type TemplateMessage struct {
	FromUserId      string              `json:"fromUserId"`
	ToUserId        []string            `json:"toUserId"`
	Content         string              `json:"content"`
	Values          []map[string]string `json:"values"`
	ObjectName      string              `json:"objectName"`
	PushContent     []string            `json:"pushContent"`
	PushData        []string            `json:"pushData"`
	VerifyBlacklist int                 `json:"verifyBlacklist"`
}

* 

*模版消息对象。

type TokenReslut 

type TokenReslut struct {
	Code         int    `json:"code"`
	Token        string `json:"token"`
	UserId       string `json:"userId"`
	ErrorMessage string `json:"errorMessage"`
}

* 

*getToken 返回结果

type TxtMessage 

type TxtMessage struct {
	Content string `json:"content"`
	Extra   string `json:"extra"`
	// contains filtered or unexported fields
}

* 文本消息。

func (*TxtMessage) GetType 

func (self *TxtMessage) GetType() string

func (*TxtMessage) SetType 

func (self *TxtMessage) SetType(messageType string)

type User 

type User struct {
	AppKey    string
	AppSecret string
}

func (*User) AddBlacklist 

func (self *User) AddBlacklist(userId string, blackUserId string) (*CodeSuccessReslut, error)

* 

*添加用户到黑名单方法（每秒钟限 100 次）
*
*@param  userId:用户 Id。（必传）
*@param  blackUserId:被加到黑名单的用户Id。（必传）
*
*@return CodeSuccessReslut

func (*User) Block 

func (self *User) Block(userId string, minute int) (*CodeSuccessReslut, error)

* 

*封禁用户方法（每秒钟限 100 次）
*
*@param  userId:用户 Id。（必传）
*@param  minute:封禁时长,单位为分钟，最大值为43200分钟。（必传）
*
*@return CodeSuccessReslut

func (*User) CheckOnline 

func (self *User) CheckOnline(userId string) (*CheckOnlineReslut, error)

* 

*检查用户在线状态 方法
*
*@param  userId:用户 Id，最大长度 64 字节。是用户在 App 中的唯一标识码，必须保证在同一个 App 内不重复，重复的用户 Id 将被当作是同一用户。（必传）
*
*@return CheckOnlineReslut

func (*User) GetToken 

func (self *User) GetToken(userId string, name string, portraitUri string) (*TokenReslut, error)

* 

*获取 Token 方法
*
*@param  userId:用户 Id，最大长度 64 字节.是用户在 App 中的唯一标识码，必须保证在同一个 App 内不重复，重复的用户 Id 将被当作是同一用户。（必传）
*@param  name:用户名称，最大长度 128 字节.用来在 Push 推送时显示用户的名称.用户名称，最大长度 128 字节.用来在 Push 推送时显示用户的名称。（必传）
*@param  portraitUri:用户头像 URI，最大长度 1024 字节.用来在 Push 推送时显示用户的头像。（必传）
*
*@return TokenReslut

func (*User) QueryBlacklist 

func (self *User) QueryBlacklist(userId string) (*QueryBlacklistUserReslut, error)

* 

*获取某用户的黑名单列表方法（每秒钟限 100 次）
*
*@param  userId:用户 Id。（必传）
*
*@return QueryBlacklistUserReslut

func (*User) QueryBlock 

func (self *User) QueryBlock() (*QueryBlockUserReslut, error)

* 

*获取被封禁用户方法（每秒钟限 100 次）
*
*
*@return QueryBlockUserReslut

func (*User) Refresh 

func (self *User) Refresh(userId string, name string, portraitUri string) (*CodeSuccessReslut, error)

* 

*刷新用户信息方法
*
*@param  userId:用户 Id，最大长度 64 字节.是用户在 App 中的唯一标识码，必须保证在同一个 App 内不重复，重复的用户 Id 将被当作是同一用户。（必传）
*@param  name:用户名称，最大长度 128 字节。用来在 Push 推送时，显示用户的名称，刷新用户名称后 5 分钟内生效。（可选，提供即刷新，不提供忽略）
*@param  portraitUri:用户头像 URI，最大长度 1024 字节。用来在 Push 推送时显示。（可选，提供即刷新，不提供忽略）
*
*@return CodeSuccessReslut

func (*User) RemoveBlacklist 

func (self *User) RemoveBlacklist(userId string, blackUserId string) (*CodeSuccessReslut, error)

* 

*从黑名单中移除用户方法（每秒钟限 100 次）
*
*@param  userId:用户 Id。（必传）
*@param  blackUserId:被移除的用户Id。（必传）
*
*@return CodeSuccessReslut

func (*User) UnBlock 

func (self *User) UnBlock(userId string) (*CodeSuccessReslut, error)

* 

*解除用户封禁方法（每秒钟限 100 次）
*
*@param  userId:用户 Id。（必传）
*
*@return CodeSuccessReslut

type UserTag 

type UserTag struct {
	Tags   []string `json:"tags"`
	UserId string   `json:"userId"`
}

* 

*用于打标签的对象。

type VoiceMessage 

type VoiceMessage struct {
	Content  string `json:"content"`
	Extra    string `json:"extra"`
	Duration int64  `json:"duration"`
	// contains filtered or unexported fields
}

* 语音消息。

func (*VoiceMessage) GetType 

func (self *VoiceMessage) GetType() string

func (*VoiceMessage) SetType 

func (self *VoiceMessage) SetType(messageType string)

type Wordfilter 

type Wordfilter struct {
	AppKey    string
	AppSecret string
}

func (*Wordfilter) Add 

func (self *Wordfilter) Add(word string) (*CodeSuccessReslut, error)

* 

*添加敏感词方法（设置敏感词后，App 中用户不会收到含有敏感词的消息内容，默认最多设置 50 个敏感词。）
*
*@param  word:敏感词，最长不超过 32 个字符。（必传）
*
*@return CodeSuccessReslut

func (*Wordfilter) Delete 

func (self *Wordfilter) Delete(word string) (*CodeSuccessReslut, error)

* 

*移除敏感词方法（从敏感词列表中，移除某一敏感词。）
*
*@param  word:敏感词，最长不超过 32 个字符。（必传）
*
*@return CodeSuccessReslut

func (*Wordfilter) GetList 

func (self *Wordfilter) GetList() (*ListWordfilterReslut, error)

* 

*查询敏感词列表方法
*
*
*@return ListWordfilterReslut

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.