Chat Platform API v3
Chat Platform API
Chat Platform API
Version 3
Retrieves a list of an application's registered push configurations.
The following table lists the parameters that this action supports.
Required
| Parameter name | Type | Description |
|---|
push_type | string | Specifies the type of the push configuration. Acceptable values are fcm for FCM, huawei for HMS, and apns for APNs. |
If successful, this action returns a list of the registered push configurations in the response body.
Sample provider configurations
| First provider | Second provider | Third provider |
|---|
- Uses HTTP v1 API.
- Only service account key registered.
- No API key used. | - Uses legacy API.
- Both service account key (HTTP v1) and API key (Legacy) registered. | - Uses legacy API.
- Only API key registered. |
{
"push_configurations": [
{
"id": "065c7f1c0e98b9eac8792e7da9211ce30e3923f1",
"push_type": "FCM",
"created_at": 1596607063,
"api_key": "",
"use_v1_api": true,
"project_id: "sample-app-project",
"private_key_id": "b17fc85aea21f21e2e3a93f18dd038a9d55f8d84",
"push_sound": "bird_clock_alarm.swf"
},
{
"id": "fbdd6d0071217ac71b5d8acab65d615cfab3f7b1",
"push_type": "FCM",
"created_at": 1596607063,
"api_key": "BBBBEEuCTTE:APA91bE8HPMm-xQa5RT4RaPXi-UdmGNfjDUAaFRryNbth7k4uLZGK9TufYqZXLBf82I3DHyH-L5QlNef1t60WxocozV3uWIRQkESW69XgKyrRQEBH8vKlE9C5rkDtUJDFavEgFmiICvw",
"use_v1_api": false,
"project_id: "sample-cloud-messaging",
"private_key_id": "928bfaf1c427ef0eac8792e7da5285ce30e39cc72",
"push_sound": "ring.swf"
},
{
"id": "065c7f1c0e98b9eac8792e7da9211ce30e3923f1",
"push_type": "FCM",
"created_at": 1596607063,
"api_key": "CCCCEEuCTTE:APA91bE8HPMm-xQa5RT4RaPXi-UdmGNfjDUAaFRryNbth7k4uLZGK9TufYqZXLBf82I3DHyH-L5QlNef1t60WxocozV3uWIRQkESW69XgKyrRQEBH8vKlE9C5rkDtUJDFavEgFmiICvw",
"use_v1_api": true,
"push_sound": "bird_clock_alarm.swf"
}
]
}
List of response properties
| Property name | Type | Description |
|---|
push_configurations[] | array of objects | A list of 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.