Available in Classic and VPC
Ncloud Chat is a NAVER Cloud Platform service for implementing real-time chat and messaging systems with support for multi-user channels. The Ncloud Chat API provides RESTful endpoints for managing subscriptions, users, channels, messages, friends, and tokens.
Set API permissions
Before using Ncloud Chat APIs, you need to enable access permissions.
In the Ncloud Chat dashboard, go to Settings > Security and set API access permissions to Read/Write.
To access the Ncloud Chat dashboard, go to Menu > Services > Business Applications > Ncloud Chat in the NAVER Cloud Platform console, then click the management page URL in the project list.
Common Ncloud Chat settings
This section covers the request and response formats used across Ncloud Chat APIs.
Request
The following describes the common request format.
API URL
The request API URL is as follows:
https://dashboard-api.ncloudchat.naverncp.com
Request headers
The following describes the request headers.
| Field | Required | Description |
|---|---|---|
x-api-key |
Required | API key for Ncloud Chat.
|
x-project-id |
Required | Ncloud Chat project ID.
|
Response
The following describes the common response format.
Response body
The response body includes the following data:
Error
Error contains details about a failed API call. The following describes the error fields.
| Field | Type | Required | Description |
|---|---|---|---|
status |
Integer | - | Response code |
message |
String | - | Error message |
Response status codes
The following describes the response status codes.
| HTTP status code | Code | Message | Description |
|---|---|---|---|
| - | 1 | - | Success. |
| - | -1 | - | Unregistered API key, or insufficient access permissions. |
| - | -2 | - | API key in the request header does not match the key configured in the dashboard. |
| - | -3 | - | Deleted API key. |
| - | -4 | - | API key is disabled in the dashboard. |
| - | -5 | - | Expired API key. |
| - | -6 | - | Project ID does not exist. |
For common NAVER Cloud Platform response status codes, see Ncloud API response status codes.
Response example
For successful response examples, see each API's specification page. The following shows a sample error response:
{
"status": -1,
"message": "projectId is empty"
}
Ncloud Chat APIs
This section describes the APIs provided by Ncloud Chat.
Token
The following describes the token-related APIs.
| API | Description |
|---|---|
| Issue token | Issue an authentication token. |
User
The following describes the user-related APIs.
| API | Description |
|---|---|
| Register user | Register a user. |
| Get user list | Get the user list. |
| Get users | Get user details. |
| Edit user information | Edit user information. |
| Remove user | Remove a user. |
| Set push notifications | Configure push notifications for a user. |
| Get push notification settings | Get push notification settings for a user. |
| Disable push notification settings | Disable push notifications for a user. |
Friend
The following describes the friend-related APIs.
| API | Description |
|---|---|
| Send friend request | Send a friend request. |
| Bulk request friends | Send multiple friend requests at once. |
| Reject friend request | Reject a friend request. |
| Accept friend request | Accept a friend request. |
Message
The following describes the message-related APIs.
| API | Description |
|---|---|
| Send message | Send a message. |
| Get message list | Get the message list. |
| Get message | Get message details. |
| Delete message | Delete a message. |
Channel
The following describes the channel-related APIs.
| API | Description |
|---|---|
| Create channel | Create a channel. |
| Get channel list | Get the channel list. |
| Get channel | Get channel details. |
| Edit channel | Edit channel information. |
| Delete channel | Delete a channel. |
Subscription
The following describes the subscription-related APIs.
| API | Description |
|---|---|
| Get channel subscription list | Get channel subscription history. |
Ncloud Chat related resources
These resources provide additional context and support for Ncloud Chat APIs.
- Ncloud Chat API guides
- Common Ncloud response status codes: Review the shared response status codes used across NAVER Cloud Platform.
- Ncloud Chat service guides
- Ncloud Chat user guide: Learn how to use Ncloud Chat 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 announcements: Stay informed about service updates and news.
- FAQs: Get answers to common Ncloud Chat questions.
- Contact support: Get help if you can't find what you need in the API guide.