Yandex Cloud Notification Service HTTP API overview
The Cloud Notification Service HTTP API is compatible with the Amazon SNS API.
For a more user-friendly experience, you can use the AWS CLI, AWS SDK for Python (boto3), and other AWS-compatible SDKs.
For authentication in the API, CLI and SDK, use a static access key. A static access key is issued for the service account, and all actions are performed on behalf of that service account.
Note
API requests to Cloud Notification Service with a static key must be signed using the AWS Signature V4 algorithm.
To avoid signing API requests to Cloud Notification Service, you can use an IAM token instead of a static key. For more information, see Sending an HTTP API request to Yandex Cloud Notification Service.
For a list of common error codes for all actions, see Errors.
Supported actions
PlatformApplications
| Action | Description |
|---|---|
| Create | Creating a mobile push notification channel |
| GetAttributes | Getting parameters of the mobile push notification channel |
| SetAttributes | Setting parameters of the mobile push notification channel |
| List | Getting a list of mobile push notification channels |
| Delete | Deleting a mobile push notification channel |
Endpoint
| Action | Description |
|---|---|
| Create | Creating an endpoint for push notifications (subscribing the user to push notifications) |
| GetAttributes | Getting endpoint parameters |
| SetAttributes | Setting endpoint parameters |
| List | Getting a list of endpoints |
| Delete | Deleting an endpoint (unsubscribing the user from push notifications) |
SMS
| Action | Description |
|---|---|
| Create | Creating an SMS notification channel. |
| GetAttributes | Getting SMS notification channel properties. |
| GetSmsAttributes | Getting properties to send SMS notifications in cloud. |
| SetAttributes | Setting SMS notification channel properties. |
| List | Getting a list of SMS notification channels. |
| Delete | Deleting an SMS notification channel. |
Sandbox
| Action | Description |
|---|---|
| Create | Adding a test phone number to an SMS notification channel and sending a one-time password to a phone number. |
| Verify | Verifying a phone number with a one-time password. |
| List | Getting a list of verified phone numbers. |
| Delete | Deleting a verified phone number. |
Publish
| Action | Description |
|---|---|
| Publish | Sending a push notification or SMS. |