Ncloud Chat overview

Prev Next

Available in Classic and VPC

Ncloud Chat is a NAVER Cloud Platform service that allows you to implement real-time chat and messaging systems and chat channels with multiple users. The Ncloud Chat service provides APIs for subscription, user, channel, message, friend, and token features in RESTful form.

Set API permissions

To use Ncloud Chat APIs, you need to set access permissions.
In Settings > Security of the Ncloud Chat dashboard, save the API access permissions setting as Read/Write .

Note

You can access the Ncloud Chat dashboard by entering the Services > Business Applications > Ncloud Chat menu in the NAVER Cloud Platform console, and then clicking the management page URL in the project list.

Common Ncloud Chat settings

The following describes commonly used request and response formats in 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
  • Check API key from Settings > General in the Ncloud Chat dashboard.
    • The key is reissued when clicking [Reissue API key], and the previous key can't be used.
x-project-id Required Ncloud Chat project ID
  • Check Project ID in Settings > General of the Ncloud Chat dashboard.

Response

The following describes the common response format.

Response body

The response body includes the following data:

Error
Error defines API call failure information. The following describes each error.

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 - Response successful
- -1 -
  • Unregistered API key entered
  • No access permissions
    		•
    - -2 - API key in the dashboard is different from the API key entered in the header.
    - -3 - Deleted API key
    - -4 - Unused API key on the dashboard
    - -5 - Expired API key
    - -6 - Project ID does not exist.
    Note

    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": -1,
    "message": "projectId is empty"
}

    Ncloud Chat API

    This section describes the APIs provided by Ncloud Chat.

    Token

    The following describes the token-related APIs.

    API Description
    Issue token Issue authentication token

    User convenience

    The following describes the user-related APIs.

    API Description
    Register user Register user.
    Get user list Get user list.
    Get users Get user details.
    Edit user information Edit user information.
    Remove user Remove user.
    Set push notifications Set push notification for a user.
    Get push notification settings Set push notification settings history of a user.
    Disable push notification settings Disable push notification settings 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 in bulk.
    Reject friend request Reject friend request.
    Accept friend request Accept friend request.

    Message

    The following describes the message-related APIs.

    API Description
    Send message Send message.
    Get message list Get message list.
    Get message Get message details.
    Delete message Delete message.

    Channel

    The following describes the channel-related APIs.

    API Description
    Create channel Create channel.
    Get channel list Get channel list.
    Get channel Get channel details.
    Edit channel Edit channel information.
    Delete channel Delete channel.

    Subscribe

    The following describes the subscription-related APIs.

    API Description
    Get channel subscription list Get channel subscription history list.

    Ncloud Chat related resources

    NAVER Cloud Platform provides a variety of related resources to help users better understand Ncloud Chat APIs.