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

    View channel settings by a custom channel type

    You can retrieve the settings for a specific custom channel type using this API.


    HTTP Request

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

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    custom_type

    string

    Specifies the custom channel type.


    Responses

    If successful, this action returns the settings for channels with the custom type in the response body.

    {
        "domain_filter": {
            "domains": ["espn.com", "sports.yahoo.com"],
            "type": 1,
            "should_check_global": true
        },
        "profanity_filter": {
            "keywords": "idiot,dummy,damn",
            "regex_filters": [
                {
                    "regex": "[^!@#$%^&*]*(bitch|assole)[^!@#$%^&*]*"
                },
                {
                    "regex": "(http://|https://)?(casino|sex|betting)+([-.]{1}[a-z0-9]+)*.[a-z]{2,5}(:[0-9]{1,5})?(/.*)?"
                }
            ],
            "type": 2,
            "should_check_global": false
        },
        "custom_type": "Sports",
        "display_past_message": true,
        "image_moderation": {   // The default settings of image moderation.
            "type": 0,
            "soft_block": false,
            "limits": {
                "adult": 3,
                "spoof": 5,
                "medical": 5,
                "violence": 3,
                "racy": 4
            },
            "check_urls": false
        },
        "push_template": {
            "MESG": {
                "title": "",
                "body": "A new message arrived."
            },
            "FILE": "{sender_name} sent {filename} file",
            "ADMM": "New announcement: {message}"
        },
        "allow_links": true,
        "user_messages_per_channel_duration": 1,
        "user_messages_per_channel": -1,
        "profanity_triggered_moderation": {
            "count": 0,
            "duration": 1,
            "action": 0
        },
        "message_retention_hours": 1440
    }
    

    Error

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

    {
        "message": "\"channel custom type settings\" not found.",
        "code": 400201,
        "error": true
    }