xudongyss/tencentcloud-im-sdk-php

1.0.15 2023-03-15 08:03 UTC

This package is auto-updated.

Last update: 2024-04-15 10:12:44 UTC


README

TIM REST API

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = new Configuration();
//TODO: 此处替换成您的SDKAppID,应用 SDKAppID,可在即时通信 IM 控制台(https://console.cloud.tencent.com/im) 的应用卡片中获取。
$config->setSdkappid(123456789);
//TODO: 此处替换成您的identifier;用户名,调用 REST API时必须为App管理员帐号 参考:https://cloud.tencent.com/document/product/269/31999#app-.E7.AE.A1.E7.90.86.E5.91.98
$config->setIdentifier("identifier");
//TODO: 此处替换成您的key, 参考:https://cloud.tencent.com/document/product/269/32688#getkey
$config->setKey("key");

$apiInstance = new TencentCloud\IM\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(), $config
);
$random = 56; // int | 
$accountCheckRequest = new \TencentCloud\IM\Model\AccountCheckRequest(); // \TencentCloud\IM\Model\AccountCheckRequest | 
 //TODO: Set the request parameters

try {
    $result = $apiInstance->accountCheck($random, $accountCheckRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountCheck: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://console.tim.qq.com

Class Method HTTP request Description
AccountApi accountCheck POST /v4/im_open_login_svc/account_check 查询帐号 (https://cloud.tencent.com/document/product/269/38417)
AccountApi accountDelete POST /v4/im_open_login_svc/account_delete 删除帐号(https://cloud.tencent.com/document/product/269/36443)
AccountApi accountImport POST /v4/im_open_login_svc/account_import 导入单个帐号(https://cloud.tencent.com/document/product/269/1608)
AccountApi kick POST /v4/im_open_login_svc/kick 失效帐号登录状态(https://cloud.tencent.com/document/product/269/3853)
AccountApi multiAccountImport POST /v4/im_open_login_svc/multiaccount_import 导入多个帐号(https://cloud.tencent.com/document/product/269/4919)
AccountApi queryOnlineStatus POST /v4/openim/query_online_status 查询帐号在线状态(https://cloud.tencent.com/document/product/269/2566)
AllMemberPushApi imAddTag POST /v4/all_member_push/im_add_tag 添加用户标签(https://cloud.tencent.com/document/product/269/45941)
AllMemberPushApi imGetAttr POST /v4/all_member_push/im_get_attr 获取用户属性(https://cloud.tencent.com/document/product/269/45937)
AllMemberPushApi imGetAttrName POST /v4/all_member_push/im_get_attr_name 获取应用属性名称(https://cloud.tencent.com/document/product/269/45936)
AllMemberPushApi imGetTag POST /v4/all_member_push/im_get_tag 获取用户标签(https://cloud.tencent.com/document/product/269/45940)
AllMemberPushApi imPush POST /v4/all_member_push/im_push 全员推送(https://cloud.tencent.com/document/product/269/45934)
AllMemberPushApi imRemoveAllTags POST /v4/all_member_push/im_remove_all_tags 删除用户所有标签(https://cloud.tencent.com/document/product/269/45943)
AllMemberPushApi imRemoveAttr POST /v4/all_member_push/im_remove_attr 删除用户属性(https://cloud.tencent.com/document/product/269/45939)
AllMemberPushApi imRemoveTag POST /v4/all_member_push/im_remove_tag 删除用户标签(https://cloud.tencent.com/document/product/269/45942)
AllMemberPushApi imSetAttr POST /v4/all_member_push/im_set_attr 设置用户属性(https://cloud.tencent.com/document/product/269/45938)
AllMemberPushApi imSetAttrName POST /v4/all_member_push/im_set_attr_name 设置应用属性名称(https://cloud.tencent.com/document/product/269/45935)
GroupApi addGroupMember POST /v4/group_open_http_svc/add_group_member 增加群成员(https://cloud.tencent.com/document/product/269/1621)
GroupApi changeGroupOwner POST /v4/group_open_http_svc/change_group_owner 转让群主(https://cloud.tencent.com/document/product/269/1633)
GroupApi clearGroupAttr POST /v4/group_open_http_svc/clear_group_attr 清空群自定义属性(https://cloud.tencent.com/document/product/269/67009)
GroupApi createGroup POST /v4/group_open_http_svc/create_group 创建群组(https://cloud.tencent.com/document/product/269/1615)
GroupApi deleteGroupMember POST /v4/group_open_http_svc/delete_group_member 删除群成员(https://cloud.tencent.com/document/product/269/1622)
GroupApi deleteGroupMsgBySender POST /v4/group_open_http_svc/delete_group_msg_by_sender 删除指定用户发送的消息(https://cloud.tencent.com/document/product/269/2359)
GroupApi destroyGroup POST /v4/group_open_http_svc/destroy_group 解散群组(https://cloud.tencent.com/document/product/269/1624)
GroupApi forbidSendMsg POST /v4/group_open_http_svc/forbid_send_msg 批量禁言和取消禁言(https://cloud.tencent.com/document/product/269/1627)
GroupApi getAppidGroupList POST /v4/group_open_http_svc/get_appid_group_list 获取 App 中的所有群组(https://cloud.tencent.com/document/product/269/1614)
GroupApi getGroupAttr POST /v4/group_open_http_svc/get_group_attr 获取群自定义属性(https://cloud.tencent.com/document/product/269/67012)
GroupApi getGroupInfo POST /v4/group_open_http_svc/get_group_info 获取群详细资料(https://cloud.tencent.com/document/product/269/1616)
GroupApi getGroupMemberInfo POST /v4/group_open_http_svc/get_group_member_info 获取群成员详细资料(https://cloud.tencent.com/document/product/269/1617)
GroupApi getGroupShuttedUin POST /v4/group_open_http_svc/get_group_shutted_uin 获取被禁言群成员列表(https://cloud.tencent.com/document/product/269/2925)
GroupApi getJoinedGroupList POST /v4/group_open_http_svc/get_joined_group_list 获取用户所加入的群组(https://cloud.tencent.com/document/product/269/1625)
GroupApi getOnlineMemberNum POST /v4/group_open_http_svc/get_online_member_num 获取直播群在线人数(https://cloud.tencent.com/document/product/269/49180)
GroupApi getRoleInGroup POST /v4/group_open_http_svc/get_role_in_group 查询用户在群组中的身份(https://cloud.tencent.com/document/product/269/1626)
GroupApi groupMsgGetSimple POST /v4/group_open_http_svc/group_msg_get_simple 拉取群历史消息(https://cloud.tencent.com/document/product/269/2738)
GroupApi groupMsgRecall POST /v4/group_open_http_svc/group_msg_recall 撤回群消息(https://cloud.tencent.com/document/product/269/12341)
GroupApi importGroup POST /v4/group_open_http_svc/import_group 导入群基础资料(https://cloud.tencent.com/document/product/269/1634)
GroupApi importGroupMember POST /v4/group_open_http_svc/import_group_member 导入群成员(https://cloud.tencent.com/document/product/269/1636)
GroupApi importGroupMsg POST /v4/group_open_http_svc/import_group_msg 导入群消息(https://cloud.tencent.com/document/product/269/1635)
GroupApi modifyGroupAttr POST /v4/group_open_http_svc/modify_group_attr 修改群自定义属性(https://cloud.tencent.com/document/product/269/67010)
GroupApi modifyGroupBaseInfo POST /v4/group_open_http_svc/modify_group_base_info 修改群基础资料(https://cloud.tencent.com/document/product/269/1620)
GroupApi modifyGroupMemberInfo POST /v4/group_open_http_svc/modify_group_member_info 修改群成员资料(https://cloud.tencent.com/document/product/269/1623)
GroupApi modifyGroupMsg POST /v4/openim/modify_group_msg 修改群聊历史消息(https://cloud.tencent.com/document/product/269/74741)
GroupApi sendGroupMsg POST /v4/group_open_http_svc/send_group_msg 在群组中发送普通消息(https://cloud.tencent.com/document/product/269/1629)
GroupApi sendGroupSystemNotification POST /v4/group_open_http_svc/send_group_system_notification 在群组中发送系统通知(https://cloud.tencent.com/document/product/269/1630)
GroupApi setGroupAttr POST /v4/group_open_http_svc/set_group_attr 重置群自定义属性(https://cloud.tencent.com/document/product/269/67011)
GroupApi setUnreadMsgNum POST /v4/group_open_http_svc/set_unread_msg_num 设置成员未读消息计数(https://cloud.tencent.com/document/product/269/1637)
MuteApi getnospeaking POST /v4/openconfigsvr/getnospeaking 查询全局禁言(https://cloud.tencent.com/document/product/269/4229)
MuteApi setnospeaking POST /v4/openconfigsvr/setnospeaking 设置全局禁言(https://cloud.tencent.com/document/product/269/4230)
OperationApi allowBannedObject POST /v4/im_cos_msg/allow_banned_object 聊天文件解封(https://cloud.tencent.com/document/product/269/74776)
OperationApi forbidIllegalObject POST /v4/im_cos_msg/forbid_illegal_object 聊天文件封禁(https://cloud.tencent.com/document/product/269/74775)
OperationApi getCosSig POST /v4/im_cos_msg/get_cos_sig 聊天文件签名(https://cloud.tencent.com/document/product/269/74777)
OperationApi getHistory POST /v4/open_msg_svc/get_history 下载最近消息记录(https://cloud.tencent.com/document/product/269/1650)
OperationApi getIPList POST /v4/ConfigSvc/GetIPList 获取服务器 IP 地址(https://cloud.tencent.com/document/product/269/45438)
OperationApi getappinfo POST /v4/openconfigsvr/getappinfo 拉取运营数据(https://cloud.tencent.com/document/product/269/4193)
PortraitApi portraitGet POST /v4/profile/portrait_get 拉取资料(https://cloud.tencent.com/document/product/269/1639)
PortraitApi portraitSet POST /v4/profile/portrait_set 设置资料(https://cloud.tencent.com/document/product/269/1640)
RecentContactApi deleteRecentContact POST /v4/recentcontact/delete 删除单个会话(https://cloud.tencent.com/document/product/269/62119)
RecentContactApi getRecentContactList POST /v4/recentcontact/get_list 拉取会话列表(https://cloud.tencent.com/document/product/269/62118)
RelationshipsApi blackListAdd POST /v4/sns/black_list_add 添加黑名单(https://cloud.tencent.com/document/product/269/3718)
RelationshipsApi blackListCheck POST /v4/sns/black_list_check 校验黑名单(https://cloud.tencent.com/document/product/269/3725)
RelationshipsApi blackListDelete POST /v4/sns/black_list_delete 删除黑名单(https://cloud.tencent.com/document/product/269/3719)
RelationshipsApi blackListGet POST /v4/sns/black_list_get 拉取黑名单(https://cloud.tencent.com/document/product/269/3722)
RelationshipsApi friendAdd POST /v4/sns/friend_add 添加好友(https://cloud.tencent.com/document/product/269/1643)
RelationshipsApi friendCheck POST /v4/sns/friend_check 校验好友(https://cloud.tencent.com/document/product/269/1646)
RelationshipsApi friendDelete POST /v4/sns/friend_delete 删除好友(https://cloud.tencent.com/document/product/269/1644)
RelationshipsApi friendDeleteAll POST /v4/sns/friend_delete_all 删除所有好友(https://cloud.tencent.com/document/product/269/1645)
RelationshipsApi friendGet POST /v4/sns/friend_get 拉取好友(https://cloud.tencent.com/document/product/269/1647)
RelationshipsApi friendGetList POST /v4/sns/friend_get_list 拉取指定好友(https://cloud.tencent.com/document/product/269/8609)
RelationshipsApi friendImport POST /v4/sns/friend_import 导入好友(https://cloud.tencent.com/document/product/269/8301)
RelationshipsApi friendUpdate POST /v4/sns/friend_update 更新好友(https://cloud.tencent.com/document/product/269/12525)
RelationshipsApi groupAdd POST /v4/sns/group_add 添加分组(https://cloud.tencent.com/document/product/269/10107)
RelationshipsApi groupDelete POST /v4/sns/group_delete 删除分组(https://cloud.tencent.com/document/product/269/10108)
RelationshipsApi groupGet POST /v4/sns/group_get 拉取分组(https://cloud.tencent.com/document/product/269/54763)
SingleChatApi adminGetroammsg POST /v4/openim/admin_getroammsg 查询单聊消息(https://cloud.tencent.com/document/product/269/42794)
SingleChatApi adminMsgwithdraw POST /v4/openim/admin_msgwithdraw 撤回单聊消息(https://cloud.tencent.com/document/product/269/38980)
SingleChatApi adminSetMsgRead POST /v4/openim/admin_set_msg_read 设置单聊消息已读(https://cloud.tencent.com/document/product/269/50349)
SingleChatApi batchsendmsg POST /v4/openim/batchsendmsg 批量发单聊消息(https://cloud.tencent.com/document/product/269/1612)
SingleChatApi getC2cUnreadMsgNum POST /v4/openim/get_c2c_unread_msg_num 查询单聊未读消息计数(https://cloud.tencent.com/document/product/269/56043)
SingleChatApi importmsg POST /v4/openim/importmsg 导入单聊消息(https://cloud.tencent.com/document/product/269/2568)
SingleChatApi modifyC2cMsg POST /v4/openim/modify_c2c_msg 修改单聊历史消息(https://cloud.tencent.com/document/product/269/74740)
SingleChatApi sendmsg POST /v4/openim/sendmsg 单发单聊消息(https://cloud.tencent.com/document/product/269/2282)

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Contact

腾讯云IM REST API SDK 技术交流QQ群

QQ群号:909322484