tencent cloud

Feedback

Pulling Chatbot Accounts

Last updated: 2024-07-16 11:29:54

    Feature Overview

    This API is used to pull the list of all chatbot accounts. A chatbot account is a special account whose userid must start with @RBT#.

    API Calling Description

    Sample request URL

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

    Request parameters

    The following table lists the parameters used when this API is called and their descriptions. For other parameters, see the RESTful API Overview.
    Parameter
    Description
    xxxxxx
    Domain name corresponding to the country/region where your SDKAppID is located.
    China: console.tim.qq.com
    Singapore: adminapisgp.im.qcloud.com
    Seoul: adminapikr.im.qcloud.com
    Frankfurt: adminapiger.im.qcloud.com
    Silicon Valley: adminapiusa.im.qcloud.com
    Jakarta: adminapiidn.im.qcloud.com
    v4/openim_robot_http_svc/get_all_robots
    Request API
    sdkappid
    SDKAppID assigned by the Chat console when an app is created
    identifier
    App admin account. For more information, see the App Admin section in Login Authentication.
    usersig
    Signature generated by the app admin account. For details, see Generating UserSig.
    random
    A random 32-bit unsigned integer ranging from 0 to 4294967295
    contenttype
    Request format, which should always be json.

    Maximum call frequency

    200 calls per second.

    Sample request

    {}

    Sample response

    {
    "ActionStatus":"OK",
    "ErrorInfo":"",
    "ErrorCode":0,
    "Robot_Account": [
    "@RBT#001",
    "@RBT#002",
    "@RBT#003"
    ]
    }

    Response fields

    Field
    Type
    Description
    ActionStatus
    String
    Request result. OK: Successful. FAIL: Failed
    ErrorCode
    Integer
    Error code. 0: Successful. Other values: Failed
    ErrorInfo
    String
    Error information
    Robot_Account
    Array
    List of bot UserIDs

    Error Codes

    The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ErrorCode and ErrorInfo respectively. For public error codes (60000 to 79999), see Error Codes. The following table describes the error codes specific to this API:
    Error Code
    Description
    10002
    Internal error. Try again.
    10008
    Invalid request. For example, the request requires app admin permissions or the number of created chatbots reaches the upper limit.

    API Debugging Tool

    Use the RESTful API online debugging tool to debug this API.

    References

    Setting Profiles (v4/profile/portrait_set)
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support