tencent cloud

文档反馈

删除机器人

最后更新时间:2024-07-16 11:29:54

    功能说明

    本接口用于将一个机器人账号设置为无效,机器人是一种特殊账号,userid必须以@RBT#开头。
    注意:
    本接口将一个机器人账号设置为无效。
    机器人账号 UserID 本身不会被删除。

    接口调用说明

    请求 URL 示例

    https://xxxxxx/v4/openim_robot_http_svc/delete_robot?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

    请求参数说明

    下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参见 REST API 简介
    参数
    说明
    xxxxxx
    SDKAppID 所在国家/地区对应的专属域名:
    中国:console.tim.qq.com
    新加坡:adminapisgp.im.qcloud.com
    首尔: adminapikr.im.qcloud.com
    法兰克福:adminapiger.im.qcloud.com
    硅谷:adminapiusa.im.qcloud.com
    雅加达:adminapiidn.im.qcloud.com
    v4/openim_robot_http_svc/delete_robot
    请求接口
    sdkappid
    创建应用时即时通信 IM 控制台分配的 SDKAppID
    identifier
    必须为 App 管理员账号,更多详情请参见 App 管理员
    usersig
    App 管理员账号生成的签名,具体操作请参见 生成 UserSig
    random
    请输入随机的32位无符号整数,取值范围0 - 4294967295
    contenttype
    请求格式固定值为json

    最高调用频率

    200次/秒。

    请求包示例

    {
    "Robot_Account": "@RBT#001"
    }

    请求包字段说明

    字段
    类型
    属性
    说明
    Robot_Account
    String
    必填
    机器人用户名,长度不超过32字节,必须以@RBT#开头

    应答包体示例

    {
    "ActionStatus":"OK",
    "ErrorInfo":"",
    "ErrorCode":0
    }

    应答包字段说明

    字段
    类型
    说明
    ActionStatus
    String
    请求处理的结果,OK 表示处理成功,FAIL 表示失败
    ErrorCode
    Integer
    错误码,0表示成功,非0表示失败
    ErrorInfo
    String
    错误信息

    错误码说明

    除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。公共错误码(60000到79999)参见 错误码 文档。本 API 私有错误码如下:
    错误码
    含义说明
    10002
    内部错误,请重试
    10004
    参数非法,请检查必填字段是否填充,或者字段的填充是否满足协议要求
    10008
    非法请求,需要 App 管理员权限、创建的机器人已达上限等

    接口调试工具

    通过 REST API 在线调试 工具调试本接口。

    参考

    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持