Chat / Platform API
Current version: v3
    Chat Platform API v3
    Chat Platform API
    Chat
    Platform API
    Home
    /
    Chat
    /
    Platform API
    /
    User

    List operators of a channel by a custom channel type

    You can retrieve a list of operators of a channel with the specified custom channel type using this API.


    HTTP Request

    GET https://api-{application_id}.sendbird.com/v3/applications/settings_by_channel_custom_type/{custom_type}/operators
    

    Parameters

    The following table lists the parameters that this action supports.

    Parameters
    RequiredTypeDescription

    custom_type

    string

    Specifies a custom channel type.

    OptionalTypeDescription

    token

    string

    Specifies a page token that indicates the starting index of results to retrieve. If not specified, the index is set as 0.

    limit

    int

    Specifies the number of results to return per page. Acceptable values are 1 to 100, inclusive. (Default: 10)

    ?token=SabQRDpSpl65dR1WXlVaFr4P&limit=5
    

    Responses

    If successful, this action returns a list of application resources registered as the operators of channels with the custom type in the response body.

    {
        "operators": [
            {
                "user_id": "Jeremy",
                "nickname": "Bishop",
                "profile_url": "https://sendbird.com/main/img/profiles/profile_78_512px.png",
                "metadata": {
                    "location": "Tucson",
                    "marriage": "N"
                }
            },
            ...  # More operators
        ],
        "next": "Fa3Re7dFdVNrEUBRfFRdFR1f2Fk4D6~~"
    }
    

    List of response properties

    Property nameTypeDescription

    operators[]

    array of objects

    An array of users who are registered as the operators of the channel.

    next

    string

    The value that can be used in the token parameter to retrieve the next page in the result set.

    Error

    In the case of an error, an error object like below is returned. See the error codes section for more details.

    {
        "message": "Invalid value: \"JSON body.\".",
        "code": 400403,
        "error": true
    }