openim

package
v1.2.0 Latest Latest
Warning

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

Go to latest
Published: Jul 1, 2021 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

openimAPI model

https://open.taobao.com/API.htm?docId=25766&docType=2

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CustMsg

type CustMsg struct {
	// 发送方userid
	FromUser string `json:"from_user,omitempty" xml:"from_user,omitempty"`
	// 接收方appkey,不填默认是发送方appkey,如需跨app发送,需要走审批流程,请联系技术答疑
	ToAppkey string `json:"to_appkey,omitempty" xml:"to_appkey,omitempty"`
	// 接受者userid列表,单次发送用户数小于100
	ToUsers []string `json:"to_users,omitempty" xml:"to_users>string,omitempty"`
	// 客户端最近消息里面显示的消息摘要
	Summary string `json:"summary,omitempty" xml:"summary,omitempty"`
	// 发送的自定义数据,sdk默认无法解析消息,该数据需要客户端自己解析
	Data string `json:"data,omitempty" xml:"data,omitempty"`
	// apns推送时,里面的aps结构体json字符串,aps.alert为必填字段。本字段为可选,若为空,则表示不进行apns推送。aps.size() + apns_param.size() < 200
	Aps string `json:"aps,omitempty" xml:"aps,omitempty"`
	// apns推送的附带数据。客户端收到apns消息后,可以从apns结构体的"d"字段中取出该内容。aps.size() + apns_param.size() < 200
	ApnsParam string `json:"apns_param,omitempty" xml:"apns_param,omitempty"`
	// 表示消息是否在最近会话列表里面展示。如果为1,则消息不在列表展示,可以认为服务端透明的给客户端下法了一个数据,ios的提示任然通过aps字段控制
	Invisible int64 `json:"invisible,omitempty" xml:"invisible,omitempty"`
	// 可以指定发送方的显示昵称,默认为空,自动使用发送方用户id作为nick
	FromNick string `json:"from_nick,omitempty" xml:"from_nick,omitempty"`
	// 如果为1,则表示发送方是一个淘宝账号,该账号必须是本appkey绑定过的客服账号,并且只能给本appkey的用户发消息。通过该参数可以从服务端发起一个客服到用户的会话。
	FromTaobao int64 `json:"from_taobao,omitempty" xml:"from_taobao,omitempty"`
}

CustMsg

type EsMessage

type EsMessage struct {
	// 消息时间,UTC时间
	Time int64 `json:"time,omitempty" xml:"time,omitempty"`
	// 消息UUID
	Uuid int64 `json:"uuid,omitempty" xml:"uuid,omitempty"`
	// 消息类型
	Type int64 `json:"type,omitempty" xml:"type,omitempty"`
	// 发送方
	FromId *OpenImUser `json:"from_id,omitempty" xml:"from_id,omitempty"`
	// 接收方
	ToId *OpenImUser `json:"to_id,omitempty" xml:"to_id,omitempty"`
	// 消息内容
	Content []RoamingMessageItem `json:"content,omitempty" xml:"content>roaming_message_item,omitempty"`
}

EsMessage

type EsMessageResult

type EsMessageResult struct {
	// 消息序列
	Messages []EsMessage `json:"messages,omitempty" xml:"messages>es_message,omitempty"`
	// nextkey
	NextKey string `json:"next_key,omitempty" xml:"next_key,omitempty"`
}

EsMessageResult

type ImMsg

type ImMsg struct {
	// 消息发送者
	FromUser string `json:"from_user,omitempty" xml:"from_user,omitempty"`
	// 消息接受者
	ToUsers []string `json:"to_users,omitempty" xml:"to_users>string,omitempty"`
	// 消息类型。0:文本消息。1:图片消息,只支持jpg、gif。2:语音消息,只支持amr。8:地理位置信息。
	MsgType int64 `json:"msg_type,omitempty" xml:"msg_type,omitempty"`
	// 发送的消息内容。根据不同消息类型,传不同的值。0(文本消息):填消息内容字符串。1(图片):base64编码的jpg或gif文件。3(语音):base64编码的amr文件。8(地理位置):经纬度,格式如 111,222
	Context string `json:"context,omitempty" xml:"context,omitempty"`
	// 接收方appkey,默认本app,跨app发送时需要用到
	ToAppkey string `json:"to_appkey,omitempty" xml:"to_appkey,omitempty"`
	// json map,媒体信息属性。根据msgtype变化。0(文本):填空即可。 1(图片):需要图片格式,{"type":"jpg"}或{"type":"gif"}。   2(语音): 需要文件格式和语音长度信息{"type":"amr","playtime":5}
	MediaAttr string `json:"media_attr,omitempty" xml:"media_attr,omitempty"`
	// 如果为1,则表示发送方是一个淘宝账号,该账号必须是本appkey绑定过的客服账号,并且只能给本appkey的用户发消息。通过该参数可以从服务端发起一个客服到用户的会话。
	FromTaobao int64 `json:"from_taobao,omitempty" xml:"from_taobao,omitempty"`
}

ImMsg

type MessageItem

type MessageItem struct {
	// 节点类型
	Type string `json:"type,omitempty" xml:"type,omitempty"`
	// 节点值
	Value string `json:"value,omitempty" xml:"value,omitempty"`
}

MessageItem

type OpenImUser

type OpenImUser struct {
	// 用户id
	Uid string `json:"uid,omitempty" xml:"uid,omitempty"`
	// 是否为淘宝账号
	TaobaoAccount bool `json:"taobao_account,omitempty" xml:"taobao_account,omitempty"`
	// 账户appkey
	AppKey string `json:"app_key,omitempty" xml:"app_key,omitempty"`
}

OpenImUser

type RoamingMessage

type RoamingMessage struct {
	// 消息内容
	ContentList []RoamingMessageItem `json:"content_list,omitempty" xml:"content_list>roaming_message_item,omitempty"`
	// 消息时间(UTC时间)
	Time int64 `json:"time,omitempty" xml:"time,omitempty"`
	// 消息方向。user1 -> user2 = 0 , user2->user1 = 1
	Direction int64 `json:"direction,omitempty" xml:"direction,omitempty"`
	// 消息唯一ID
	Uuid int64 `json:"uuid,omitempty" xml:"uuid,omitempty"`
	// 消息类型
	Type int64 `json:"type,omitempty" xml:"type,omitempty"`
}

RoamingMessage

type RoamingMessageItem

type RoamingMessageItem struct {
	// 节点类型
	Type string `json:"type,omitempty" xml:"type,omitempty"`
	// 值
	Value string `json:"value,omitempty" xml:"value,omitempty"`
}

RoamingMessageItem

type RoamingMessageResult

type RoamingMessageResult struct {
	// 下次迭代key
	NextKey string `json:"next_key,omitempty" xml:"next_key,omitempty"`
	// 消息列表
	Messages []RoamingMessage `json:"messages,omitempty" xml:"messages>roaming_message,omitempty"`
}

RoamingMessageResult

type TaobaoOpenimAppChatlogsGetAPIRequest added in v1.2.0

type TaobaoOpenimAppChatlogsGetAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

openim应用聊天记录查询 API请求 taobao.openim.app.chatlogs.get

查询openim应用的聊天记录

func NewTaobaoOpenimAppChatlogsGetRequest

func NewTaobaoOpenimAppChatlogsGetRequest() *TaobaoOpenimAppChatlogsGetAPIRequest

初始化TaobaoOpenimAppChatlogsGetAPIRequest对象

func (TaobaoOpenimAppChatlogsGetAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimAppChatlogsGetAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimAppChatlogsGetAPIRequest) GetApiParams added in v1.2.0

IRequest interface 方法, 获取API参数

func (TaobaoOpenimAppChatlogsGetAPIRequest) GetBeg added in v1.2.0

Beg Getter

func (TaobaoOpenimAppChatlogsGetAPIRequest) GetCount added in v1.2.0

Count Getter

func (TaobaoOpenimAppChatlogsGetAPIRequest) GetEnd added in v1.2.0

End Getter

func (TaobaoOpenimAppChatlogsGetAPIRequest) GetNext added in v1.2.0

Next Getter

func (*TaobaoOpenimAppChatlogsGetAPIRequest) SetBeg added in v1.2.0

Beg Setter 查询结束时间。UTC时间。精度到秒

func (*TaobaoOpenimAppChatlogsGetAPIRequest) SetCount added in v1.2.0

func (r *TaobaoOpenimAppChatlogsGetAPIRequest) SetCount(_count int64) error

Count Setter 查询最大条数

func (*TaobaoOpenimAppChatlogsGetAPIRequest) SetEnd added in v1.2.0

End Setter 查询结束时间。UTC时间。精度到秒

func (*TaobaoOpenimAppChatlogsGetAPIRequest) SetNext added in v1.2.0

Next Setter 迭代key

type TaobaoOpenimAppChatlogsGetAPIResponse

type TaobaoOpenimAppChatlogsGetAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimAppChatlogsGetAPIResponseModel
}

openim应用聊天记录查询 API返回值 taobao.openim.app.chatlogs.get

查询openim应用的聊天记录

type TaobaoOpenimAppChatlogsGetAPIResponseModel added in v1.2.0

type TaobaoOpenimAppChatlogsGetAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_app_chatlogs_get_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 查询结果
	Result *EsMessageResult `json:"result,omitempty" xml:"result,omitempty"`
}

openim应用聊天记录查询 成功返回结果

type TaobaoOpenimChatlogsGetAPIRequest added in v1.2.0

type TaobaoOpenimChatlogsGetAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

openim聊天记录查询接口 API请求 taobao.openim.chatlogs.get

查询openim账号聊天记录

func NewTaobaoOpenimChatlogsGetRequest

func NewTaobaoOpenimChatlogsGetRequest() *TaobaoOpenimChatlogsGetAPIRequest

初始化TaobaoOpenimChatlogsGetAPIRequest对象

func (TaobaoOpenimChatlogsGetAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimChatlogsGetAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimChatlogsGetAPIRequest) GetApiParams added in v1.2.0

func (r TaobaoOpenimChatlogsGetAPIRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (TaobaoOpenimChatlogsGetAPIRequest) GetBegin added in v1.2.0

Begin Getter

func (TaobaoOpenimChatlogsGetAPIRequest) GetCount added in v1.2.0

Count Getter

func (TaobaoOpenimChatlogsGetAPIRequest) GetEnd added in v1.2.0

End Getter

func (TaobaoOpenimChatlogsGetAPIRequest) GetNextKey added in v1.2.0

NextKey Getter

func (TaobaoOpenimChatlogsGetAPIRequest) GetUser1 added in v1.2.0

User1 Getter

func (TaobaoOpenimChatlogsGetAPIRequest) GetUser2 added in v1.2.0

User2 Getter

func (*TaobaoOpenimChatlogsGetAPIRequest) SetBegin added in v1.2.0

func (r *TaobaoOpenimChatlogsGetAPIRequest) SetBegin(_begin int64) error

Begin Setter 查询开始时间(UTC时间)

func (*TaobaoOpenimChatlogsGetAPIRequest) SetCount added in v1.2.0

func (r *TaobaoOpenimChatlogsGetAPIRequest) SetCount(_count int64) error

Count Setter 查询条数

func (*TaobaoOpenimChatlogsGetAPIRequest) SetEnd added in v1.2.0

End Setter 查询结束时间(UTC时间)

func (*TaobaoOpenimChatlogsGetAPIRequest) SetNextKey added in v1.2.0

func (r *TaobaoOpenimChatlogsGetAPIRequest) SetNextKey(_nextKey string) error

NextKey Setter 迭代key

func (*TaobaoOpenimChatlogsGetAPIRequest) SetUser1 added in v1.2.0

func (r *TaobaoOpenimChatlogsGetAPIRequest) SetUser1(_user1 *OpenImUser) error

User1 Setter 用户1信息

func (*TaobaoOpenimChatlogsGetAPIRequest) SetUser2 added in v1.2.0

func (r *TaobaoOpenimChatlogsGetAPIRequest) SetUser2(_user2 *OpenImUser) error

User2 Setter 用户2信息

type TaobaoOpenimChatlogsGetAPIResponse

type TaobaoOpenimChatlogsGetAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimChatlogsGetAPIResponseModel
}

openim聊天记录查询接口 API返回值 taobao.openim.chatlogs.get

查询openim账号聊天记录

type TaobaoOpenimChatlogsGetAPIResponseModel added in v1.2.0

type TaobaoOpenimChatlogsGetAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_chatlogs_get_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 聊天记录查询结果
	Result *RoamingMessageResult `json:"result,omitempty" xml:"result,omitempty"`
}

openim聊天记录查询接口 成功返回结果

type TaobaoOpenimChatlogsImportAPIRequest added in v1.2.0

type TaobaoOpenimChatlogsImportAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

openim单聊消息导入 API请求 taobao.openim.chatlogs.import

提供openim账号的聊天消息导入功能

func NewTaobaoOpenimChatlogsImportRequest

func NewTaobaoOpenimChatlogsImportRequest() *TaobaoOpenimChatlogsImportAPIRequest

初始化TaobaoOpenimChatlogsImportAPIRequest对象

func (TaobaoOpenimChatlogsImportAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimChatlogsImportAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimChatlogsImportAPIRequest) GetApiParams added in v1.2.0

IRequest interface 方法, 获取API参数

func (TaobaoOpenimChatlogsImportAPIRequest) GetMessages added in v1.2.0

Messages Getter

func (*TaobaoOpenimChatlogsImportAPIRequest) SetMessages added in v1.2.0

func (r *TaobaoOpenimChatlogsImportAPIRequest) SetMessages(_messages []TextMessage) error

Messages Setter 消息序列

type TaobaoOpenimChatlogsImportAPIResponse

type TaobaoOpenimChatlogsImportAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimChatlogsImportAPIResponseModel
}

openim单聊消息导入 API返回值 taobao.openim.chatlogs.import

提供openim账号的聊天消息导入功能

type TaobaoOpenimChatlogsImportAPIResponseModel added in v1.2.0

type TaobaoOpenimChatlogsImportAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_chatlogs_import_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 错误码
	Ret int64 `json:"ret,omitempty" xml:"ret,omitempty"`
	// 错误信息
	Message string `json:"message,omitempty" xml:"message,omitempty"`
	// 是否成功
	Succ bool `json:"succ,omitempty" xml:"succ,omitempty"`
}

openim单聊消息导入 成功返回结果

type TaobaoOpenimCustmsgPushAPIRequest added in v1.2.0

type TaobaoOpenimCustmsgPushAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

推送自定义openim消息 API请求 taobao.openim.custmsg.push

isv通过该接口给openim用户推送自定义消息

func NewTaobaoOpenimCustmsgPushRequest

func NewTaobaoOpenimCustmsgPushRequest() *TaobaoOpenimCustmsgPushAPIRequest

初始化TaobaoOpenimCustmsgPushAPIRequest对象

func (TaobaoOpenimCustmsgPushAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimCustmsgPushAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimCustmsgPushAPIRequest) GetApiParams added in v1.2.0

func (r TaobaoOpenimCustmsgPushAPIRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (TaobaoOpenimCustmsgPushAPIRequest) GetCustmsg added in v1.2.0

Custmsg Getter

func (*TaobaoOpenimCustmsgPushAPIRequest) SetCustmsg added in v1.2.0

func (r *TaobaoOpenimCustmsgPushAPIRequest) SetCustmsg(_custmsg *CustMsg) error

Custmsg Setter 自定义消息内容

type TaobaoOpenimCustmsgPushAPIResponse

type TaobaoOpenimCustmsgPushAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimCustmsgPushAPIResponseModel
}

推送自定义openim消息 API返回值 taobao.openim.custmsg.push

isv通过该接口给openim用户推送自定义消息

type TaobaoOpenimCustmsgPushAPIResponseModel added in v1.2.0

type TaobaoOpenimCustmsgPushAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_custmsg_push_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 消息id,用于定位问题
	Msgid int64 `json:"msgid,omitempty" xml:"msgid,omitempty"`
}

推送自定义openim消息 成功返回结果

type TaobaoOpenimImmsgPushAPIRequest added in v1.2.0

type TaobaoOpenimImmsgPushAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

openim标准消息发送 API请求 taobao.openim.immsg.push

服务端对openim用户发送标准消息,包括文字、语音、图片等。

func NewTaobaoOpenimImmsgPushRequest

func NewTaobaoOpenimImmsgPushRequest() *TaobaoOpenimImmsgPushAPIRequest

初始化TaobaoOpenimImmsgPushAPIRequest对象

func (TaobaoOpenimImmsgPushAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimImmsgPushAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimImmsgPushAPIRequest) GetApiParams added in v1.2.0

func (r TaobaoOpenimImmsgPushAPIRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (TaobaoOpenimImmsgPushAPIRequest) GetImmsg added in v1.2.0

func (r TaobaoOpenimImmsgPushAPIRequest) GetImmsg() *ImMsg

Immsg Getter

func (*TaobaoOpenimImmsgPushAPIRequest) SetImmsg added in v1.2.0

func (r *TaobaoOpenimImmsgPushAPIRequest) SetImmsg(_immsg *ImMsg) error

Immsg Setter openim消息结构体

type TaobaoOpenimImmsgPushAPIResponse

type TaobaoOpenimImmsgPushAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimImmsgPushAPIResponseModel
}

openim标准消息发送 API返回值 taobao.openim.immsg.push

服务端对openim用户发送标准消息,包括文字、语音、图片等。

type TaobaoOpenimImmsgPushAPIResponseModel added in v1.2.0

type TaobaoOpenimImmsgPushAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_immsg_push_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 消息id,方便定位问题
	Msgid int64 `json:"msgid,omitempty" xml:"msgid,omitempty"`
}

openim标准消息发送 成功返回结果

type TaobaoOpenimIoscertProductionSetAPIRequest added in v1.2.0

type TaobaoOpenimIoscertProductionSetAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

设置ios证书 API请求 taobao.openim.ioscert.production.set

设置ios证书

func NewTaobaoOpenimIoscertProductionSetRequest

func NewTaobaoOpenimIoscertProductionSetRequest() *TaobaoOpenimIoscertProductionSetAPIRequest

初始化TaobaoOpenimIoscertProductionSetAPIRequest对象

func (TaobaoOpenimIoscertProductionSetAPIRequest) GetApiMethodName added in v1.2.0

IRequest interface 方法, 获取Api method

func (TaobaoOpenimIoscertProductionSetAPIRequest) GetApiParams added in v1.2.0

IRequest interface 方法, 获取API参数

func (TaobaoOpenimIoscertProductionSetAPIRequest) GetCert added in v1.2.0

Cert Getter

func (TaobaoOpenimIoscertProductionSetAPIRequest) GetPassword added in v1.2.0

Password Getter

func (*TaobaoOpenimIoscertProductionSetAPIRequest) SetCert added in v1.2.0

Cert Setter 证书文件内容,base64编码

func (*TaobaoOpenimIoscertProductionSetAPIRequest) SetPassword added in v1.2.0

func (r *TaobaoOpenimIoscertProductionSetAPIRequest) SetPassword(_password string) error

Password Setter 证书密码

type TaobaoOpenimIoscertProductionSetAPIResponse

type TaobaoOpenimIoscertProductionSetAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimIoscertProductionSetAPIResponseModel
}

设置ios证书 API返回值 taobao.openim.ioscert.production.set

设置ios证书

type TaobaoOpenimIoscertProductionSetAPIResponseModel added in v1.2.0

type TaobaoOpenimIoscertProductionSetAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_ioscert_production_set_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 操作成功
	Code string `json:"code,omitempty" xml:"code,omitempty"`
}

设置ios证书 成功返回结果

type TaobaoOpenimIoscertSandboxSetAPIRequest added in v1.2.0

type TaobaoOpenimIoscertSandboxSetAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

设置开发环境证书 API请求 taobao.openim.ioscert.sandbox.set

设置开发环境证书

func NewTaobaoOpenimIoscertSandboxSetRequest

func NewTaobaoOpenimIoscertSandboxSetRequest() *TaobaoOpenimIoscertSandboxSetAPIRequest

初始化TaobaoOpenimIoscertSandboxSetAPIRequest对象

func (TaobaoOpenimIoscertSandboxSetAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimIoscertSandboxSetAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimIoscertSandboxSetAPIRequest) GetApiParams added in v1.2.0

IRequest interface 方法, 获取API参数

func (TaobaoOpenimIoscertSandboxSetAPIRequest) GetCert added in v1.2.0

Cert Getter

func (TaobaoOpenimIoscertSandboxSetAPIRequest) GetPassword added in v1.2.0

Password Getter

func (*TaobaoOpenimIoscertSandboxSetAPIRequest) SetCert added in v1.2.0

Cert Setter 证书内容,base64编码

func (*TaobaoOpenimIoscertSandboxSetAPIRequest) SetPassword added in v1.2.0

func (r *TaobaoOpenimIoscertSandboxSetAPIRequest) SetPassword(_password string) error

Password Setter 系统自动生成

type TaobaoOpenimIoscertSandboxSetAPIResponse

type TaobaoOpenimIoscertSandboxSetAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimIoscertSandboxSetAPIResponseModel
}

设置开发环境证书 API返回值 taobao.openim.ioscert.sandbox.set

设置开发环境证书

type TaobaoOpenimIoscertSandboxSetAPIResponseModel added in v1.2.0

type TaobaoOpenimIoscertSandboxSetAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_ioscert_sandbox_set_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 操作成功
	Code string `json:"code,omitempty" xml:"code,omitempty"`
}

设置开发环境证书 成功返回结果

type TaobaoOpenimRelationsGetAPIRequest added in v1.2.0

type TaobaoOpenimRelationsGetAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

获取openim账号的聊天关系 API请求 taobao.openim.relations.get

获取openim账号的聊天关系

func NewTaobaoOpenimRelationsGetRequest

func NewTaobaoOpenimRelationsGetRequest() *TaobaoOpenimRelationsGetAPIRequest

初始化TaobaoOpenimRelationsGetAPIRequest对象

func (TaobaoOpenimRelationsGetAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimRelationsGetAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimRelationsGetAPIRequest) GetApiParams added in v1.2.0

IRequest interface 方法, 获取API参数

func (TaobaoOpenimRelationsGetAPIRequest) GetBegDate added in v1.2.0

BegDate Getter

func (TaobaoOpenimRelationsGetAPIRequest) GetEndDate added in v1.2.0

EndDate Getter

func (TaobaoOpenimRelationsGetAPIRequest) GetUser added in v1.2.0

User Getter

func (*TaobaoOpenimRelationsGetAPIRequest) SetBegDate added in v1.2.0

func (r *TaobaoOpenimRelationsGetAPIRequest) SetBegDate(_begDate string) error

BegDate Setter 查询起始日期。格式yyyyMMdd。不得早于一个月

func (*TaobaoOpenimRelationsGetAPIRequest) SetEndDate added in v1.2.0

func (r *TaobaoOpenimRelationsGetAPIRequest) SetEndDate(_endDate string) error

EndDate Setter 查询结束日期。格式yyyyMMdd。不得早于一个月

func (*TaobaoOpenimRelationsGetAPIRequest) SetUser added in v1.2.0

User Setter 用户信息

type TaobaoOpenimRelationsGetAPIResponse

type TaobaoOpenimRelationsGetAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimRelationsGetAPIResponseModel
}

获取openim账号的聊天关系 API返回值 taobao.openim.relations.get

获取openim账号的聊天关系

type TaobaoOpenimRelationsGetAPIResponseModel added in v1.2.0

type TaobaoOpenimRelationsGetAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_relations_get_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 用户信息列表
	Users []OpenImUser `json:"users,omitempty" xml:"users>open_im_user,omitempty"`
}

获取openim账号的聊天关系 成功返回结果

type TaobaoOpenimSnfilterwordSetfilterAPIRequest added in v1.2.0

type TaobaoOpenimSnfilterwordSetfilterAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

关键词过滤 API请求 taobao.openim.snfilterword.setfilter

设置openim关键词过滤

func NewTaobaoOpenimSnfilterwordSetfilterRequest

func NewTaobaoOpenimSnfilterwordSetfilterRequest() *TaobaoOpenimSnfilterwordSetfilterAPIRequest

初始化TaobaoOpenimSnfilterwordSetfilterAPIRequest对象

func (TaobaoOpenimSnfilterwordSetfilterAPIRequest) GetApiMethodName added in v1.2.0

IRequest interface 方法, 获取Api method

func (TaobaoOpenimSnfilterwordSetfilterAPIRequest) GetApiParams added in v1.2.0

IRequest interface 方法, 获取API参数

func (TaobaoOpenimSnfilterwordSetfilterAPIRequest) GetCreator added in v1.2.0

Creator Getter

func (TaobaoOpenimSnfilterwordSetfilterAPIRequest) GetDesc added in v1.2.0

Desc Getter

func (TaobaoOpenimSnfilterwordSetfilterAPIRequest) GetFilterword added in v1.2.0

Filterword Getter

func (*TaobaoOpenimSnfilterwordSetfilterAPIRequest) SetCreator added in v1.2.0

Creator Setter 上传者身份信息,区分不同上传者;只是记录,没有身份校验功能

func (*TaobaoOpenimSnfilterwordSetfilterAPIRequest) SetDesc added in v1.2.0

Desc Setter 过滤原因描述

func (*TaobaoOpenimSnfilterwordSetfilterAPIRequest) SetFilterword added in v1.2.0

func (r *TaobaoOpenimSnfilterwordSetfilterAPIRequest) SetFilterword(_filterword string) error

Filterword Setter 需要过滤的关键词

type TaobaoOpenimSnfilterwordSetfilterAPIResponse

type TaobaoOpenimSnfilterwordSetfilterAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimSnfilterwordSetfilterAPIResponseModel
}

关键词过滤 API返回值 taobao.openim.snfilterword.setfilter

设置openim关键词过滤

type TaobaoOpenimSnfilterwordSetfilterAPIResponseModel added in v1.2.0

type TaobaoOpenimSnfilterwordSetfilterAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_snfilterword_setfilter_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 成功
	Errid int64 `json:"errid,omitempty" xml:"errid,omitempty"`
	// 错误原因
	Errmsg string `json:"errmsg,omitempty" xml:"errmsg,omitempty"`
}

关键词过滤 成功返回结果

type TaobaoOpenimTribeCreateAPIRequest added in v1.2.0

type TaobaoOpenimTribeCreateAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

创建群 API请求 taobao.openim.tribe.create

创建一个openim的群

func NewTaobaoOpenimTribeCreateRequest

func NewTaobaoOpenimTribeCreateRequest() *TaobaoOpenimTribeCreateAPIRequest

初始化TaobaoOpenimTribeCreateAPIRequest对象

func (TaobaoOpenimTribeCreateAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimTribeCreateAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimTribeCreateAPIRequest) GetApiParams added in v1.2.0

func (r TaobaoOpenimTribeCreateAPIRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (TaobaoOpenimTribeCreateAPIRequest) GetMembers added in v1.2.0

Members Getter

func (TaobaoOpenimTribeCreateAPIRequest) GetNotice added in v1.2.0

Notice Getter

func (TaobaoOpenimTribeCreateAPIRequest) GetTribeName added in v1.2.0

func (r TaobaoOpenimTribeCreateAPIRequest) GetTribeName() string

TribeName Getter

func (TaobaoOpenimTribeCreateAPIRequest) GetTribeType added in v1.2.0

func (r TaobaoOpenimTribeCreateAPIRequest) GetTribeType() int64

TribeType Getter

func (TaobaoOpenimTribeCreateAPIRequest) GetUser added in v1.2.0

User Getter

func (*TaobaoOpenimTribeCreateAPIRequest) SetMembers added in v1.2.0

func (r *TaobaoOpenimTribeCreateAPIRequest) SetMembers(_members []OpenImUser) error

Members Setter 创建群时候拉入群的成员tribe_type = 1(即为讨论组类型)时 该参数为必选tribe_type = 0 (即为普通群类型)时,改参数无效,可不填

func (*TaobaoOpenimTribeCreateAPIRequest) SetNotice added in v1.2.0

func (r *TaobaoOpenimTribeCreateAPIRequest) SetNotice(_notice string) error

Notice Setter 群公告

func (*TaobaoOpenimTribeCreateAPIRequest) SetTribeName added in v1.2.0

func (r *TaobaoOpenimTribeCreateAPIRequest) SetTribeName(_tribeName string) error

TribeName Setter 群名称

func (*TaobaoOpenimTribeCreateAPIRequest) SetTribeType added in v1.2.0

func (r *TaobaoOpenimTribeCreateAPIRequest) SetTribeType(_tribeType int64) error

TribeType Setter 群类型有两种tribe_type = 0 普通群 普通群有管理员角色,对成员加入有权限控制tribe_type = 1 讨论组 讨论组没有管理员,不能解散

func (*TaobaoOpenimTribeCreateAPIRequest) SetUser added in v1.2.0

User Setter 用户信息

type TaobaoOpenimTribeCreateAPIResponse

type TaobaoOpenimTribeCreateAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimTribeCreateAPIResponseModel
}

创建群 API返回值 taobao.openim.tribe.create

创建一个openim的群

type TaobaoOpenimTribeCreateAPIResponseModel added in v1.2.0

type TaobaoOpenimTribeCreateAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_tribe_create_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 创建群的信息
	TribeInfo *TribeInfo `json:"tribe_info,omitempty" xml:"tribe_info,omitempty"`
}

创建群 成功返回结果

type TaobaoOpenimTribeDismissAPIRequest added in v1.2.0

type TaobaoOpenimTribeDismissAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

OPENIM群解散 API请求 taobao.openim.tribe.dismiss

OPENIM群解散

func NewTaobaoOpenimTribeDismissRequest

func NewTaobaoOpenimTribeDismissRequest() *TaobaoOpenimTribeDismissAPIRequest

初始化TaobaoOpenimTribeDismissAPIRequest对象

func (TaobaoOpenimTribeDismissAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimTribeDismissAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimTribeDismissAPIRequest) GetApiParams added in v1.2.0

IRequest interface 方法, 获取API参数

func (TaobaoOpenimTribeDismissAPIRequest) GetTribeId added in v1.2.0

TribeId Getter

func (TaobaoOpenimTribeDismissAPIRequest) GetUser added in v1.2.0

User Getter

func (*TaobaoOpenimTribeDismissAPIRequest) SetTribeId added in v1.2.0

func (r *TaobaoOpenimTribeDismissAPIRequest) SetTribeId(_tribeId int64) error

TribeId Setter 群id

func (*TaobaoOpenimTribeDismissAPIRequest) SetUser added in v1.2.0

User Setter 用户信息

type TaobaoOpenimTribeDismissAPIResponse

type TaobaoOpenimTribeDismissAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimTribeDismissAPIResponseModel
}

OPENIM群解散 API返回值 taobao.openim.tribe.dismiss

OPENIM群解散

type TaobaoOpenimTribeDismissAPIResponseModel added in v1.2.0

type TaobaoOpenimTribeDismissAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_tribe_dismiss_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 群服务code
	TribeCode int64 `json:"tribe_code,omitempty" xml:"tribe_code,omitempty"`
}

OPENIM群解散 成功返回结果

type TaobaoOpenimTribeExpelAPIRequest added in v1.2.0

type TaobaoOpenimTribeExpelAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

OPENIM群踢出成员 API请求 taobao.openim.tribe.expel

OPENIM群踢出成员

func NewTaobaoOpenimTribeExpelRequest

func NewTaobaoOpenimTribeExpelRequest() *TaobaoOpenimTribeExpelAPIRequest

初始化TaobaoOpenimTribeExpelAPIRequest对象

func (TaobaoOpenimTribeExpelAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimTribeExpelAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimTribeExpelAPIRequest) GetApiParams added in v1.2.0

func (r TaobaoOpenimTribeExpelAPIRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (TaobaoOpenimTribeExpelAPIRequest) GetMember added in v1.2.0

Member Getter

func (TaobaoOpenimTribeExpelAPIRequest) GetTribeId added in v1.2.0

func (r TaobaoOpenimTribeExpelAPIRequest) GetTribeId() int64

TribeId Getter

func (TaobaoOpenimTribeExpelAPIRequest) GetUser added in v1.2.0

User Getter

func (*TaobaoOpenimTribeExpelAPIRequest) SetMember added in v1.2.0

func (r *TaobaoOpenimTribeExpelAPIRequest) SetMember(_member *OpenImUser) error

Member Setter 用户信息

func (*TaobaoOpenimTribeExpelAPIRequest) SetTribeId added in v1.2.0

func (r *TaobaoOpenimTribeExpelAPIRequest) SetTribeId(_tribeId int64) error

TribeId Setter 群id

func (*TaobaoOpenimTribeExpelAPIRequest) SetUser added in v1.2.0

User Setter 用户信息

type TaobaoOpenimTribeExpelAPIResponse

type TaobaoOpenimTribeExpelAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimTribeExpelAPIResponseModel
}

OPENIM群踢出成员 API返回值 taobao.openim.tribe.expel

OPENIM群踢出成员

type TaobaoOpenimTribeExpelAPIResponseModel added in v1.2.0

type TaobaoOpenimTribeExpelAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_tribe_expel_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 群服务code
	TribeCode int64 `json:"tribe_code,omitempty" xml:"tribe_code,omitempty"`
}

OPENIM群踢出成员 成功返回结果

type TaobaoOpenimTribeGetalltribesAPIRequest added in v1.2.0

type TaobaoOpenimTribeGetalltribesAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

获取用户群列表 API请求 taobao.openim.tribe.getalltribes

OPENIM群服务获取用户群列表

func NewTaobaoOpenimTribeGetalltribesRequest

func NewTaobaoOpenimTribeGetalltribesRequest() *TaobaoOpenimTribeGetalltribesAPIRequest

初始化TaobaoOpenimTribeGetalltribesAPIRequest对象

func (TaobaoOpenimTribeGetalltribesAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimTribeGetalltribesAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimTribeGetalltribesAPIRequest) GetApiParams added in v1.2.0

IRequest interface 方法, 获取API参数

func (TaobaoOpenimTribeGetalltribesAPIRequest) GetTribeTypes added in v1.2.0

func (r TaobaoOpenimTribeGetalltribesAPIRequest) GetTribeTypes() []int64

TribeTypes Getter

func (TaobaoOpenimTribeGetalltribesAPIRequest) GetUser added in v1.2.0

User Getter

func (*TaobaoOpenimTribeGetalltribesAPIRequest) SetTribeTypes added in v1.2.0

func (r *TaobaoOpenimTribeGetalltribesAPIRequest) SetTribeTypes(_tribeTypes []int64) error

TribeTypes Setter 群类型

func (*TaobaoOpenimTribeGetalltribesAPIRequest) SetUser added in v1.2.0

User Setter 用户信息

type TaobaoOpenimTribeGetalltribesAPIResponse

type TaobaoOpenimTribeGetalltribesAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimTribeGetalltribesAPIResponseModel
}

获取用户群列表 API返回值 taobao.openim.tribe.getalltribes

OPENIM群服务获取用户群列表

type TaobaoOpenimTribeGetalltribesAPIResponseModel added in v1.2.0

type TaobaoOpenimTribeGetalltribesAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_tribe_getalltribes_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 群列表信息
	TribeInfoList []TribeInfo `json:"tribe_info_list,omitempty" xml:"tribe_info_list>tribe_info,omitempty"`
}

获取用户群列表 成功返回结果

type TaobaoOpenimTribeGetmembersAPIRequest added in v1.2.0

type TaobaoOpenimTribeGetmembersAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

OPENIM群成员获取 API请求 taobao.openim.tribe.getmembers

OPENIM群成员获取

func NewTaobaoOpenimTribeGetmembersRequest

func NewTaobaoOpenimTribeGetmembersRequest() *TaobaoOpenimTribeGetmembersAPIRequest

初始化TaobaoOpenimTribeGetmembersAPIRequest对象

func (TaobaoOpenimTribeGetmembersAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimTribeGetmembersAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimTribeGetmembersAPIRequest) GetApiParams added in v1.2.0

IRequest interface 方法, 获取API参数

func (TaobaoOpenimTribeGetmembersAPIRequest) GetTribeId added in v1.2.0

TribeId Getter

func (TaobaoOpenimTribeGetmembersAPIRequest) GetUser added in v1.2.0

User Getter

func (*TaobaoOpenimTribeGetmembersAPIRequest) SetTribeId added in v1.2.0

func (r *TaobaoOpenimTribeGetmembersAPIRequest) SetTribeId(_tribeId int64) error

TribeId Setter 群id

func (*TaobaoOpenimTribeGetmembersAPIRequest) SetUser added in v1.2.0

User Setter 用户信息

type TaobaoOpenimTribeGetmembersAPIResponse

type TaobaoOpenimTribeGetmembersAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimTribeGetmembersAPIResponseModel
}

OPENIM群成员获取 API返回值 taobao.openim.tribe.getmembers

OPENIM群成员获取

type TaobaoOpenimTribeGetmembersAPIResponseModel added in v1.2.0

type TaobaoOpenimTribeGetmembersAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_tribe_getmembers_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// OPENIM群成员列表
	TribeUserList []TribeUser `json:"tribe_user_list,omitempty" xml:"tribe_user_list>tribe_user,omitempty"`
}

OPENIM群成员获取 成功返回结果

type TaobaoOpenimTribeGettribeinfoAPIRequest added in v1.2.0

type TaobaoOpenimTribeGettribeinfoAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

获取群信息 API请求 taobao.openim.tribe.gettribeinfo

获取群信息

func NewTaobaoOpenimTribeGettribeinfoRequest

func NewTaobaoOpenimTribeGettribeinfoRequest() *TaobaoOpenimTribeGettribeinfoAPIRequest

初始化TaobaoOpenimTribeGettribeinfoAPIRequest对象

func (TaobaoOpenimTribeGettribeinfoAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimTribeGettribeinfoAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimTribeGettribeinfoAPIRequest) GetApiParams added in v1.2.0

IRequest interface 方法, 获取API参数

func (TaobaoOpenimTribeGettribeinfoAPIRequest) GetTribeId added in v1.2.0

TribeId Getter

func (TaobaoOpenimTribeGettribeinfoAPIRequest) GetUser added in v1.2.0

User Getter

func (*TaobaoOpenimTribeGettribeinfoAPIRequest) SetTribeId added in v1.2.0

func (r *TaobaoOpenimTribeGettribeinfoAPIRequest) SetTribeId(_tribeId int64) error

TribeId Setter 群ID

func (*TaobaoOpenimTribeGettribeinfoAPIRequest) SetUser added in v1.2.0

User Setter 用户信息

type TaobaoOpenimTribeGettribeinfoAPIResponse

type TaobaoOpenimTribeGettribeinfoAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimTribeGettribeinfoAPIResponseModel
}

获取群信息 API返回值 taobao.openim.tribe.gettribeinfo

获取群信息

type TaobaoOpenimTribeGettribeinfoAPIResponseModel added in v1.2.0

type TaobaoOpenimTribeGettribeinfoAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_tribe_gettribeinfo_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 群信息
	TribeInfo *TribeInfo `json:"tribe_info,omitempty" xml:"tribe_info,omitempty"`
}

获取群信息 成功返回结果

type TaobaoOpenimTribeInviteAPIRequest added in v1.2.0

type TaobaoOpenimTribeInviteAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

OPENIM群邀请加入 API请求 taobao.openim.tribe.invite

OPENIM群邀请加入接口

func NewTaobaoOpenimTribeInviteRequest

func NewTaobaoOpenimTribeInviteRequest() *TaobaoOpenimTribeInviteAPIRequest

初始化TaobaoOpenimTribeInviteAPIRequest对象

func (TaobaoOpenimTribeInviteAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimTribeInviteAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimTribeInviteAPIRequest) GetApiParams added in v1.2.0

func (r TaobaoOpenimTribeInviteAPIRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (TaobaoOpenimTribeInviteAPIRequest) GetMembers added in v1.2.0

Members Getter

func (TaobaoOpenimTribeInviteAPIRequest) GetTribeId added in v1.2.0

TribeId Getter

func (TaobaoOpenimTribeInviteAPIRequest) GetUser added in v1.2.0

User Getter

func (*TaobaoOpenimTribeInviteAPIRequest) SetMembers added in v1.2.0

func (r *TaobaoOpenimTribeInviteAPIRequest) SetMembers(_members []OpenImUser) error

Members Setter 用户信息

func (*TaobaoOpenimTribeInviteAPIRequest) SetTribeId added in v1.2.0

func (r *TaobaoOpenimTribeInviteAPIRequest) SetTribeId(_tribeId int64) error

TribeId Setter 群id

func (*TaobaoOpenimTribeInviteAPIRequest) SetUser added in v1.2.0

User Setter 用户信息

type TaobaoOpenimTribeInviteAPIResponse

type TaobaoOpenimTribeInviteAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimTribeInviteAPIResponseModel
}

OPENIM群邀请加入 API返回值 taobao.openim.tribe.invite

OPENIM群邀请加入接口

type TaobaoOpenimTribeInviteAPIResponseModel added in v1.2.0

type TaobaoOpenimTribeInviteAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_tribe_invite_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 群服务code
	TribeCode int64 `json:"tribe_code,omitempty" xml:"tribe_code,omitempty"`
}

OPENIM群邀请加入 成功返回结果

type TaobaoOpenimTribeJoinAPIRequest added in v1.2.0

type TaobaoOpenimTribeJoinAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

OPENIM群主动加入 API请求 taobao.openim.tribe.join

OPENIM群主动加入

func NewTaobaoOpenimTribeJoinRequest

func NewTaobaoOpenimTribeJoinRequest() *TaobaoOpenimTribeJoinAPIRequest

初始化TaobaoOpenimTribeJoinAPIRequest对象

func (TaobaoOpenimTribeJoinAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimTribeJoinAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimTribeJoinAPIRequest) GetApiParams added in v1.2.0

func (r TaobaoOpenimTribeJoinAPIRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (TaobaoOpenimTribeJoinAPIRequest) GetTribeId added in v1.2.0

func (r TaobaoOpenimTribeJoinAPIRequest) GetTribeId() int64

TribeId Getter

func (TaobaoOpenimTribeJoinAPIRequest) GetUser added in v1.2.0

User Getter

func (*TaobaoOpenimTribeJoinAPIRequest) SetTribeId added in v1.2.0

func (r *TaobaoOpenimTribeJoinAPIRequest) SetTribeId(_tribeId int64) error

TribeId Setter 群id

func (*TaobaoOpenimTribeJoinAPIRequest) SetUser added in v1.2.0

User Setter 用户信息

type TaobaoOpenimTribeJoinAPIResponse

type TaobaoOpenimTribeJoinAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimTribeJoinAPIResponseModel
}

OPENIM群主动加入 API返回值 taobao.openim.tribe.join

OPENIM群主动加入

type TaobaoOpenimTribeJoinAPIResponseModel added in v1.2.0

type TaobaoOpenimTribeJoinAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_tribe_join_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 群服务code
	TribeCode int64 `json:"tribe_code,omitempty" xml:"tribe_code,omitempty"`
}

OPENIM群主动加入 成功返回结果

type TaobaoOpenimTribeModifytribeinfoAPIRequest added in v1.2.0

type TaobaoOpenimTribeModifytribeinfoAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

OPENIM群信息修改 API请求 taobao.openim.tribe.modifytribeinfo

OPENIM群信息修改

func NewTaobaoOpenimTribeModifytribeinfoRequest

func NewTaobaoOpenimTribeModifytribeinfoRequest() *TaobaoOpenimTribeModifytribeinfoAPIRequest

初始化TaobaoOpenimTribeModifytribeinfoAPIRequest对象

func (TaobaoOpenimTribeModifytribeinfoAPIRequest) GetApiMethodName added in v1.2.0

IRequest interface 方法, 获取Api method

func (TaobaoOpenimTribeModifytribeinfoAPIRequest) GetApiParams added in v1.2.0

IRequest interface 方法, 获取API参数

func (TaobaoOpenimTribeModifytribeinfoAPIRequest) GetNotice added in v1.2.0

Notice Getter

func (TaobaoOpenimTribeModifytribeinfoAPIRequest) GetTribeId added in v1.2.0

TribeId Getter

func (TaobaoOpenimTribeModifytribeinfoAPIRequest) GetTribeName added in v1.2.0

TribeName Getter

func (TaobaoOpenimTribeModifytribeinfoAPIRequest) GetUser added in v1.2.0

User Getter

func (*TaobaoOpenimTribeModifytribeinfoAPIRequest) SetNotice added in v1.2.0

Notice Setter 群公告

func (*TaobaoOpenimTribeModifytribeinfoAPIRequest) SetTribeId added in v1.2.0

func (r *TaobaoOpenimTribeModifytribeinfoAPIRequest) SetTribeId(_tribeId int64) error

TribeId Setter 群id

func (*TaobaoOpenimTribeModifytribeinfoAPIRequest) SetTribeName added in v1.2.0

func (r *TaobaoOpenimTribeModifytribeinfoAPIRequest) SetTribeName(_tribeName string) error

TribeName Setter 群名称

func (*TaobaoOpenimTribeModifytribeinfoAPIRequest) SetUser added in v1.2.0

User Setter 用户信息

type TaobaoOpenimTribeModifytribeinfoAPIResponse

type TaobaoOpenimTribeModifytribeinfoAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimTribeModifytribeinfoAPIResponseModel
}

OPENIM群信息修改 API返回值 taobao.openim.tribe.modifytribeinfo

OPENIM群信息修改

type TaobaoOpenimTribeModifytribeinfoAPIResponseModel added in v1.2.0

type TaobaoOpenimTribeModifytribeinfoAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_tribe_modifytribeinfo_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 群服务code
	TribeCode int64 `json:"tribe_code,omitempty" xml:"tribe_code,omitempty"`
}

OPENIM群信息修改 成功返回结果

type TaobaoOpenimTribeQuitAPIRequest added in v1.2.0

type TaobaoOpenimTribeQuitAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

OPENIM群成员退出 API请求 taobao.openim.tribe.quit

OPENIM群成员退出

func NewTaobaoOpenimTribeQuitRequest

func NewTaobaoOpenimTribeQuitRequest() *TaobaoOpenimTribeQuitAPIRequest

初始化TaobaoOpenimTribeQuitAPIRequest对象

func (TaobaoOpenimTribeQuitAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimTribeQuitAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimTribeQuitAPIRequest) GetApiParams added in v1.2.0

func (r TaobaoOpenimTribeQuitAPIRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (TaobaoOpenimTribeQuitAPIRequest) GetTribeId added in v1.2.0

func (r TaobaoOpenimTribeQuitAPIRequest) GetTribeId() int64

TribeId Getter

func (TaobaoOpenimTribeQuitAPIRequest) GetUser added in v1.2.0

User Getter

func (*TaobaoOpenimTribeQuitAPIRequest) SetTribeId added in v1.2.0

func (r *TaobaoOpenimTribeQuitAPIRequest) SetTribeId(_tribeId int64) error

TribeId Setter 群id

func (*TaobaoOpenimTribeQuitAPIRequest) SetUser added in v1.2.0

User Setter 用户信息

type TaobaoOpenimTribeQuitAPIResponse

type TaobaoOpenimTribeQuitAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimTribeQuitAPIResponseModel
}

OPENIM群成员退出 API返回值 taobao.openim.tribe.quit

OPENIM群成员退出

type TaobaoOpenimTribeQuitAPIResponseModel added in v1.2.0

type TaobaoOpenimTribeQuitAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_tribe_quit_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 群服务code
	TribeCode int64 `json:"tribe_code,omitempty" xml:"tribe_code,omitempty"`
}

OPENIM群成员退出 成功返回结果

type TaobaoOpenimTribeSendmsgAPIRequest added in v1.2.0

type TaobaoOpenimTribeSendmsgAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

发送群消息 API请求 taobao.openim.tribe.sendmsg

发送群消息,目前支持发送4种类型的群消息,普通文本,图片,语音,自定义消息

func NewTaobaoOpenimTribeSendmsgRequest

func NewTaobaoOpenimTribeSendmsgRequest() *TaobaoOpenimTribeSendmsgAPIRequest

初始化TaobaoOpenimTribeSendmsgAPIRequest对象

func (TaobaoOpenimTribeSendmsgAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimTribeSendmsgAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimTribeSendmsgAPIRequest) GetApiParams added in v1.2.0

IRequest interface 方法, 获取API参数

func (TaobaoOpenimTribeSendmsgAPIRequest) GetMsg added in v1.2.0

Msg Getter

func (TaobaoOpenimTribeSendmsgAPIRequest) GetTribeId added in v1.2.0

TribeId Getter

func (TaobaoOpenimTribeSendmsgAPIRequest) GetUser added in v1.2.0

User Getter

func (*TaobaoOpenimTribeSendmsgAPIRequest) SetMsg added in v1.2.0

Msg Setter 发送群消息

func (*TaobaoOpenimTribeSendmsgAPIRequest) SetTribeId added in v1.2.0

func (r *TaobaoOpenimTribeSendmsgAPIRequest) SetTribeId(_tribeId int64) error

TribeId Setter 群id

func (*TaobaoOpenimTribeSendmsgAPIRequest) SetUser added in v1.2.0

func (r *TaobaoOpenimTribeSendmsgAPIRequest) SetUser(_user *User) error

User Setter 群消息发送者,只有该群的成员才可以发送群消息

type TaobaoOpenimTribeSendmsgAPIResponse

type TaobaoOpenimTribeSendmsgAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimTribeSendmsgAPIResponseModel
}

发送群消息 API返回值 taobao.openim.tribe.sendmsg

发送群消息,目前支持发送4种类型的群消息,普通文本,图片,语音,自定义消息

type TaobaoOpenimTribeSendmsgAPIResponseModel added in v1.2.0

type TaobaoOpenimTribeSendmsgAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_tribe_sendmsg_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 错误码
	TribeCode int64 `json:"tribe_code,omitempty" xml:"tribe_code,omitempty"`
	// 错误信息
	Message string `json:"message,omitempty" xml:"message,omitempty"`
}

发送群消息 成功返回结果

type TaobaoOpenimTribeSetmanagerAPIRequest added in v1.2.0

type TaobaoOpenimTribeSetmanagerAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

OPENIM群设置管理员 API请求 taobao.openim.tribe.setmanager

OPENIM群设置管理员

func NewTaobaoOpenimTribeSetmanagerRequest

func NewTaobaoOpenimTribeSetmanagerRequest() *TaobaoOpenimTribeSetmanagerAPIRequest

初始化TaobaoOpenimTribeSetmanagerAPIRequest对象

func (TaobaoOpenimTribeSetmanagerAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimTribeSetmanagerAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimTribeSetmanagerAPIRequest) GetApiParams added in v1.2.0

IRequest interface 方法, 获取API参数

func (TaobaoOpenimTribeSetmanagerAPIRequest) GetMember added in v1.2.0

Member Getter

func (TaobaoOpenimTribeSetmanagerAPIRequest) GetTid added in v1.2.0

Tid Getter

func (TaobaoOpenimTribeSetmanagerAPIRequest) GetUser added in v1.2.0

User Getter

func (*TaobaoOpenimTribeSetmanagerAPIRequest) SetMember added in v1.2.0

Member Setter 用户信息

func (*TaobaoOpenimTribeSetmanagerAPIRequest) SetTid added in v1.2.0

Tid Setter 群id

func (*TaobaoOpenimTribeSetmanagerAPIRequest) SetUser added in v1.2.0

User Setter 用户信息

type TaobaoOpenimTribeSetmanagerAPIResponse

type TaobaoOpenimTribeSetmanagerAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimTribeSetmanagerAPIResponseModel
}

OPENIM群设置管理员 API返回值 taobao.openim.tribe.setmanager

OPENIM群设置管理员

type TaobaoOpenimTribeSetmanagerAPIResponseModel added in v1.2.0

type TaobaoOpenimTribeSetmanagerAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_tribe_setmanager_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 群服务code
	TribeCode int64 `json:"tribe_code,omitempty" xml:"tribe_code,omitempty"`
}

OPENIM群设置管理员 成功返回结果

type TaobaoOpenimTribeSetmembernickAPIRequest added in v1.2.0

type TaobaoOpenimTribeSetmembernickAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

设置群成员昵称 API请求 taobao.openim.tribe.setmembernick

设置群成员昵称,存在如下两种场景 1 群主或管理员设置群成员昵称,该操作有权限控制。只针对普通群的群主和管理员开发此功能;讨论组群主不支持此设置操作 2 群成员设置自己的昵称,该功能对群所有成员开放

func NewTaobaoOpenimTribeSetmembernickRequest

func NewTaobaoOpenimTribeSetmembernickRequest() *TaobaoOpenimTribeSetmembernickAPIRequest

初始化TaobaoOpenimTribeSetmembernickAPIRequest对象

func (TaobaoOpenimTribeSetmembernickAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimTribeSetmembernickAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimTribeSetmembernickAPIRequest) GetApiParams added in v1.2.0

IRequest interface 方法, 获取API参数

func (TaobaoOpenimTribeSetmembernickAPIRequest) GetMember added in v1.2.0

Member Getter

func (TaobaoOpenimTribeSetmembernickAPIRequest) GetNick added in v1.2.0

Nick Getter

func (TaobaoOpenimTribeSetmembernickAPIRequest) GetTribeId added in v1.2.0

TribeId Getter

func (TaobaoOpenimTribeSetmembernickAPIRequest) GetUser added in v1.2.0

User Getter

func (*TaobaoOpenimTribeSetmembernickAPIRequest) SetMember added in v1.2.0

func (r *TaobaoOpenimTribeSetmembernickAPIRequest) SetMember(_member *User) error

Member Setter 被设置昵称的群成员

func (*TaobaoOpenimTribeSetmembernickAPIRequest) SetNick added in v1.2.0

Nick Setter 设置的昵称

func (*TaobaoOpenimTribeSetmembernickAPIRequest) SetTribeId added in v1.2.0

func (r *TaobaoOpenimTribeSetmembernickAPIRequest) SetTribeId(_tribeId int64) error

TribeId Setter 群id

func (*TaobaoOpenimTribeSetmembernickAPIRequest) SetUser added in v1.2.0

User Setter 发起设置昵称的操作者,如果是设置其他成员的昵称,只有普通组的群主和管理员有权限

type TaobaoOpenimTribeSetmembernickAPIResponse

type TaobaoOpenimTribeSetmembernickAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimTribeSetmembernickAPIResponseModel
}

设置群成员昵称 API返回值 taobao.openim.tribe.setmembernick

设置群成员昵称,存在如下两种场景 1 群主或管理员设置群成员昵称,该操作有权限控制。只针对普通群的群主和管理员开发此功能;讨论组群主不支持此设置操作 2 群成员设置自己的昵称,该功能对群所有成员开放

type TaobaoOpenimTribeSetmembernickAPIResponseModel added in v1.2.0

type TaobaoOpenimTribeSetmembernickAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_tribe_setmembernick_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 是否成功
	TribeCode int64 `json:"tribe_code,omitempty" xml:"tribe_code,omitempty"`
}

设置群成员昵称 成功返回结果

type TaobaoOpenimTribeUnsetmanagerAPIRequest added in v1.2.0

type TaobaoOpenimTribeUnsetmanagerAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

OPENIM群取消管理员 API请求 taobao.openim.tribe.unsetmanager

OPENIM群取消管理员

func NewTaobaoOpenimTribeUnsetmanagerRequest

func NewTaobaoOpenimTribeUnsetmanagerRequest() *TaobaoOpenimTribeUnsetmanagerAPIRequest

初始化TaobaoOpenimTribeUnsetmanagerAPIRequest对象

func (TaobaoOpenimTribeUnsetmanagerAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimTribeUnsetmanagerAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimTribeUnsetmanagerAPIRequest) GetApiParams added in v1.2.0

IRequest interface 方法, 获取API参数

func (TaobaoOpenimTribeUnsetmanagerAPIRequest) GetMember added in v1.2.0

Member Getter

func (TaobaoOpenimTribeUnsetmanagerAPIRequest) GetTid added in v1.2.0

Tid Getter

func (TaobaoOpenimTribeUnsetmanagerAPIRequest) GetUser added in v1.2.0

User Getter

func (*TaobaoOpenimTribeUnsetmanagerAPIRequest) SetMember added in v1.2.0

Member Setter 用户信息

func (*TaobaoOpenimTribeUnsetmanagerAPIRequest) SetTid added in v1.2.0

Tid Setter 群id

func (*TaobaoOpenimTribeUnsetmanagerAPIRequest) SetUser added in v1.2.0

User Setter 用户信息

type TaobaoOpenimTribeUnsetmanagerAPIResponse

type TaobaoOpenimTribeUnsetmanagerAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimTribeUnsetmanagerAPIResponseModel
}

OPENIM群取消管理员 API返回值 taobao.openim.tribe.unsetmanager

OPENIM群取消管理员

type TaobaoOpenimTribeUnsetmanagerAPIResponseModel added in v1.2.0

type TaobaoOpenimTribeUnsetmanagerAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_tribe_unsetmanager_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 群服务code
	TribeCode int64 `json:"tribe_code,omitempty" xml:"tribe_code,omitempty"`
}

OPENIM群取消管理员 成功返回结果

type TaobaoOpenimTribelogsGetAPIRequest added in v1.2.0

type TaobaoOpenimTribelogsGetAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

openim 群聊天记录导出接口 API请求 taobao.openim.tribelogs.get

获取openim账号的群聊天记录

func NewTaobaoOpenimTribelogsGetRequest

func NewTaobaoOpenimTribelogsGetRequest() *TaobaoOpenimTribelogsGetAPIRequest

初始化TaobaoOpenimTribelogsGetAPIRequest对象

func (TaobaoOpenimTribelogsGetAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimTribelogsGetAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimTribelogsGetAPIRequest) GetApiParams added in v1.2.0

IRequest interface 方法, 获取API参数

func (TaobaoOpenimTribelogsGetAPIRequest) GetBegin added in v1.2.0

Begin Getter

func (TaobaoOpenimTribelogsGetAPIRequest) GetCount added in v1.2.0

Count Getter

func (TaobaoOpenimTribelogsGetAPIRequest) GetEnd added in v1.2.0

End Getter

func (TaobaoOpenimTribelogsGetAPIRequest) GetNext added in v1.2.0

Next Getter

func (TaobaoOpenimTribelogsGetAPIRequest) GetTribeId added in v1.2.0

TribeId Getter

func (*TaobaoOpenimTribelogsGetAPIRequest) SetBegin added in v1.2.0

func (r *TaobaoOpenimTribelogsGetAPIRequest) SetBegin(_begin int64) error

Begin Setter 查询起始时间,UTC秒数。必须在一个月内。

func (*TaobaoOpenimTribelogsGetAPIRequest) SetCount added in v1.2.0

func (r *TaobaoOpenimTribelogsGetAPIRequest) SetCount(_count int64) error

Count Setter 查询条数

func (*TaobaoOpenimTribelogsGetAPIRequest) SetEnd added in v1.2.0

End Setter 查询结束时间,UTC秒数。必须大于起始时间并小于当前时间

func (*TaobaoOpenimTribelogsGetAPIRequest) SetNext added in v1.2.0

Next Setter 迭代key

func (*TaobaoOpenimTribelogsGetAPIRequest) SetTribeId added in v1.2.0

func (r *TaobaoOpenimTribelogsGetAPIRequest) SetTribeId(_tribeId string) error

TribeId Setter 群号

type TaobaoOpenimTribelogsGetAPIResponse

type TaobaoOpenimTribelogsGetAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimTribelogsGetAPIResponseModel
}

openim 群聊天记录导出接口 API返回值 taobao.openim.tribelogs.get

获取openim账号的群聊天记录

type TaobaoOpenimTribelogsGetAPIResponseModel added in v1.2.0

type TaobaoOpenimTribelogsGetAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_tribelogs_get_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 错误码
	RetCode int64 `json:"retCode,omitempty" xml:"retCode,omitempty"`
	// 返回结构
	Data *TribeMessageResult `json:"data,omitempty" xml:"data,omitempty"`
	// 错误信息
	Message string `json:"message,omitempty" xml:"message,omitempty"`
	// 错误原因
	Reason string `json:"reason,omitempty" xml:"reason,omitempty"`
	// 是否成功
	Succ bool `json:"succ,omitempty" xml:"succ,omitempty"`
}

openim 群聊天记录导出接口 成功返回结果

type TaobaoOpenimTribelogsImportAPIRequest added in v1.2.0

type TaobaoOpenimTribelogsImportAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

openim群聊天记录导入 API请求 taobao.openim.tribelogs.import

openim群聊天记录导入

func NewTaobaoOpenimTribelogsImportRequest

func NewTaobaoOpenimTribelogsImportRequest() *TaobaoOpenimTribelogsImportAPIRequest

初始化TaobaoOpenimTribelogsImportAPIRequest对象

func (TaobaoOpenimTribelogsImportAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimTribelogsImportAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimTribelogsImportAPIRequest) GetApiParams added in v1.2.0

IRequest interface 方法, 获取API参数

func (TaobaoOpenimTribelogsImportAPIRequest) GetMessages added in v1.2.0

Messages Getter

func (TaobaoOpenimTribelogsImportAPIRequest) GetTribeId added in v1.2.0

TribeId Getter

func (*TaobaoOpenimTribelogsImportAPIRequest) SetMessages added in v1.2.0

func (r *TaobaoOpenimTribelogsImportAPIRequest) SetMessages(_messages []TribeTextMessage) error

Messages Setter 消息列表

func (*TaobaoOpenimTribelogsImportAPIRequest) SetTribeId added in v1.2.0

func (r *TaobaoOpenimTribelogsImportAPIRequest) SetTribeId(_tribeId int64) error

TribeId Setter 群号。必须为已存在的群,且群主属于本app

type TaobaoOpenimTribelogsImportAPIResponse

type TaobaoOpenimTribelogsImportAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimTribelogsImportAPIResponseModel
}

openim群聊天记录导入 API返回值 taobao.openim.tribelogs.import

openim群聊天记录导入

type TaobaoOpenimTribelogsImportAPIResponseModel added in v1.2.0

type TaobaoOpenimTribelogsImportAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_tribelogs_import_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 错误码
	Ret int64 `json:"ret,omitempty" xml:"ret,omitempty"`
	// 错误信息
	Message string `json:"message,omitempty" xml:"message,omitempty"`
	// 是否成功
	Succ bool `json:"succ,omitempty" xml:"succ,omitempty"`
}

openim群聊天记录导入 成功返回结果

type TaobaoOpenimUsersAddAPIRequest added in v1.2.0

type TaobaoOpenimUsersAddAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

添加用户 API请求 taobao.openim.users.add

导入用户

func NewTaobaoOpenimUsersAddRequest

func NewTaobaoOpenimUsersAddRequest() *TaobaoOpenimUsersAddAPIRequest

初始化TaobaoOpenimUsersAddAPIRequest对象

func (TaobaoOpenimUsersAddAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimUsersAddAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimUsersAddAPIRequest) GetApiParams added in v1.2.0

func (r TaobaoOpenimUsersAddAPIRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (TaobaoOpenimUsersAddAPIRequest) GetUserinfos added in v1.2.0

func (r TaobaoOpenimUsersAddAPIRequest) GetUserinfos() []Userinfos

Userinfos Getter

func (*TaobaoOpenimUsersAddAPIRequest) SetUserinfos added in v1.2.0

func (r *TaobaoOpenimUsersAddAPIRequest) SetUserinfos(_userinfos []Userinfos) error

Userinfos Setter 用户信息列表

type TaobaoOpenimUsersAddAPIResponse

type TaobaoOpenimUsersAddAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimUsersAddAPIResponseModel
}

添加用户 API返回值 taobao.openim.users.add

导入用户

type TaobaoOpenimUsersAddAPIResponseModel added in v1.2.0

type TaobaoOpenimUsersAddAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_users_add_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 成功用户列表
	UidSucc []string `json:"uid_succ,omitempty" xml:"uid_succ>string,omitempty"`
	// 添加失败的用户id
	UidFail []string `json:"uid_fail,omitempty" xml:"uid_fail>string,omitempty"`
	// 添加帐号失败的具体信息
	FailMsg []string `json:"fail_msg,omitempty" xml:"fail_msg>string,omitempty"`
}

添加用户 成功返回结果

type TaobaoOpenimUsersDeleteAPIRequest added in v1.2.0

type TaobaoOpenimUsersDeleteAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

删除用户 API请求 taobao.openim.users.delete

批量删除用户

func NewTaobaoOpenimUsersDeleteRequest

func NewTaobaoOpenimUsersDeleteRequest() *TaobaoOpenimUsersDeleteAPIRequest

初始化TaobaoOpenimUsersDeleteAPIRequest对象

func (TaobaoOpenimUsersDeleteAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimUsersDeleteAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimUsersDeleteAPIRequest) GetApiParams added in v1.2.0

func (r TaobaoOpenimUsersDeleteAPIRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (TaobaoOpenimUsersDeleteAPIRequest) GetUserids added in v1.2.0

func (r TaobaoOpenimUsersDeleteAPIRequest) GetUserids() []string

Userids Getter

func (*TaobaoOpenimUsersDeleteAPIRequest) SetUserids added in v1.2.0

func (r *TaobaoOpenimUsersDeleteAPIRequest) SetUserids(_userids []string) error

Userids Setter 需要删除的用户列表,多个用户用半角逗号分隔,最多一次可以删除100个用户

type TaobaoOpenimUsersDeleteAPIResponse

type TaobaoOpenimUsersDeleteAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimUsersDeleteAPIResponseModel
}

删除用户 API返回值 taobao.openim.users.delete

批量删除用户

type TaobaoOpenimUsersDeleteAPIResponseModel added in v1.2.0

type TaobaoOpenimUsersDeleteAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_users_delete_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 操作成功
	Result []string `json:"result,omitempty" xml:"result>string,omitempty"`
}

删除用户 成功返回结果

type TaobaoOpenimUsersGetAPIRequest added in v1.2.0

type TaobaoOpenimUsersGetAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

批量获取用户信息 API请求 taobao.openim.users.get

批量获取用户信息

func NewTaobaoOpenimUsersGetRequest

func NewTaobaoOpenimUsersGetRequest() *TaobaoOpenimUsersGetAPIRequest

初始化TaobaoOpenimUsersGetAPIRequest对象

func (TaobaoOpenimUsersGetAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimUsersGetAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimUsersGetAPIRequest) GetApiParams added in v1.2.0

func (r TaobaoOpenimUsersGetAPIRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (TaobaoOpenimUsersGetAPIRequest) GetUserids added in v1.2.0

func (r TaobaoOpenimUsersGetAPIRequest) GetUserids() []string

Userids Getter

func (*TaobaoOpenimUsersGetAPIRequest) SetUserids added in v1.2.0

func (r *TaobaoOpenimUsersGetAPIRequest) SetUserids(_userids []string) error

Userids Setter 用户id序列

type TaobaoOpenimUsersGetAPIResponse

type TaobaoOpenimUsersGetAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimUsersGetAPIResponseModel
}

批量获取用户信息 API返回值 taobao.openim.users.get

批量获取用户信息

type TaobaoOpenimUsersGetAPIResponseModel added in v1.2.0

type TaobaoOpenimUsersGetAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_users_get_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 获取的用户信息列表
	Userinfos []Userinfos `json:"userinfos,omitempty" xml:"userinfos>userinfos,omitempty"`
}

批量获取用户信息 成功返回结果

type TaobaoOpenimUsersUpdateAPIRequest added in v1.2.0

type TaobaoOpenimUsersUpdateAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

批量更新用户信息 API请求 taobao.openim.users.update

批量更新用户信息

func NewTaobaoOpenimUsersUpdateRequest

func NewTaobaoOpenimUsersUpdateRequest() *TaobaoOpenimUsersUpdateAPIRequest

初始化TaobaoOpenimUsersUpdateAPIRequest对象

func (TaobaoOpenimUsersUpdateAPIRequest) GetApiMethodName added in v1.2.0

func (r TaobaoOpenimUsersUpdateAPIRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (TaobaoOpenimUsersUpdateAPIRequest) GetApiParams added in v1.2.0

func (r TaobaoOpenimUsersUpdateAPIRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (TaobaoOpenimUsersUpdateAPIRequest) GetUserinfos added in v1.2.0

func (r TaobaoOpenimUsersUpdateAPIRequest) GetUserinfos() []Userinfos

Userinfos Getter

func (*TaobaoOpenimUsersUpdateAPIRequest) SetUserinfos added in v1.2.0

func (r *TaobaoOpenimUsersUpdateAPIRequest) SetUserinfos(_userinfos []Userinfos) error

Userinfos Setter 用户信息列表

type TaobaoOpenimUsersUpdateAPIResponse

type TaobaoOpenimUsersUpdateAPIResponse struct {
	model.CommonResponse
	TaobaoOpenimUsersUpdateAPIResponseModel
}

批量更新用户信息 API返回值 taobao.openim.users.update

批量更新用户信息

type TaobaoOpenimUsersUpdateAPIResponseModel added in v1.2.0

type TaobaoOpenimUsersUpdateAPIResponseModel struct {
	XMLName xml.Name `xml:"openim_users_update_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 对应每一个失败用户的具体错误信息
	FailMsg []string `json:"fail_msg,omitempty" xml:"fail_msg>string,omitempty"`
	// 失败的uid列表
	UidFail []string `json:"uid_fail,omitempty" xml:"uid_fail>string,omitempty"`
	// 成功的uid列表
	UidSucc []string `json:"uid_succ,omitempty" xml:"uid_succ>string,omitempty"`
}

批量更新用户信息 成功返回结果

type TextMessage

type TextMessage struct {
	// 发送方userid
	FromId string `json:"from_id,omitempty" xml:"from_id,omitempty"`
	// 消息
	Message string `json:"message,omitempty" xml:"message,omitempty"`
	// 消息时间。UTC时间,精确到秒。必须在一个月内
	Time int64 `json:"time,omitempty" xml:"time,omitempty"`
	// 接受方userid
	ToId string `json:"to_id,omitempty" xml:"to_id,omitempty"`
}

TextMessage

type TribeInfo

type TribeInfo struct {
	// 群ID
	TribeId int64 `json:"tribe_id,omitempty" xml:"tribe_id,omitempty"`
	// 群头像URL地址
	Icon string `json:"icon,omitempty" xml:"icon,omitempty"`
	// 群验证模式
	CheckMode int64 `json:"check_mode,omitempty" xml:"check_mode,omitempty"`
	// 群类型
	TribeType int64 `json:"tribe_type,omitempty" xml:"tribe_type,omitempty"`
	// 群名称
	Name string `json:"name,omitempty" xml:"name,omitempty"`
	// 群接收标记
	RecvFlag int64 `json:"recv_flag,omitempty" xml:"recv_flag,omitempty"`
	// 群公告
	Notice string `json:"notice,omitempty" xml:"notice,omitempty"`
}

TribeInfo

type TribeMessage

type TribeMessage struct {
	// 消息内容节点序列
	Content []MessageItem `json:"content,omitempty" xml:"content>message_item,omitempty"`
	// 发送方
	FromId *User `json:"from_id,omitempty" xml:"from_id,omitempty"`
	// 消息时间。UTC时间
	Time int64 `json:"time,omitempty" xml:"time,omitempty"`
	// 消息类型
	Type int64 `json:"type,omitempty" xml:"type,omitempty"`
	// 消息UUID
	Uuid int64 `json:"uuid,omitempty" xml:"uuid,omitempty"`
}

TribeMessage

type TribeMessageResult

type TribeMessageResult struct {
	// 消息列表
	Messages []TribeMessage `json:"messages,omitempty" xml:"messages>tribe_message,omitempty"`
	// 迭代key
	NextKey string `json:"next_key,omitempty" xml:"next_key,omitempty"`
}

TribeMessageResult

type TribeMsg

type TribeMsg struct {
	// 是否是at消息, 0表示不是at消息,1表示at指定的用户,2表示at群里所有人
	AtFlag int64 `json:"at_flag,omitempty" xml:"at_flag,omitempty"`
	// 当at_flag=1时,必须指定at的用户
	Atmembers []User `json:"atmembers,omitempty" xml:"atmembers>user,omitempty"`
	// 自定义push提醒参数,格式为json字符串,该参数为空时,采用系统默认的push;设置该参数时,json字符串必选包含至少包含指定的三个key,"d", "sound", "title"
	CustomPush string `json:"custom_push,omitempty" xml:"custom_push,omitempty"`
	// 格式为json字符串, 当消息类型为图片或语音时该参数为必选项,用于描述图片,语音的属性; 该参数json格式必须符合msg_type的要求;当消息类型为图片时,格式必须符合如下样例 : {“height”:10, "width":10, "type":"jpg"},当前支持3三种图片类型,gif, jpg,jpeg; 当消息类型为语音时,必须符合如下样例:{“playtime”:10,”type”:”amr”},语音的type只支持arm
	MediaAttrs string `json:"media_attrs,omitempty" xml:"media_attrs,omitempty"`
	// 文本消息最大长度是4K,图片最大为500K。消息内容格式根据type确定。当type为文本时,内容为文本字符串;当类型为图片或语音时,内容为图片和语音的二进制base64编码生成的字符串;当类型为自定义消息时,内容必须为就送字符串格式,该字符串必须包含header字符,即{"header":{"summary":},...}
	MsgContent string `json:"msg_content,omitempty" xml:"msg_content,omitempty"`
	// 消息类型,目前支持四中类型的消息; msg_type=0 表示普通文本消息; msg_type=2 表示语音消息; msg_type = 16表示图片消息; msg_type=17表示用户自定义消息
	MsgType int64 `json:"msg_type,omitempty" xml:"msg_type,omitempty"`
	// 该消息是否需要push
	Push bool `json:"push,omitempty" xml:"push,omitempty"`
}

TribeMsg

type TribeTextMessage

type TribeTextMessage struct {
	// 发送方userid。必须为本app已导入的账号
	FromId string `json:"from_id,omitempty" xml:"from_id,omitempty"`
	// 消息
	Message string `json:"message,omitempty" xml:"message,omitempty"`
	// 消息时间。UTC时间,精确到秒。时间范围必须在当前时间30天内
	Time int64 `json:"time,omitempty" xml:"time,omitempty"`
}

TribeTextMessage

type TribeUser

type TribeUser struct {
	// 用户id
	Uid string `json:"uid,omitempty" xml:"uid,omitempty"`
	// 群成员角色
	Role string `json:"role,omitempty" xml:"role,omitempty"`
	// 是否为淘宝账号
	TaobaoAccount bool `json:"taobao_account,omitempty" xml:"taobao_account,omitempty"`
	// 账户appkey
	AppKey string `json:"app_key,omitempty" xml:"app_key,omitempty"`
}

TribeUser

type User

type User struct {
	// 用户所属appkey
	Appkey string `json:"appkey,omitempty" xml:"appkey,omitempty"`
	// 是否是淘宝账号
	TaobaoAccount bool `json:"taobao_account,omitempty" xml:"taobao_account,omitempty"`
	// 用户id
	Uid string `json:"uid,omitempty" xml:"uid,omitempty"`
	// 账户appkey
	AppKey string `json:"app_key,omitempty" xml:"app_key,omitempty"`
}

User

type Userinfos

type Userinfos struct {
	// 昵称,最大长度64字节
	Nick string `json:"nick,omitempty" xml:"nick,omitempty"`
	// 头像url,最大长度512字节
	IconUrl string `json:"icon_url,omitempty" xml:"icon_url,omitempty"`
	// email地址,最大长度128字节
	Email string `json:"email,omitempty" xml:"email,omitempty"`
	// 手机号码,最大长度16字节
	Mobile string `json:"mobile,omitempty" xml:"mobile,omitempty"`
	// 淘宝账号,最大长度64字节
	Taobaoid string `json:"taobaoid,omitempty" xml:"taobaoid,omitempty"`
	// im用户名,最大长度64字节
	Userid string `json:"userid,omitempty" xml:"userid,omitempty"`
	// im密码,最大长度64字节
	Password string `json:"password,omitempty" xml:"password,omitempty"`
	// remark,最大长度128字节
	Remark string `json:"remark,omitempty" xml:"remark,omitempty"`
	// 扩展字段(Json),最大长度4096字节
	Extra string `json:"extra,omitempty" xml:"extra,omitempty"`
	// 职位,最大长度128字节
	Career string `json:"career,omitempty" xml:"career,omitempty"`
	// vip(Json),最大长度512字节
	Vip string `json:"vip,omitempty" xml:"vip,omitempty"`
	// 地址,最大长度512
	Address string `json:"address,omitempty" xml:"address,omitempty"`
	// 名字,最大长度64
	Name string `json:"name,omitempty" xml:"name,omitempty"`
	// 年龄
	Age int64 `json:"age,omitempty" xml:"age,omitempty"`
	// 性别。M: 男。 F:女
	Gender string `json:"gender,omitempty" xml:"gender,omitempty"`
	// 微信,最大长度64字节
	Wechat string `json:"wechat,omitempty" xml:"wechat,omitempty"`
	// qq,最大长度20字节
	Qq string `json:"qq,omitempty" xml:"qq,omitempty"`
	// 微博,最大长度256字节
	Weibo string `json:"weibo,omitempty" xml:"weibo,omitempty"`
	// 用户激活状态,0表示未激活,1表示激活
	Status int64 `json:"status,omitempty" xml:"status,omitempty"`
	// 最后更新时间
	GmtModified string `json:"gmt_modified,omitempty" xml:"gmt_modified,omitempty"`
}

Userinfos

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL