메시지

Classic/VPC 환경에서 이용 가능합니다.

메시지

Ncloud Chat에서 제공하는 메시지 기능은 사용자 간의 효과적인 커뮤니케이션을 지원하는 다양한 서비스를 포함합니다. 이 플랫폼은 개인 대화뿐만 아니라 그룹 대화에도 적합하며, 메시지를 보내고 받는 과정을 간편하고 신속하게 만들어 줍니다. 다음은 Ncloud Chat의 주요 메시지 기능과 그 특징입니다.

1. 즉시 메시징

• 실시간 소통: 사용자들은 실시간으로 메시지를 보내고 받을 수 있으며, 이는 커뮤니케이션의 지연을 최소화합니다.
• 다중 장치 지원: 사용자는 스마트폰, 태블릿, PC 등 다양한 장치에서 메시지를 주고받을 수 있습니다.

2. 그룹 채팅

• 다수의 참여자: 사용자는 여러 명이 참여하는 그룹 채팅을 생성하여 정보를 공유하고 팀 내 소통을 용이하게 할 수 있습니다.
• 채널 관리: 관리자는 그룹 채팅을 통해 멤버를 추가하거나 제거하고, 그룹의 설정을 조정할 수 있습니다.

3. 파일 공유

• 다양한 파일 형식 지원: 텍스트, 이미지, 비디오, 문서 등 다양한 형식의 파일을 채팅을 통해 손쉽게 공유할 수 있습니다.
• 안전한 파일 보관: Ncloud Chat은 고객님 소유의 Object Storage 내에 파일을 저장관리하기 때문에 정보의 외부 유출을 방지합니다.

4. 메시지 검색

• 키워드 검색: 채팅 내에서 특정 키워드를 사용하여 과거의 대화 내용을 검색할 수 있습니다.
• 고급 필터 옵션: 날짜, 참여자, 파일 유형 등 다양한 필터를 적용하여 원하는 메시지를 빠르게 찾을 수 있습니다.

5. 알림 및 알림 조정

• 푸시 알림: 새 메시지나 중요한 업데이트가 있을 때 사용자에게 알림을 보내어 정보의 누락을 방지합니다.
• 알림 설정: 사용자는 알림의 종류와 빈도를 조정할 수 있어, 원하는 방식으로 정보를 받아볼 수 있습니다.

6. 보안과 개인 정보 보호

• 데이터 암호화: 모든 메시지는 전송과 저장 과정에서 암호화되어 외부로부터의 데이터 유출을 방지합니다.
• 개인 정보 보호: 사용자의 개인 정보와 대화 내용은 엄격하게 보호되며, 사용자의 동의 없이 제3자에게 공개되지 않습니다.

Ncloud Chat의 메시지 기능은 사용자의 커뮤니케이션을 원활하고 효율적으로 만들어 주며, 업무와 일상 생활에서 중요한 역할을 합니다. 이러한 기능들은 사용자가 더욱 쉽게 소통할 수 있도록 돕고, 팀워크를 강화하는 데 크게 기여합니다.

메시지 전달

채널을 생성하고 가입했다면 아래와 같이 호출하여 새로운 메시지를 전달합니다.

Javascript/Typescript

const message = 'Hello !!!';
await nc.sendMessage([CHANNEL_ID], {
      type: "text", 
      message: message
});

// 특정 사용자 언급을 위한 맨션 사용시
await nc.sendMessage(CHANNEL_ID, {
      type: "text", 
      mentions: [USER_ID, USER_ID]
      message: message
});
// 멘션을 보내는 또 다른 방법으로는 메시지내에 '@[ID]' 와 같이 입력할 경우 자동으로 멘션에 저장된다.

// 메시지에 답글을 보내는 경우
await nc.sendMessage(CHANNEL_ID, {
      type: "text", 
      parent_message_id: MESSAGE_ID
      message: message
});

// 신규 메시지에서 아래과 같이 parent_message 로 부모 메시지의 내용을 보강하여 전달합니다.
{
    "id": "message_id",
    "text": "Message",
    "parent_message_id": "first_message_id",
    "parent_message": { 
        "id": "message_id", 
        "text": "message_name",
        "sender" : {
            "id" : "Sender",
             "name" : "Sender Nickname",
             "profile" : "profile url",
        }
    }
}

Android(Kotlin)

NChat.sendMessage([CHANNEL_ID], messageText) { message, e ->
    if (e != null) {
        // 오류
    } else {
        // 성공
    }
}

iOS(Swift)

NChat.sendMessage(channelId: [CHANNEL_ID], message: messageText) { result in
    switch(result)
    {
    case .success(let message) :
        // 성공
        break;
    case .failure(let error) :
        // 실패
        break;
    }
}

iOS(Objective-C)

[NChatBridge.shared sendMessageWithChannelId:[CHANNEL_ID] message:[MESSAGE] type:@"TEXT" parentMessageId:@"" translate:NO :^(NSDictionary * _Nullable result, NSError * _Nullable error) {
    if (error) {
        // 오류 처리
    } else {
        // 성공 처리
    }
}];

Unity

const message = 'Hello !!!';
await nc.sendMessage(
        channelId: CHANNEL_ID, 
        type:"text", 
        content: message
);


// 메시지에 답글을 보내는 경우
await nc.sendMessage(
        channelId: CHANNEL_ID, 
        type:"text", 
        content: message, 
        parentMessageId: [MESSAGE_ID]
        );

// 메시지에 자동 번역을 해야하는 경우
await nc.sendMessage(
        channelId: CHANNEL_ID, 
        type:"text", 
        content: message, 
        translate: true
        );

// 신규 메시지에서 아래과 같이 parent_message 로 부모 메시지의 내용을 보강하여 전달합니다.
{
    "id": "message_id",
    "text": "Message",
    "parent_message_id": "first_message_id",
    "parent_message": { 
        "id": "message_id", 
        "text": "message_name",
        "sender" : {
            "id" : "Sender",
             "name" : "Sender Nickname",
             "profile" : "profile url"
        }
    }
}

Javascript/Typescript

const message = {
    { "text", "Text" },
    { "state", 1 },
    { "desc" , "Desc" }
};
// 메시지를 스트링으로 변환합니다.
const jsonString = JSON.stringify(message);
// 받은 메시지를 Array 로 변환합니다.
const messageArray = JSON.parse(jsonString);

Unity

Hashtable messageArray = new Hashtable
{
    { "channel_id", "channelId" },
    { "state", 1 },
    { "desc" , "Desc" }
};
// 메시지를 일반 텍스트로 변환 합니다.
const jsonString = JsonConvert.SerializeObject(messageArray);
// 받은 메시지를 Array 로 변환합니다.
Hashtable hashtable = JsonConvert.DeserializeObject<Hashtable>(jsonString);

• Express Message 사용하기: 오직 고속으로 메시지를 발송하기 위한 함수입니다. 시간 지연이 걸릴 수 있는 부분을 모두 스킵하여 기존 대비 10배 빠르게 메시지 전송이 가능합니다. 일반 sendMessage와 차이점은 아래와 같습니다.

게임 내에서 실시간 PvP를 제작하거나 고속의 Broadcasting이 필요한 모든 서비스에 이용이 가능합니다.

파일 업로드

• 특정 채널로 파일을 전송할 수 있습니다.
• 대시보드 > 설정 > 보안 > 허용된 파일 타입만 업로드할 수 있습니다.

Javascript/Typescript

await nc.sendFile([CHANNEL_ID], file);

Android (Kotlin)

import android.app.Activity
import android.content.Intent
import android.net.Uri
...

private val PICK_FILE_REQUEST_CODE = 1009

fun fileUpload() {
    val intent = Intent(Intent.ACTION_GET_CONTENT)
    intent.type = "*/*"
    startActivityForResult(intent, PICK_FILE_REQUEST_CODE)
}

override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
    super.onActivityResult(requestCode, resultCode, data)
    if (requestCode == PICK_FILE_REQUEST_CODE && resultCode == Activity.RESULT_OK) {
        val fileUri: Uri? = data?.data
        fileUri?.let {
            // 선택된 파일 URI를 사용하여 파일 업로드
            NChat.sendFile(this, [CHANNEL_ID], it) { response,e ->
                if (e != null) {
                    // 오류
                } else {
                    // 성공
                }
            }
        }
    }
}

iOS (Swift)

파일 업로드 기능 사용을 위해서 아래 예시와 같이 DocumentPicker 를 추가합니다.

import SwiftUI
import UniformTypeIdentifiers

struct DocumentPicker: UIViewControllerRepresentable {
    class Coordinator: NSObject, UIDocumentPickerDelegate {
        var parent: DocumentPicker

        init(parent: DocumentPicker) {
            self.parent = parent
        }

        func documentPicker(_ controller: UIDocumentPickerViewController, didPickDocumentsAt urls: [URL]) {
            guard let selectedFileURL = urls.first, selectedFileURL.startAccessingSecurityScopedResource() else { return }
            parent.selectedFileURL = selectedFileURL
            parent.isPresented = false
        }
    }

    @Binding var selectedFileURL: URL?
    @Binding var isPresented: Bool

    func makeCoordinator() -> Coordinator {
        return Coordinator(parent: self)
    }

    func makeUIViewController(context: Context) -> UIDocumentPickerViewController {
        let picker = UIDocumentPickerViewController(forOpeningContentTypes: [UTType.item])
        picker.delegate = context.coordinator
        return picker
    }

    func updateUIViewController(_ uiViewController: UIDocumentPickerViewController, context: Context) {
    }
}

View 내 파일 업로드 기능을 아래 예시와 같이 구현합니다.

@State private var selectedFileURL: URL?
@State private var isDocumentPickerPresented = false

if let selectedFileURL = selectedFileURL {
    Text("선택된 파일: \(selectedFileURL.lastPathComponent)")
    Button(action: {
        NChat.sendFile(channelId: channelId, fileUrl: selectedFileURL) { result in
            switch(result) {
                case .success(let result):
                    // 성공
                case .failure(let error):
                    // 실패
            }
        }
    }) {
        Text("파일 업로드")
    }
} else {
        Text("파일을 선택하세요")
} 
// 파일 업로드 완료 후 호출해 주십시오.
selectedFileURL?.stopAccessingSecurityScopedResource()                

var body: some View {
        VStack {
        
Button(action: {
    isDocumentPickerPresented = true
}) {
    Text("파일 선택")
}
.sheet(isPresented: $isDocumentPickerPresented) {
    DocumentPicker(selectedFileURL: $selectedFileURL, isPresented: $isDocumentPickerPresented)
}

iOS(Objective-C)

파일 업로드 기능 사용을 위해서 UIImagePickerController 혹은 UIDocumentPickerViewController 구현 이후 fileUrl를 통해 파일을 업로드 합니다.

NSURL *fileUrl = [NSURL URLWithString:[FILEURL]];
            
if (fileUrl) {
    [NChatBridge.shared sendFileWithChannelId:channelId fileUrl:fileUrl :^(NSDictionary * _Nullable result, NSError * _Nullable error) {
        if (error) {
            [self inAppLog:[NSString stringWithFormat:@"Send File Error: %@", error.localizedDescription]];
        } else {
            [self inAppLog:[NSString stringWithFormat:@"Send File succeeded with result: %@", result]];
        }
        [self.tableView reloadData];
    }];
}

Unity

await nc.sendFile([CHANNEL_ID],file);

메시지 정보

• Message Data Class

개별 메시지 정보

개별 메시지에 대한 정보를 가져올 수 있습니다.

Javascript/Typescript

var message = await nc.getMessage(channel_id, message_id);

Android (Kotlin)

NChat.getMessage([MESSAGE_ID]) {  message, e -> {
    if (e != null) {
        // 오류
    } else {
       // 성공
    }
}

iOS (Swift)

NChat.getMessage(channelId: [CHANNEL_ID], messageId: [MESSAGE_ID]) { result in
    switch(result)
    {
    case .success(let message) :
        // 성공
        break;
    case .failure(let error) :
        // 실패
        break;
    }
}

iOS(Objective-C)

[NChatBridge.shared getMessageWithChannelId:[CHANNEL_ID] messageId:[MESSAGE_ID] :^(NSDictionary * _Nullable result, NSError * _Nullable error) {
    if (error) {
        // 오류 처리
    } else {
        // 성공 처리
    }
}];

Unity

NBaseSDK.Message message = await nc.getMessage([CHANNEL_ID], [MESSAGE_ID]);

전체 메시지 정보

전체 메시지 정보를 가져올 수 있습니다.

• MessageData data class

Javascript/Typescript

const filter = { channel_id: channelId };
const sort = { created_at: -1 };
const option = { offset: 0, per_page: 100 };
const messages = nc.getMessages(filter, sort, option);

Android (Kotlin)

• 필터 설정

val filter: Map<String, Any?> = mapOf(
    "channel_id" to [CHANNEL_ID],
)

• 정렬 설정

val sort: Map<String, Any?> = mapOf(
    "created_at" to -1
)

• 옵션 설정

val options: Map<String, Any?> = mapOf(
    "per_page" to 10,
    "offset" to 0
)
NChat.getMessages(filter, sort, options) { data, e ->
    if (e != null) {
    // 오류
    } else {
    // 성공
    }
}

iOS (Swift)

let filter: [String: Any] = ["channel_id": [CHANNEL_ID]]
let option: [String: Any] = ["per_page": 10, "offset": 0]
let sort: [String: Any] = ["created_at": "-1"]
NChat.getMessages(filter: filter, option: option, sort: sort) { result in
    switch(result)
    {
    case .success(let messagesData) :
        // 성공
        break;
    case .failure(let error) :
        // 실패
        break;
    }
}

iOS(Objective-C)

NSMutableDictionary *filter = [NSMutableDictionary dictionary];
NSMutableDictionary *option = [NSMutableDictionary dictionary];
NSMutableDictionary *sort = [NSMutableDictionary dictionary];

filter[@"channel_id"] = @"[CHANNEL_ID]";

[NChatBridge.shared getMessagesWithChannelId:[CHANNEL_ID] filter:filter option:option sort:sort :^(NSDictionary * _Nullable result, NSError * _Nullable error) {
    if (error) {
        // 오류 처리
    } else {
        // 성공 처리
    }
}];

Unity

Hashtable filter = new Hashtable
{
    { "channel_id", [CHANNEL_ID] }
};
Hashtable sort = new Hashtable
{
    { "sort_id", -1 }
};
Hashtable option = new Hashtable
{
    { "offset", 0 },
    { "per_page", 10 }
};
var messages = await nc.getMessages(filter, sort, option);
if (messages != null)
    {
            foreach (var message in messages.edges)
        {
            string id = message.Node.message_id.ToString();
            Console.WriteLine("[CloudChatSample] id={0}", id);
        }
    }

• Parameters

• Filter

• Sort

• Options

안 읽은 메시지

읽지 않는 메시지 수를 리턴합니다. 첫 번째로 markRead를 통해서 마지막 읽은 메시지의 정보를 전달합니다.

Javascript/Typescript

nc.markRead(channelId, {
      user_id: message.sender.id,
      message_id: message.message_id,
      sort_id: message.sort_id
});
const unread = await nc.unreadCount([CHANNEL_ID]);

Android (Kotlin)

NChat.unreadCount([CHANNEL_ID]) { data, e ->
    if (e != null) {
        // 오류
    } else {
        // 성공
    }
}

iOS (Swift)

NChat.unreadCount(channelId: [CHANNEL_ID]) { result in
    switch(result)
    {
    case .success(let mark) :
        // 성공
        break;
    case .failure(let error) :
        // 실패
        break;
    }
}

Unity

nc.markRead([CHANNEL_ID], new NBaseSDK.MarkInput 
{
    user_id = USER_ID, 
    message_id = MESSAGE_ID,
    sort_id = SORT_ID
});
// 마크된 이후의 읽지 않은 메시지 전체 개수를 리턴합니다.
var unread = nc.unreadCount([CHANNEL_ID]);

메시지 삭제

해당 채널내에 내가 보낸 메시지를 삭제할 수 있습니다.

Javascript/Typescript

await nc.deleteMessage([CHANNEL_ID], [MESSAGE_ID]);

Android (Kotlin)

NChat.deleteMessage([CHANNEL_ID], [MESSAGE_ID]) { data, e ->
    if (e != null) {
        // 오류
    } else {
        // 성공
    }
}

iOS (Swift)

NChat.deleteMessage(channelId: [CHANNEL_ID], messageId: [MESSAGE_ID]) { result in
    switch(result)
    {
    case .success(let message) :
        // 성공
        break;
    case .failure(let error) :
        // 실패
        break;
    }
}

iOS(Objective-C)

[NChatBridge.shared deleteMessageWithChannelId:[CHANNEL_ID] messageId:[MESSAGE_ID] :^(NSDictionary * _Nullable result, NSError * _Nullable error) {
    if (error) {
        // 오류 처리
    } else {
        // 성공 처리
    }
}];

Unity

await nc.deleteMessage([CHANNEL_ID], [MESSAGE_ID]);

• Parameters

특정 메시지에 대한 안 읽은 사용자 수

채널에 참여한 사용자 목록에서 읽은 사용자 목록을 제외한 나머지 사용자가 안 읽은 사용자로 간주됩니다.

Javascript/Typescript

await nc.getMessageReadCount([CHANNEL_ID], [MESSAGE_ID]);

• Parameters

특정 메시지에 대한 안 읽은 사용자 수

이 메서드는 지정된 채널 내에서 특정 메시지를 읽지 않은 사용자의 수를 반환합니다.

Javascript/Typescript

await nc.getMessageUnreadCount(CHANNEL_ID, MESSAGE_ID);

• Parameters

• Returns

getMessageUnreadCount 메서드는 다음과 같은 형식의 객체를 반환합니다.

{
    "totalCount": 34,
    "count": 34
}

• 사용 예시

const result = await nc.getMessageUnreadCount("123456789", "987654321");

console.log(result.totalCount); // 예: 채널에 참여한 전체 사용자 수: 34
console.log(result.count);      // 예: 메시지를 읽지 않은 사용자 수: 10

위의 예제에서는 채널 ID가 "123456789"이고 메시지 ID가 "987654321"인 특정 메시지에 대해, 해당 메시지를 읽지 않은 사용자의 수를 조회하고 있습니다. result.totalCount는 채널에 속한 전체 사용자의 수를 나타내며, result.count는 지정된 메시지를 아직 읽지 않은 사용자의 수를 나타냅니다.

이 기능을 통해 채널 내에서 특정 메시지가 얼마나 많은 사용자에게 읽히지 않았는지를 쉽게 파악할 수 있습니다.