Add an HMS push configuration
Registers an HMS (Huawei Mobile Services) push configuration for client apps. To send push notifications to Android devices for HMS, you should first register the HMS push configuration. You can also register the configurations on the Sendbird Dashboard under Settings > Chat > Push notifications.
HTTP request
Request body
The following table lists the properties of an HTTP request that this action supports.
Properties
Required | Type | Description |
---|---|---|
huawei_app_id | string | Specifies the unique ID of the application registered to the HMS server. |
huawei_app_secret | string | Specifies the secret key allocated to the application. |
Optional | Type | Description |
---|---|---|
push_sound | string | Specifies the name of a sound file to be played when a push notification is delivered to client apps. The file should be located in the |
Response
If successful, this action returns the information about the registered FCM push configuration in the response body.
List of response properties
Property name | Type | Description |
---|---|---|
push_configurations[] | array of objects | An array of FCM, HMS, or APNs push configurations. |
push_configurations.(provider).id | string | A unique provider ID of the push configuration. This is automatically generated by Sendbird. |
push_configurations.(provider).push_type | string | The type of the push configuration. |
push_configurations.(provider).huawei_app_id | string | The unique ID of the app registered to the HMS server. |
push_configurations.(provider).huawei_app_secret | string | The HMS secret key of the registered app. |
push_configurations.(provider).push_sound | string | The name of a sound file to be played when a push notification is delivered to client apps. |
In the case of an error, an error object is returned. A detailed list of error codes is available here.