Available in Classic and VPC
Simple & Easy Notification Service is a NAVER Cloud Platform service that enables the implementation of various notification message types (SMS, Alim Talk, Brand Message) without the need to build a separate message server. Simple & Easy Notification Service provides APIs for message delivery and management features in RESTful form.
Common Simple & Easy Notification Service settings
The following describes commonly used request and response formats in Simple & Easy Notification Service APIs.
Request
The following describes the common request format.
API URL
The request API URL is as follows:
https://sens.apigw.ntruss.com
Request headers
The following describes the request headers.
| Field | Required | Description |
|---|---|---|
x-ncp-apigw-timestamp |
Required | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
|
x-ncp-iam-access-key |
Required | Access key issued on NAVER Cloud Platform
|
x-ncp-apigw-signature-v2 |
Required | Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256).
|
Content-Type |
Required | Request data format
|
Response
The following describes the common response format.
Response body
The response body includes the following data:
error
error defines the API call failure information. The following describes error.
| Field | Type | Required | Description |
|---|---|---|---|
status |
Integer | Required | Errors |
errors |
String | Required | Error name |
errorMessage |
String | Required | Error message |
Response status codes
The following describes the response status codes.
| HTTP status code | Message | Description |
|---|---|---|
| 200 | OK | Request succeeded |
| 202 | Accepted | Request succeeded |
| 204 | No Content | Request succeeded |
| 400 | Bad Request | Invalid request |
| 401 | Unauthorized | Authentication failed |
| 403 | Forbidden | Access unauthorized |
| 404 | Not Found | Resource can't be found |
| 429 | Too Many Requests | Request limit exceeded |
| 500 | Internal Server Error | Internal server errors |
For information about the HTTP status codes common to all NAVER Cloud Platform, see Ncloud API response status codes.
Response example
For response examples when a call is successful, see each API specification. The following is a sample response upon a failed call.
{
"status": 403,
"error": "Forbidden",
"message": "Do not have access to this 'serviceId'"
}
Simple & Easy Notification Service API
The following describes the APIs provided by the Simple & Easy Notification Service service.
Project
The following describes the project-related APIs.
| API | Description |
|---|---|
| Create project | Create project. |
| Get project list | Get project list. |
| Get project | Get project details. |
| Modify project | Edit project information. |
| Delete project | Delete a project. |
SMS
The following describes the APIs related to SMS.
| API | Description |
|---|---|
| Send message | Send SMS/LMS/MMS message. |
| Get message delivery list | Get message delivery list. |
| Get message delivery result | Get message delivery result. |
| Get message reservation status | Get message delivery reservation status. |
| Cancel message reservation | Cancel message delivery reservation. |
| Register call block number | Register call block number. |
| Get call block number | Get call block number. |
| Delete call block number | Delete call block number. |
| Upload Attachment | Upload file for MMS delivery. |
Alim Talk
The following describes the APIs related to Alim Talk.
| API | Description |
|---|---|
| Get channel | Get Alim Talk channel. |
| Get template | Get Alim Talk template. |
| Send message | Send Alim Talk message. |
| Get message delivery list | Get Alim Talk delivery request. |
| Get message delivery result | Get Alim Talk delivery result. |
| Get message reservation status | Get Alim Talk delivery reservation status. |
| Cancel message reservation | Cancel Alim Talk delivery reservation. |
Brand Message
The following describes the APIs related to Brand Message.
| API | Description |
|---|---|
| Send message | Send Brand Message. |
| Get message delivery list | Get Brand Message delivery list. |
| Get message delivery result | Get Brand Message delivery result. |
| Get template list | Get Brand Message template list. |
| Upload image | Upload image to be used for Brand Message. |
| Get image list | Get uploaded image list. |
| Get image | Get uploaded image details. |
| Delete image | Delete uploaded image. |
Simple & Easy Notification Service related resources
NAVER Cloud Platform provides a variety of related resources to help users better understand Simple & Easy Notification Service APIs.
- Simple & Easy Notification Service API guides
- Create signature: How to create a signature to add to the request header
- Sub Account User Guides: How to issue the access key to be added to the request header
- Common Ncloud response status codes: Information on common response status codes of NAVER Cloud Platform used by the Simple & Easy Notification Service service
- How to use the Simple & Easy Notification Service service
- Simple & Easy Notification Service user guide: How to use the Simple & Easy Notification Service service in the NAVER Cloud Platform console
- Ncloud user environment guide: Explore VPC and Classic environments and supported services.
- Pricing and features: View pricing details and key capabilities.
- Latest service news: The latest news on the Simple & Easy Notification Service service
- FAQs: Get answers to common Simple & Easy Notification Service questions.
- Contact Support: Get help if you can't find what you need in the API guide.