Add app notification configuration

1min

POST
https://{base_url}/core/api/v1/notification-service/apps/{appId}/notification
API for adding app notification configuration by app ID:
ParameterDescriptionTypeValidation
nameApplication name.string
appPlatformApplication platform.stringEnum: [android, ios]
appIdApplication ID generated on firebase/apn project.string
enableNotificationbooleandefault: true
accountConfig
ㅤ↳androidmaxProperties: 1
ㅤㅤㅤ↳projectId*SDS key for the globally unique, user-assigned ID of the parent project for the app.string
ㅤㅤㅤ↳clientEmail*SDS key for firebase service account.string
ㅤㅤㅤ↳privateKey*SDS key for private key for firebase service account.string
androidConfigConfiguration for Android notification message.
ㅤ↳collapseKeyCollapse key for the message. Collapse key serves as an identifier for a group of messages that can be collapsed, so that only the last message
gets sent when delivery can be resumed.string
ㅤ↳priorityFCM concept that controls when the message is delivered.stringEnum: [high, normal]
ㅤ↳ttlTime-to-live duration of the message in milliseconds.number
ㅤ↳restrictedPackageNamePackage name of the application where the registration tokens must match in order to receive the message.string
ㅤ↳iconIcon resource for the Android notification.string
ㅤ↳colorNotification icon color in #rrggbb format.stringpattern: ^#([a-fA-F0-9]{6})$
ㅤ↳soundFile name of the sound to be played when the device receives the notification.string
ㅤ↳tagNotification tag. This is an identifier used to replace existing notifications in the notification drawer.
If not specified, each request creates a new notification.string
ㅤ↳clickActionAction associated with a user clicking on the notification.
If specified, an activity with a matching Intent Filter is launched when a user clicks on the notification.string
ㅤ↳bodyLocKeyKey of the body string in the app's string resource to use to localize the body text.string
ㅤ↳bodyLocArgsAn array of resource keys that will be used in place of the format specifiers in bodyLocKey.string
ㅤ↳titleLocKeyKey of the title string in the app's string resource to use to localize the title text.string
ㅤ↳titleLocArgsAn array of resource keys that will be used in place of the format specifiers in titleLocKey.string
ㅤ↳channelIdThe Android notification channel ID (new in Android O). The app must create a channel with this channel ID before any notification with this channel ID
 can be received. If you don't send this channel ID in the request, or if the channel ID provided has not yet been created by the app, FCM uses the channel ID
specified in the app manifest.string
ㅤ↳tickerSets the "ticker" text, which is sent to accessibility services. Prior to API level 21 (Lollipop), sets the text that is displayed in the status bar when
the notification first arrives.string
ㅤ↳stickyWhen set to false or unset, the notification is automatically dismissed when the user clicks it in the panel.
When set to true, the notification persists even when the user clicks it.boolean
ㅤ↳eventTimestampFor notifications that inform users about events with an absolute time reference, sets the time that the event in the notification occurred.
Notifications in the panel are sorted by this time.string($date-time)
ㅤ↳localOnlySets whether or not this notification is relevant only to the current device.
Some notifications can be bridged to other devices for remote display, such as a Wear OS watch. This hint can be set to recommend this
notification not be bridged.boolean
ㅤ↳notificationPrioritySets the relative priority for this notification. This priority is processed by the client after the message has been delivered.Enum: [ min, low, default, high, max ]
ㅤ↳defaultSoundIf set to true, use the Android framework's default sound for the notification.boolean
ㅤ↳defaultVibrateTimingsIf set to true, use the Android framework's default vibrate pattern for the notification.boolean
ㅤ↳defaultLightSettingsIf set to true, use the Android framework's default LED light settings for the notification.boolean
ㅤ↳vibrateTimingsMillisSet the vibration pattern to use. Pass in an array of milliseconds to turn the vibrator on or off. The first value indicates the duration to wait before 
turning the vibrator on. The next value indicates the duration to keep the vibrator on. Subsequent values alternate between duration to turn the vibrator off
and to turn the vibrator on.string
ㅤ↳visibilitySets the visibility of the notification.stringEnum: [ private, public, secret ]
ㅤ↳notificationCountSets the number of items this notification represents. May be displayed as a badge count for Launchers that support badging.integer
ㅤ↳imageUrlURL of an image to be displayed in the notification.string
*This is required.
HTTP Status Code Summary
CodeDescription
200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
403 - ForbiddenThe API key doesn't have permissions to perform the request.
404 - Not FoundThe requested resource doesn't exist.
409 - ConflictThe request conflicts with another request (perhaps due to using the same idempotent key).
Path Parameters
appId
AppId
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Body Parameters
body
AppNotificationConfig
Description
Add App notification configuration for already register app
name
string
appPlatform
string<android,ios | android | ios>
appId
string
enableNotification
boolean
accountConfig
AccountConfig
androidConfig
AndroidNotificationConfig
iosConfig
IosNotificationConfig
Responses
200
OK
SuccessResponseWithData
All Of
SuccessResponse  +
error
Error
request
Request
*
data
object
*
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error.
ErrorResponse
error
Error
*
request
Request
*
401
Unauthorized -  The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that tenant.
ErrorResponse
error
Error
*
request
Request
*
403
Forbidden - The client's identity is known to the server, but it does not have access rights to the requested resource. Verify that you're using the correct client ID and client secret or grant the client the necessary roles to access the resource.
ErrorResponse
error
Error
*
request
Request
*
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
*
request
Request
*
409
Conflict - The request conflicts with another request (perhaps due to using the same idempotent key).
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{base_url}/core/api/v1/notification-service/apps/{appId}/notification' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'
curl --location --globoff 'https://{base_url}/core/api/v1/notification-service/apps/{appId}/notification' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'
Responses
200
400
401
403
404
409
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
﻿
﻿

Parameter	Description	Type	Validation
`name`	Application name.	string
`appPlatform`	Application platform.	string	Enum: [android, ios]
`appId`	Application ID generated on firebase/apn project.	string
`enableNotification`		boolean	default: true
`accountConfig`
ㅤ↳`android`			maxProperties: 1
ㅤㅤㅤ↳`projectId`*	SDS key for the globally unique, user-assigned ID of the parent project for the app.	string
ㅤㅤㅤ↳`clientEmail`*	SDS key for firebase service account.	string
ㅤㅤㅤ↳`privateKey`*	SDS key for private key for firebase service account.	string
`androidConfig`	Configuration for Android notification message.
ㅤ↳`collapseKey`	Collapse key for the message. Collapse key serves as an identifier for a group of messages that can be collapsed, so that only the last message gets sent when delivery can be resumed.	string
ㅤ↳`priority`	FCM concept that controls when the message is delivered.	string	Enum: [high, normal]
ㅤ↳`ttl`	Time-to-live duration of the message in milliseconds.	number
ㅤ↳`restrictedPackageName`	Package name of the application where the registration tokens must match in order to receive the message.	string
ㅤ↳`icon`	Icon resource for the Android notification.	string
ㅤ↳`color`	Notification icon color in #rrggbb format.	string	pattern: ^#([a-fA-F0-9]{6})$
ㅤ↳`sound`	File name of the sound to be played when the device receives the notification.	string
ㅤ↳`tag`	Notification tag. This is an identifier used to replace existing notifications in the notification drawer. If not specified, each request creates a new notification.	string
ㅤ↳`clickAction`	Action associated with a user clicking on the notification. If specified, an activity with a matching Intent Filter is launched when a user clicks on the notification.	string
ㅤ↳`bodyLocKey`	Key of the body string in the app's string resource to use to localize the body text.	string
ㅤ↳`bodyLocArgs`	An array of resource keys that will be used in place of the format specifiers in bodyLocKey.	string
ㅤ↳`titleLocKey`	Key of the title string in the app's string resource to use to localize the title text.	string
ㅤ↳`titleLocArgs`	An array of resource keys that will be used in place of the format specifiers in titleLocKey.	string
ㅤ↳`channelId`	The Android notification channel ID (new in Android O). The app must create a channel with this channel ID before any notification with this channel ID can be received. If you don't send this channel ID in the request, or if the channel ID provided has not yet been created by the app, FCM uses the channel ID specified in the app manifest.	string
ㅤ↳`ticker`	Sets the "ticker" text, which is sent to accessibility services. Prior to API level 21 (Lollipop), sets the text that is displayed in the status bar when the notification first arrives.	string
ㅤ↳`sticky`	When set to false or unset, the notification is automatically dismissed when the user clicks it in the panel. When set to true, the notification persists even when the user clicks it.	boolean
ㅤ↳`eventTimestamp`	For notifications that inform users about events with an absolute time reference, sets the time that the event in the notification occurred. Notifications in the panel are sorted by this time.	string	($date-time)
ㅤ↳`localOnly`	Sets whether or not this notification is relevant only to the current device. Some notifications can be bridged to other devices for remote display, such as a Wear OS watch. This hint can be set to recommend this notification not be bridged.	boolean
ㅤ↳`notificationPriority`	Sets the relative priority for this notification. This priority is processed by the client after the message has been delivered.		Enum: [ min, low, default, high, max ]
ㅤ↳`defaultSound`	If set to true, use the Android framework's default sound for the notification.	boolean
ㅤ↳`defaultVibrateTimings`	If set to true, use the Android framework's default vibrate pattern for the notification.	boolean
ㅤ↳`defaultLightSettings`	If set to true, use the Android framework's default LED light settings for the notification.	boolean
ㅤ↳`vibrateTimingsMillis`	Set the vibration pattern to use. Pass in an array of milliseconds to turn the vibrator on or off. The first value indicates the duration to wait before turning the vibrator on. The next value indicates the duration to keep the vibrator on. Subsequent values alternate between duration to turn the vibrator off and to turn the vibrator on.	string
ㅤ↳`visibility`	Sets the visibility of the notification.	string	Enum: [ private, public, secret ]
ㅤ↳`notificationCount`	Sets the number of items this notification represents. May be displayed as a badge count for Launchers that support badging.	integer
ㅤ↳`imageUrl`	URL of an image to be displayed in the notification.	string
*This is required.

Code	Description
200 - OK	Everything worked as expected.
400 - Bad Request	The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized	No valid API key provided.
403 - Forbidden	The API key doesn't have permissions to perform the request.
404 - Not Found	The requested resource doesn't exist.
409 - Conflict	The request conflicts with another request (perhaps due to using the same idempotent key).

Updated 23 Apr 2024

Did this page help you?

Update app registration detail

Get App Notification Config