/ Platform API
Platform API
    Chat Platform API v3
    Chat Platform API
    Chat Platform API
    Version 3
    Home
    /
    Chat
    /
    Platform API
    /
    Application

    Get global application settings

    Copy link

    Retrieves the global application settings that are applied to all channels within the application. These settings are by default applied to all channels with no custom channel types. Unless there are the specified settings for channels with a custom channel type, those channels behave on the global application settings.

    HTTP request

    Copy link
    GET https://api-{application_id}.sendbird.com/v3/applications/settings_global

    Note: If you are using the in-app channel in Delight AI agent, the endpoint for your API request should start with https://api-{application_id}.svc.delight.ai/v3 instead of https://api-{application_id}.sendbird.com/v3. For more details, refer to our Delight AI agent guide.

    Response

    Copy link

    If successful, this action returns the created global application settings resource in the response body.

    {
    "domain_filter": {
        "domains": ["s3.amazon.com", "vision.googleapis.com"],
        "type": 1,
        "should_check_global": false
    },
    "profanity_filter": {
        "keywords": "dumb,dummy",
        "regex_filters": [
            {
                "regex": "[^!@#$%^&*]*(damn|crap)[^!@#$%^&*]*"
            },
            {
                "regex": "(http://|https://)?(casino|sex)+([-.]{1}[a-z0-9]+)*.[a-z]{2,5}(:[0-9]{1,5})?(/.*)?"
            }
        ],
        "type": 2,
        "should_check_global": false
    },
    "max_message_length": 500,
    "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
    },
    "allow_links": true,
    "user_messages_per_channel_duration": 1,
    "user_messages_per_channel": 3,
    "profanity_triggered_moderation": {
        "count": 3,
        "duration": 1,
        "action": 2
    },
    "message_retention_hours": 2400
}

    In the case of an error, an error object is returned. A detailed list of error codes is available here.

    On this page
    HTTP requestResponse