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

    Get a push configuration

    Retrieves a specific push configuration of an application. The type of a push configuration is either fcm, huawei, or apns.


    HTTP request

    GET https://api-{application_id}.sendbird.com/v3/applications/push/{push_type}/{provider_id}
    

    Parameters

    The following table lists the parameters that this action supports.

    Required
    Parameter nameTypeDescription

    push_type

    string

    Specifies the type of the push configuration. Acceptable values are fcm for FCM, huawei for HMS, and apns for APNs.

    provider_id

    string

    Specifies the provider ID of the push configuration.


    Response

    If successful, this action returns information on a push configuration in the response body.

    FCMHMSAPNs
    # Status: 200 OK
    {
        "push_configurations": [
            {
                "id": "fbdd6d0071217ac71b5d8acab65d615cfab3f7b1",
                "push_type": "FCM",
                "created_at": 1596607063,
                "api_key": "BBBBEEuCTTE:APA91bE8HPMm-xQa5RT4RaPXi-UdmGNfjDUAaFRryNbth7k4uLZGK9TufYqZXLBf82I3DHyH-L5QlNef1t60WxocozV3uWIRQkESW69XgKyrRQEBH8vKlE9C5rkDtUJDFavEgFmiICvw",
                "sender_id": "69982227377",
                "push_sound": "ring.swf"
            }
        ]
    }
    

    List of response properties

    Property nameTypeDescription

    push_configurations[]

    array of objects

    A list of either FCM, HMS, or APNs push configurations.

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