自定义消息元素 Data String 自定义消息数据。 不作为 APNs 的 payload 字段下发，故从 payload 中无法获取 Data 字段。 Desc String 自定义消息描述信息。当接收方为 iOS 或 Android 后台在线时，做离线推送文本展示。 若发送自定义消息的同时设置了 OfflinePushInfo.Desc 字段，此字段会被覆盖，请优先填 OfflinePushInfo.Desc 字段。 当消息中只有一个 TIMCustomElem 自定义消息元素时，如果 Desc 字段和 OfflinePushInfo.Desc 字段都不填写，将收不到该条消息的离线推送，需要填写 OfflinePushInfo.Desc 字段才能收到该消息的离线推送。 Ext String 扩展字段。当接收方为 iOS 系统且应用处在后台时，此字段作为 APNs 请求包 Payloads 中的 Ext 键值下发，Ext 的协议格式由业务方确定，APNs 只做透传。 Sound String 自定义 APNs 推送铃音。.

自定义消息元素 Index Number 表情索引，用户自定义。 Data String 额外数据。.

地理位置消息元素 Desc String 地理位置描述信息。 Latitude Number 纬度。 Longitude Number 经度。.

文本消息元素 Text String 消息内容。当接收方为 iOS 或 Android 后台在线时，作为离线推送的文本展示。.

查询帐号 v4/im_open_login_svc/account_check.

删除帐号 v4/im_open_login_svc/account_delete.

导入单个帐号.

活跃用户数.

增加群组成员 v4/group_open_http_svc/add_group_member.

查询单聊消息 v4/openim/admin_getroammsg.

撤回单聊消息.

APNs 推送数.

应用 SDKAppID.

应用名称.

批量发单聊消息 v4/openim/batchsendmsg.

添加黑名单 v4/sns/black_list_add.

校验黑名单 v4/sns/black_list_check.

删除黑名单 v4/sns/black_list_delete.

拉取黑名单 v4/sns/black_list_get.

From_Account 的黑名单中有 To_Account，但无法确定 To_Account 的黑名单中是否有 From_AccountFrom_Account 的黑名单中有 To_Account，但 To_Account 的黑名单中没有 From_Account.

From_Account 的黑名单中有 To_Account，To_Account 的黑名单中也有 From_Account.

From_Account 的黑名单中没有 To_Account，但 To_Account 的黑名单中有 From_Account.

From_Account 的黑名单中没有 To_Account，但无法确定 To_Account 的黑名单中是否有 From_AccountFrom_Account 的黑名单中没有 To_Account，To_Account 的黑名单中也没有 From_Account.

既会检查 From_Account 的黑名单中是否有 To_Account，也会检查 To_Account 的黑名单中是否有 From_Account.

只会检查 From_Account 的黑名单中是否有 To_Account，不会检查 To_Account 的黑名单中是否有 From_Account.

APNs 推送数（C2C）.

发消息人数（C2C）.

上行消息数（C2C).

回调请求数.

回调应答数.

关系链对数删除量.

关系链对数增加量.

转让群组 v4/group_open_http_svc/change_group_owner.

双向校验好友关系 既会检查 From_Account 的好友表中是否有 To_Account，也会检查 To_Account 的好友表中是否有 From_Account.

单向校验好友关系 只会检查 From_Account 的好友表中是否有 To_Account，不会检查 To_Account 的好友表中是否有 From_Account.

所属客户名称.

创建群组 v4/group_open_http_svc/create_group.

日期.

删除群组成员 v4/group_open_http_svc/delete_group_member.

删除指定用户发送的消息 v4/group_open_http_svc/delete_group_msg_by_sender.

双向删除好友 将 To_Account 从 From_Account 的好友表中删除，同时将 From_Account 从 To_Account 的好友表中删除.

单向删除好友 只将 To_Account 从 From_Account 的好友表中删除，但不会将 From_Account 从 To_Account 的好友表中删除.

解散群组 v4/group_open_http_svc/destroy_group.

批量禁言和取消禁言 v4/group_open_http_svc/forbid_send_msg.

添加好友 v4/sns/friend_add.

校验好友 v4/sns/friend_check.

删除好友 v4/sns/friend_delete.

删除所有好友 v4/sns/friend_delete_all.

拉取好友 v4/sns/friend_get.

拉取指定好友 v4/sns/friend_get_list.

导入好友 v4/sns/friend_import.

更新好友.

From_Account 单向模式下:的好友表中有 To_Account，但无法确定 To_Account 的好友表中是否有 From_AccountFrom_Account 双向模式下:的好友表中有 To_Account，但 To_Account 的好友表中没有 From_Account.

From_Account 的好友表中有 To_Account，To_Account 的好友表中也有 From_Account.

From_Account 的好友表中没有 To_Account，但 To_Account 的好友表中有 From_Account.

单向模式下:From_Account 的好友表中没有 To_Account，但无法确定 To_Account 的好友表中是否有 From_Account双向模式下:From_Account 的好友表中没有 To_Account，To_Account 的好友表中也没有 From_Account.

获取 App 中的所有群组 v4/group_open_http_svc/get_appid_group_list.

获取群组详细资料 v4/group_open_http_svc/get_group_info.

获取群成员详细资料 v4/group_open_http_svc/get_group_member_info.

获取群组被禁言用户列表 v4/group_open_http_svc/get_group_shutted_uin.

下载消息记录 v4/open_msg_svc/get_history.

获取用户所加入的群组 v4/group_open_http_svc/get_joined_group_list.

查询用户在群组中的身份 v4/group_open_http_svc/get_role_in_group.

拉取运营数据 v4/openconfigsvr/getappinfo.

查询全局禁言 v4/openconfigsvr/getnospeaking.

添加分组 v4/sns/group_add.

删除分组 v4/sns/group_delete.

拉取群漫游消息 v4/group_open_http_svc/group_msg_get_simple.

群组消息撤回 v4/group_open_http_svc/group_msg_recall.

累计群组数.

APNs 推送数（群）.

解散群个数.

入群总数.

新增群组数.

退群总数.

发消息群组数.

发消息人数（群）.

上行消息数（群）.

导入群基础资料 v4/group_open_http_svc/import_group.

导入群成员 v4/group_open_http_svc/import_group_member.

导入群消息 v4/group_open_http_svc/import_group_msg.

导入单聊消息 v4/openim/importmsg.

失效帐号登录态 v4/im_open_login_svc/kick.

登录次数.

登录人数.

最高在线人数.

修改群组基础资料 v4/group_open_http_svc/modify_group_base_info.

修改群组成员资料 v4/group_open_http_svc/modify_group_member_info.

导入多个帐号.

拉取资料 v4/profile/portrait_get.

设置资料 v4/profile/portrait_set.

管理员禁止加好友标识 AdminForbid_Type_None：默认值，允许加好友AdminForbid_Type_SendOut：禁止该用户发起加好友请求.

加好友验证方式 有 AllowType_Type_NeedConfirm：需要经过自己确认才能添加自己为好友AllowType_Type_AllowAny：允许任何人添加自己为好友AllowType_Type_DenyAny：不允许任何人添加自己为好友.

生日.

Gender_Type_Unknown：没设置性别 Gender_Type_Female：女性 Gender_Type_Male：男性.

Tag_Profile_IM_Image string 头像URL 有 长度不得超过500个字节.

语言.

等级 uint32 等级 有 通常一个 UINT-8 数据即可保存一个等级信息您可以考虑拆分保存，从而实现多种角色的等级信息.

所在地长度不得超过16个字节，推荐用法如下：App 本地定义一套数字到地名的映射关系后台实际保存的是4个 uint32_t 类型的数字其中第一个 uint32_t 表示国家第二个 uint32_t 用于表示省份第三个 uint32_t 用于表示城市第四个 uint32_t 用于表示区县.

消息设置 有 标志位：Bit0：置0表示接收消息，置1则不接收消息.

昵称 长度不得超过500个字节.

角色 通常一个 UINT-8 数据即可保存一个角色信息您可以考虑拆分保存，从而保存多种角色信息.

个性签名 长度不得超过500个字节.

查询帐号在线状态 v4/openim/querystate.

新增注册人数.

累计注册人数.

在群组中发送普通消息 v4/group_open_http_svc/send_group_msg.

在群组中发送系统通知 v4/group_open_http_svc/send_group_system_notification.

单发单聊消息 v4/openim/sendmsg.

发消息人数.

设置成员未读消息计数 v4/group_open_http_svc/set_unread_msg_num.

设置全局禁言 v4/openconfigsvr/setnospeaking.

管理员禁止加好友标识AdminForbid_Type_None：默认值，允许加好友 AdminForbid_Type_SendOut：禁止该用户发起加好友请求.

加好友验证方式AllowType_Type_NeedConfirm：需要经过自己确认才能添加自己为好友AllowType_Type_AllowAny：允许任何人添加自己为好友AllowType_Type_DenyAny：不允许任何人添加自己为好友.

生日推荐用法：20190419.

性别Gender_Type_Unknown：没设置性别Gender_Type_Female：女性Gender_Type_Male：男性.

头像URL长度不得超过500个字节.

语言.

等级通常一个 UINT-8 数据即可保存一个等级信息 您可以考虑拆分保存，从而实现多种角色的等级信息.

所在地长度不得超过16个字节，推荐用法如下：App 本地定义一套数字到地名的映射关系后台实际保存的是4个 uint32_t 类型的数字其中第一个 uint32_t 表示国家第二个 uint32_t 用于表示省份第三个 uint32_t 用于表示城市第四个 uint32_t 用于表示区县.

消息设置标志位： Bit0：置0表示接收消息，置1则不接收消息.

昵称长度不得超过500个字节.

角色通常一个 UINT-8 数据即可保存一个角色信息 您可以考虑拆分保存，从而保存多种角色信息.

个性签名长度不得超过500个字节.

加好友来源：1.

加好友附言：1.

好友分组：1.

好友备注：1.

TIMCustomElem 自定义消息，当接收方为 iOS 系统且应用处在后台时，此消息类型可携带除文本以外的字段到 APNs。一条组合消息中只能包含一个 TIMCustomElem 自定义消息元素.

TIMFaceElem 表情消息。.

TIMLocationElem 地理位置消息。.

TIMTextElem 文本消息。.

上行消息数.

From_Account String 必填 需要拉取该 UserID 的黑名单StartIndex Integer 必填 拉取的起始位置MaxLimited Integer 必填 每页最多拉取的黑名单数LastSequence Integer 必填 上一次拉黑名单时后台返回给客户端的 Seq，初次拉取时为0.

BlackListItem Array 黑名单对象数组，每一个黑名单对象都包括了 To_Account 和 AddBlackTimeStampTo_Account String 黑名单的 UserIDAddBlackTimeStamp Integer 添加黑名单的时间StartIndex Integer 下页拉取的起始位置，0表示已拉完CurruentSequence Integer 黑名单最新的 Seq.

CallbackCommand String 回调命令From_Account String 消息发送者 UserIDTo_Account String 消息接收者 UserIDMsgSeq Integer 消息序列号，用于标记该条消息（32位无符号整数）MsgRandom Integer 消息随机数，用于标记该条消息（32位无符号整数）MsgTime Integer 消息的发送时间戳，单位为秒单聊消息优先使用 MsgTime 进行排序，同一秒发送的消息则按 MsgSeq 排序，MsgSeq 值越大消息越靠后MsgKey String 该条消息的唯一标识，可根据该标识进行 REST API 撤回单聊消息MsgBody Array 消息体，详情请参见 消息格式描述.

CallbackCommand String 回调命令PairList Array 成功添加的好友对From_Account String From_Account 的好友表中增加了 To_AccountTo_Account String To_Account 被增加到了 From_Account 的好友表中Initiator_Account String 发起加好友请求的用户的 UserIDClientCmd String 触发回调的命令字：加好友请求，合理的取值如下：friend_add、FriendAdd加好友回应，合理的取值如下：friend_response、FriendResponseAdmin_Account String 如果当前请求是后台触发的加好友请求，则该字段被赋值为管理员帐号；否则为空ForceFlag Integer 管理员强制加好友标记：1 表示强制加好友；0 表示常规加好友方式.

CallbackCommand String 回调命令GroupId String 操作的群 IDOperator_Account String 发起创建群组请求的操作者 UserIDOwner_Account String 请求创建的群的群主 UserIDType String 请求创建的 群组形态介绍，例如 Private，Public 和 ChatRoomName String 请求创建的群组的名称MemberList Array 请求创建的群组的初始化成员列表UserDefinedDataList Array 用户建群时的自定义字段，这个字段默认是没有的，需要开通，详见 自定义字段.

SyncOtherMachine Integer选填 1：把消息同步到 From_Account 在线终端和漫游上； 2：消息不同步至 From_Account；若不填写默认情况下会将消息存 From_Account 漫游MsgLifeTime Integer 选填 消息离线保存时长（单位：秒），最长为7天（604800秒）若设置该字段为0，则消息只发在线用户，不保存离线若设置该字段超过7天（604800秒），仍只保存7天若不设置该字段，则默认保存7天MsgRandom Integer 必填 消息随机数，由随机函数产生，用于后台定位问题MsgTimeStamp Integer 选填 消息时间戳，UNIX 时间戳（单位：秒）MsgType String 必填 TIM 消息对象类型，目前支持的消息对象包括：TIMTextElem(文本消息)，TIMFaceElem(表情消息)，TIMLocationElem(位置消息)，TIMCustomElem(自定义消息)MsgContent Object 必填 对于每种 MsgType 用不同的 MsgContent 格式，具体可参考 消息格式描述OfflinePushInfo Object 选填 离线推送信息配置，具体可参考 消息格式描述.

To_Account String 请求校验的用户的 UserIDRelation String 校验成功时 To_Account 与 From_Account 之间的黑名单关系，详情可参见 校验黑名单ResultCode Integer To_Account 的处理结果，0表示成功，非0表示失败，非0取值的详细描述请参见 错误码说明ResultInfo String To_Account 的错误描述信息，成功时该字段为空.

To_Account String 请求添加的好友的 UserIDResultCode Integer To_Account 的处理结果，0表示成功，非0表示失败，非0取值的详细描述请参见 错误码说明ResultInfo String To_Account 的错误描述信息，成功时该字段为空.

From_Account String 必填 指定要拉取好友数据的用户的 UserIDStartIndex Integer 必填 分页的起始位置StandardSequence Integer 选填 上次拉好友数据时返回的 StandardSequence，如果 StandardSequence 字段的值与后台一致，后台不会返回标配好友数据CustomSequence Integer 选填 上次拉好友数据时返回的 CustomSequence，如果 CustomSequence 字段的值与后台一致，后台不会返回自定义好友数据.

Owner_Account String 选填 群主 ID，自动添加到群成员中。如果不填，群没有群主Type String 必填 群组形态，包括 Public（公开群），Private（私密群），ChatRoom（聊天室），AVChatRoom（音视频聊天室），BChatRoom（在线成员广播大群）GroupId String 选填 为了使得群组 ID 更加简单，便于记忆传播，腾讯云支持 App 在通过 REST API 创建群组时 自定义群组 IDName String 必填 群名称，最长30字节，使用 UTF-8 编码，1个汉字占3个字节Introduction String 选填 群简介，最长240字节，使用 UTF-8 编码，1个汉字占3个字节Notification String 选填 群公告，最长300字节，使用 UTF-8 编码，1个汉字占3个字节FaceUrl String 选填 群头像 URL，最长100字节MaxMemberCount Integer 选填 最大群成员数量，缺省时的默认值：私有群是200，公开群是2000，聊天室是6000，音视频聊天室和在线成员广播大群无限制ApplyJoinOption String 选填 申请加群处理方式。包含 FreeAccess（自由加入），NeedPermission（需要验证），DisableApply（禁止加群），不填默认为 NeedPermission（需要验证）仅当创建支持申请加群的 群组 时，该字段有效AppDefinedData Array 选填 群组维度的自定义字段，默认情况是没有的，需要开通，详情请参阅 自定义字段MemberList Array 选填 初始群成员列表，最多500个；成员信息字段详情请参阅 群成员资料AppMemberDefinedData Array 选填 群成员维度的自定义字段，默认情况是没有的，需要开通，详情请参阅 自定义字段.

GroupId String 必填 向哪个群组发送消息 Random Integer 必填 32位随机数。如果5分钟内两条消息的随机值相同，后一条消息将被当做重复消息而丢弃 MsgPriority String 选填 消息的优先级 MsgBody Array 必填 消息体，详细可参阅 消息格式描述 From_Account String 选填 消息来源帐号，选填。如果不填写该字段，则默认消息的发送者为调用该接口时使用的 App 管理员帐号。除此之外，App 亦可通过该字段“伪造”消息的发送者，从而实现一些特殊的功能需求。需要注意的是，如果指定该字段，必须要确保字段中的帐号是存在的 ForbidCallbackControl Array 选填 消息回调禁止开关，只对单条消息有效，ForbidBeforeSendMsgCallback 表示禁止发消息前回调，ForbidAfterSendMsgCallback 表示禁止发消息后回调 OnlineOnlyFlag Integer 选填 1表示消息仅发送在线成员，默认0表示发送所有成员，音视频聊天室（AVChatRoom）和在线成员广播大群（BChatRoom）不支持该参数.

From_Account String 必填 需要为该 UserID 添加好友 AddFriendItem Array 必填 好友结构体对象.

To_Account String 必填 好友的 UserIDRemark String 选填 From_Account 对 To_Account 的好友备注，详情可参见 标配好友字段RemarkTime Integer 选填 From_Account 对 To_Account 的好友备注时间GroupName Array 选填 From_Account 对 To_Account 的分组信息，详情可参见 标配好友字段AddSource String 必填 加好友来源字段，详情可参见 标配好友字段AddWording String 选填 From_Account 和 To_Account 形成好友关系时的附言信息，详情可参见 标配好友字段AddTime Integer 选填 From_Account 和 To_Account 形成好友关系的时间CustomItem Array 选填 From_Account 对 To_Account 的自定义好友数据，每一个成员都包含一个 Tag 字段和一个 Value 字段，详情可参见 自定义好友字段Tag String 选填 自定义好友字段的名称，使用前请通过即时通信 IM 控制台 >【应用配置】>【功能配置】申请自定义好友字段Value String/Integer 选填 自定义好友字段的值.

To_Account String 好友的 UserIDSnsProfileItem Array 保存好友数据的数组，数组每一个元素都包含一个 Tag 字段和一个 Value 字段Tag String 字段的名称.

Member_Account String 必填 需要查询的用户帐号WithHugeGroups Integer 选填 是否获取用户加入的音视频聊天室和在线成员广播大群，0表示不获取，1表示获取。默认为0WithNoActiveGroups Integer 选填 是否获取用户加入的未激活私有群信息，0表示不获取，1表示获取。默认为0Limit Integer 选填 单次拉取的群组数量，如果不填代表所有群组，分页方式与 获取 App 中的所有群组 相同Offset Integer 选填 从第多少个群组开始拉取，分页方式与 获取 App 中的所有群组 相同GroupType String 选填 拉取哪种群组形态，例如 Private，Public，ChatRoom 或 AVChatRoom，不填为拉取所有.

GroupId String 必填 操作的群 ID Member_Account String 必填 要操作的群成员 Role String 选填 成员身份，Admin/Member 分别为设置/取消管理员 MsgFlag String 选填 消息屏蔽类型 NameCard String 选填 群名片（最大不超过50个字节） AppMemberDefinedData Array 选填 群成员维度的自定义字段，默认情况是没有的，需要开通，详情请参阅 群组系统 ShutUpTime Integer 选填 需禁言时间，单位为秒，0表示取消禁言.

URL String 消息记录文件下载地址ExpireTime String 下载地址过期时间，请在过期前进行下载，若地址失效，请通过该接口重新获取FileSize Integer GZip 压缩前的文件大小（单位 Byte）FileMD5 String GZip 压缩前的文件 MD5GzipSize Integer GZip 压缩后的文件大小（单位 Byte）GzipMD5 String GZip 压缩后的文件 MD5.

https://cloud.tencent.com/document/product/269/2720#.E7.A6.BB.E7.BA.BF.E6.8E.A8.E9.80.81-offlinepushinfo-.E8.AF.B4.E6.98.8EPushFlag Integer 选填 0表示推送，1表示不离线推送。Title String 选填 离线推送标题。该字段为 iOS 和 Android 共用。Desc String 选填 离线推送内容。该字段会覆盖上面各种消息元素 TIMMsgElement 的离线推送展示文本。若发送的消息只有一个 TIMCustomElem 自定义消息元素，该 Desc 字段会覆盖 TIMCustomElem 中的 Desc 字段。如果两个 Desc 字段都不填，将收不到该自定义消息的离线推送。Ext String 选填 离线推送透传内容。AndroidInfo.Sound String 选填 Android 离线推送声音文件路径。AndroidInfo.OPPOChannelID String 选填 OPPO 手机 Android 8.0 以上的 NotificationChannel 通知适配字段。ApnsInfo.BadgeMode Integer 选填 这个字段缺省或者为0表示需要计数，为1表示本条消息不需要计数，即右上角图标数字不增加。ApnsInfo.Title String 选填 该字段用于标识 APNs 推送的标题，若填写则会覆盖最上层 Title。ApnsInfo.SubTitle String 选填 该字段用于标识 APNs 推送的子标题。ApnsInfo.Image String 选填 该字段用于标识 APNs 携带的图片地址，当客户端拿到该字段时，可以通过下载图片资源的方式将图片展示在弹窗上。.

https://cloud.tencent.com/document/product/269/1500#.E6.A0.87.E9.85.8D.E8.B5.84.E6.96.99.E5.AD.97.E6.AE.B5To_Account Array 必填 需要拉取这些 UserID 的资料； 注意：每次拉取的用户数不得超过100，避免因回包数据量太大以致回包失败TagList Array 必填 指定要拉取的资料字段的 Tag，支持的字段有：1.

ResponseFilter Object 选填 分别包含 GroupBaseInfoFilter 和 SelfInfoFilter两个过滤器； GroupBaseInfoFilter 表示需要拉取哪些基础信息字段，详情请参阅 群组系统；SelfInfoFilter 表示需要拉取用户在每个群组中的哪些个人资料，详情请参阅 群组系统 https://cloud.tencent.com/document/product/269/1502.

ActionStatus String 请求的处理结果，OK 表示处理成功，FAIL 表示失败ErrorCode Integer 错误码，0表示成功，非0表示失败ErrorInfo String 请求处理失败时的错误信息ResultItem Array 单个帐号的结果对象数组ResultCode Integer 单个帐号的错误码，0表示成功，非0表示失败ResultInfo String 单个帐号删除失败时的错误描述信息UserID String 请求删除的帐号的 UserID.

GroupId String 请求中的群组 IDIsFinished Integer 是否返回了请求区间的全部消息当消息长度太长或者区间太大（超过20）导致无法返回全部消息时，值为0当消息长度太长或者区间太大（超过20）且所有消息都过期时，值为2RspMsgList Array 返回的消息列表.

From_Account String 消息的发送者IsPlaceMsg Integer 是否是空洞消息，当消息被删除或者消息过期后，MsgBody 为空，这个字段为1MsgRandom Integer 消息随机值，用来对消息去重，有客户端发消息时填写，如果没有填，服务端会自动生成一个MsgSeq Integer 消息 seq，用来标识唯一消息，值越小发送的越早MsgTimeStamp Integer 消息被发送的时间戳，server 的时间MsgBody Array 消息内容，详情请参见 消息内容 MsgBody 说明.

From_Account String 选填 消息发送方 UserID（用于指定发送消息方帐号）To_Account String 必填 消息接收方 UserID.

如果仅需要返回特定群组形态的群组，可以通过 GroupType 进行过滤，但此时返回的 TotalCount 的含义就变成了 App 中属于该群组形态的群组总数。不填为获取所有类型的群组。群组形态包括 Public（公开群），Private（私密群），ChatRoom（聊天室），AVChatRoom（音视频聊天室）和 BChatRoom（在线成员广播大群）.