• UIKit
  • SDK
  • 서버 API
Chat/
SDK/
Flutter/
메시지/
SDK
  • Chat SDK 설치
    • 설치
  • Chat SDK 초기화
    • 초기화
  • 로그인 및 로그아웃
    • 로그인 및 로그아웃
  • 메시지
    • 메시지 개요
    • 메시지 보내기
    • 메시지 받기
    • 과거 메시지
    • 메시지 전달
    • 메시지 수정
    • 메시지 삽입
    • 메시지 삭제
    • 메시지 비우기
    • 메시지 철회
    • 온라인 메시지
    • 읽음 확인
    • 메시지 조회
    • 그룹 @ 메시지
    • 지향적 그룹 메시지
    • 알림 음소거
    • 메시지 확장
  • 대화
    • 대화 개요
    • 대화 목록
    • 대화 획득
    • 읽지 않은 대화 수
    • 대화 최상단 고정
    • 대화 삭제
    • 대화 초안
    • 대화 그룹
  • 그룹
    • 그룹 개요
    • 그룹 관리
    • 그룹 정보
    • 그룹 멤버 관리
    • 그룹 멤버 정보
    • 그룹 속성 사용자 정의
  • 사용자
    • 사용자 정보
    • 친구 관리
    • 친구 목록
    • 블록리스트
  • 오프라인 푸시
    • 오프라인 푸시
  • 시그널링
    • 시그널링 관리
  • 국부 검색
    • 메시지 검색
    • 친구 검색
    • 그룹 검색
    • 그룹 멤버 검색
  • 인터페이스 참고 문서
    • 고객 인터페이스
  • Guideline for Beginners
  • 콘솔 안내
    • 애플리케이션 생성 및 업그레이드
    • 기본 구성
    • 기능 구성
    • 계정 관리
    • 그룹 관리
    • 콜백 구성
  • 제품 소개
    • 메시지 관리
      • 1대1 메시지
      • 메시지 저장
      • 오프라인 푸시
      • 그룹 메시지
      • 메시지 포맷
    • 계정 시스템
      • 로그인 인증
      • 온라인 상태 관리
    • 그룹 관련
      • 그룹 시스템
      • 그룹 관리
    • 사용자 정보 및 관계망
      • 정보 관리
      • 관계망 관리
  • 구매 가이드
    • 과금 개요
    • 가격
  • 에러코드

과거 메시지

기능 설명

  • 메시지 기록을 가져오기 위한 API는 TencentImSDKPlugin.v2TIMManager.getMessageManager() 클래스에 있습니다.
  • 기록 일대일 및 그룹 메시지 풀링 지원 외에도 시퀀스, 시작 지점 또는 시간 범위별로 메시지를 가져오기 위한 고급 API가 제공됩니다.
  • 로컬 및 클라우드 메시지 기록을 모두 가져올 수 있습니다.
설명:

클라우드에서 메시지 기록을 가져오고 네트워크 예외가 발견되면 SDK는 로컬에 저장된 메시지 기록을 반환합니다.

로컬에 저장된 메시지 기록에는 시간 제한이 적용되지 않지만 클라우드에 저장된 메시지에는 다음과 같은 시간 제한이 적용됩니다.

  • 평가판: 무료 저장 기간은 7일이며 연장할 수 없습니다
  • 프로 버전: 무료 저장 기간은 7일이며 연장할 수 있습니다
  • 플래그십 버전: 무료 저장 기간은 30일이며 연장할 수 있습니다
설명:

  • 메시지 기록의 저장 기간을 연장하는 것은 부가 가치 서비스입니다. IM 콘솔에 로그인하여 관련 구성을 수정할 수 있습니다. 결제에 대한 자세한 내용은 요금 안내를 참고하십시오.
  • 리치 미디어 메시지(예: 이미지, 파일 및 오디오 등)는 메시지 기록과 동일한 저장 기간을 갖습니다.

일대일 메시지 기록 풀링

getC2CHistoryMessageList API (상세 보기)를 호출하여 일대일 메시지 기록을 가져옵니다.
네트워크가 정상이면 최신 클라우드 데이터를 가져옵니다. 비정상적인 경우 SDK는 로컬에 저장된 메시지 기록을 반환합니다.
로컬 메시지 기록만 가져오려면 고급 API를 참고하십시오.

이 API는 페이지별 풀링을 지원합니다. 자세한 내용은 페이지별 풀링을 참고하십시오.

예시 코드는 다음과 같습니다.

// 일대일 메시지 기록 풀링
// 첫 번째 풀링에 대해 lastMsgID를 null로 설정
// lastMsgID는 두 번째 풀링에 대해 반환된 메시지 목록의 마지막 메시지 id일 수 있음
TencentImSDKPlugin.v2TIMManager.getMessageManager().getC2CHistoryMessageList(
     userID: "userId",
     count: 10,
     lastMsgID: null,
);

그룹 메시지 기록 풀링

getGroupHistoryMessageList API (상세 보기)를 호출하여 그룹 메시지 기록을 가져옵니다.
네트워크가 정상이면 최신 클라우드 데이터를 가져옵니다. 비정상적인 경우 SDK는 로컬에 저장된 메시지 기록을 반환합니다.
로컬 메시지 기록만 가져오려면 고급 API를 참고하십시오.

이 API는 페이지별 풀링을 지원합니다. 자세한 내용은 페이지별 풀링을 참고하십시오.

주의:

  • 회의 그룹(Meeting)의 메시지 기록만 가져올 수 있습니다. 그룹 메시지 제한에 대한 자세한 내용은 그룹 시스템을 참고하십시오.
  • 이 API는 라이브 방송 그룹(AVChatRoom)에 적용되지 않습니다. 메시지가 클라우드 로밍 서버 또는 로컬 데이터베이스에 저장되지 않기 때문입니다.

예시 코드는 다음과 같습니다.

// 그룹 메시지 기록 풀링
// 첫 번째 풀링에 대해 lastMsgID를 null로 설정
// lastMsgID는 두 번째 풀링에 대해 반환된 메시지 목록의 마지막 메시지 id일 수 있음
TencentImSDKPlugin.v2TIMManager
   .getMessageManager()
   .getGroupHistoryMessageList(
     groupID: "groupID",
     count: 10,
     lastMsgID: null,
   );

고급 기능

고급 API

위의 일반 API가 메시지 기록을 가져오는 요구 사항을 충족할 수 없는 경우 고급 API getHistoryMessageList (상세 보기)를 사용할 수 있습니다.

일대일 및 그룹 메시지 기록을 가져오는 것 외에도 이 API는 다음과 같은 고급 기능을 지원합니다.

  • 메시지 풀링의 소스 설정: 로컬 데이터베이스 또는 클라우드에서 풀링.
  • 메시지 풀링의 순서 지정: 시간 역순 또는 시간순으로 풀링.
  • 로컬 풀링의 메시지 유형 지정: 텍스트, 이미지, 오디오, 비디오, 파일, 이모티콘, 그룹 tips, 병합 또는 사용자 정의 메시지 등.

API 프로토타입:

 // 일대일 메시지 기록 풀링
 // 첫 번째 풀링에 대해 lastMsgID를 null로 설정
 // lastMsgID는 두 번째 풀링에 대해 반환된 메시지 목록의 마지막 메시지 id일 수 있음
 V2TimValueCallback<List<V2TimMessage>> getHistoryMessageListRes =
     await TencentImSDKPlugin.v2TIMManager
         .getMessageManager()
         .getHistoryMessageList(
   getType: HistoryMsgGetTypeEnum.V2TIM_GET_LOCAL_OLDER_MSG, // 메시지 풀링의 소스 및 시퀀스
   userID: "userID", // 사용자id는 특정 사용자와 일대일 메시지를 풀링하려면 userID만 지정하면 됩니다.
   groupID: "groupID", // 그룹 id는 특정 그룹에서 그룹 메시지를 풀링하려면 groupID만 지정하면 됩니다.
   count: 10, // 데이터 수 풀링
   lastMsgID: null, // 시작 메시지 id 풀링
   // 그룹 채팅만 가능합니다.
   // lastMsgSeq를 메시지 풀링의 시작점으로 설정하면 반환된 메시지 목록에 해당 메시지가 포함됩니다.
   // lastMsg와 lastMsgSeq가 모두 지정된 경우 SDK는 lastMsg를 사용합니다.
   // lastMsg와 lastMsgSeq가 모두 지정되지 않은 경우 getTimeBegin 설정 여부에 따라 풀링 시작 지점이 결정됩니다. 그렇다면 설정된 범위가 시작점으로 사용됩니다. 아니오인 경우 최신 메시지가 시작점으로 사용됩니다.
   lastMsgSeq: -1,
   messageTypeList: [], // 기록 정보 속성을 필터링하는 데 사용되며 비어 있으면 모든 속성 정보를 풀링합니다.
 );
 if (getHistoryMessageListRes.code == 0) {
   //가져오기 성공
 }

매개변수 설명:

매개변수설명일대일 채팅에 유효그룹 채팅에 유효필수 입력 여부비고
getType로컬/클라우드역순/시간순으로 각각 설정할 수 있는 메시지 풀링의 소스 및 시퀀스YESYESYES풀링 소스를 클라우드로 설정하면 로컬 메시지 목록과 클라우드 메시지 목록이 병합되어 반환됩니다. 네트워크 연결이 없으면 로컬 메시지 목록이 반환됩니다.
userID일대일 메시지 기록을 가져올 지정된 사용자 IDYESNONO특정 사용자와 일대일 메시지를 풀링하려면 userID만 지정하면 됩니다.
groupID그룹 메시지 기록을 가져올 지정된 그룹 IDNOYESNO특정 그룹에서 그룹 메시지를 풀링하려면 groupID만 지정하면 됩니다.
count풀링당 메시지 수YESYESYESiOS/Android는 20으로 설정하는 것이 좋습니다. 그렇지 않으면 풀링 속도에 영향을 줄 수 있습니다. Web의 최댓값은 15입니다.
lastMsgID메시지 기록을 풀링할 시작 메시지를 나타내는 마지막 메시지의 IDYESYESNO1. 일대일 채팅과 그룹 채팅 모두에 사용할 수 있습니다.
2. lastMsg를 메시지 풀링의 시작점으로 설정하면 이 메시지는 반환된 메시지 목록에 포함되지 않습니다.
3. 비워두면 대화의 가장 최근 메시지가 끌어오기 시작점으로 사용됩니다.
lastMsgSeq메시지 기록을 풀링할 시작 메시지를 나타내는 마지막 메시지의 seqNOYESNO1. 그룹 채팅만 가능합니다.
2. lastMsgSeq를 메시지 풀링의 시작점으로 설정하면 반환된 메시지 목록에 해당 메시지가 포함됩니다.
3. lastMsg와 lastMsgSeq가 모두 지정된 경우 SDK는 lastMsg를 사용합니다.
4. lastMsg와 lastMsgSeq가 모두 지정되지 않은 경우 getTimeBegin 설정 여부에 따라 풀링 시작 지점이 결정됩니다. 그렇다면 설정된 범위가 시작점으로 사용됩니다. 아니오인 경우 최신 메시지가 시작점으로 사용됩니다.

페이지별 풀링

일대일 메시지 기록 풀링, 그룹 메시지 기록 풀링고급 API를 통한 풀링은 모두 lastMsgcount 를 사용하여 페이징할 수 있습니다.

  • 페이지별 풀링은 lastMsgcount를 사용하여 구현할 수 있습니다. 첫 번째 풀링의 경우 lastMsg를 비워둘 수 있습니다. 이는 반환된 메시지 목록의 마지막 메시지가 다음 페이지의 데이터를 풀링하기 위한 lastMsg로 사용됨을 나타냅니다.
  • lastMsg가 비어 있으면 SDK는 기본적으로 최신 메시지부터 메시지 기록을 반환합니다.
  • lastMsg가 설정되면 반환된 메시지 목록에는 설정된 lastMsg가 포함되지 않습니다.
  • 반환된 메시지 목록에는 역순으로 메시지가 표시됩니다.
설명:

  1. 메시지 기록 풀링 속도에 영향을 주지 않으려면 페이징에 대해 count를 20으로 설정하는 것이 좋습니다.
  2. 해당 메시지가 반환된 메시지 목록에 포함되므로 후속 가져오기에는 lastMsgSeq를 사용하지 않는 것이 좋습니다.

로컬 메시지만 풀링

로컬 메시지만 풀링하도록 getType을 설정합니다.

  • getTypeV2TIM_GET_LOCAL_OLDER_MSG로 설정되면 로컬에 저장된 메시지가 역순으로 풀링됩니다.
  • getTypeV2TIM_GET_LOCAL_NEWER_MSG로 설정되면 로컬에 저장된 메시지를 시간순으로 가져옵니다.

다음 예시 코드는 최신 메시지부터 역순으로 로컬 데이터베이스에서 20개의 일대일 메시지를 가져오는 프로세스를 보여줍니다.

TencentImSDKPlugin.v2TIMManager.getMessageManager().getHistoryMessageList(
     count: 10,
     getType: HistoryMsgGetTypeEnum.V2TIM_GET_LOCAL_OLDER_MSG,
     userID: "userID",
);

그룹 @ 메시지로 리디렉션한 후 메시지 풀링

사용자가 그룹 대화에서 그룹 @ 메시지를 받은 후 사용자는 일반적으로 @ 표시줄을 클릭하여 메시지로 이동하고 표시할 인접 메시지를 풀링해야 합니다.
그룹 @ 메시지도 표시해야 하므로 sequence를 lastMsgSeq로 설정하고 고급 API를 사용하여 메시지를 풀링할 수 있습니다.

다음 예시 코드는 @ 표시줄을 클릭하고 그룹 @ 메시지로 리디렉션하고 해당 메시지보다 앞과 뒤의 처음 20개 메시지를 표시용으로 풀링하는 프로세스를 보여줍니다.

// 그룹 @ 메시지의 sequence 가져오기
int atSequence = 1081;
// 그룹 @ 메시지와 이전 메시지 풀링
TencentImSDKPlugin.v2TIMManager.getMessageManager().getHistoryMessageList(
    count: 20, // 20개의 메시지 풀링
    getType: HistoryMsgGetTypeEnum.V2TIM_GET_CLOUD_OLDER_MSG, // 그룹 @ 메시지보다 먼저 메시지 풀링
    lastMsgSeq: atSequence,// 풀 목록에 포함된 그룹 @ 메시지에서 풀링 시작
    groupID: "groupID" // 그룹 메시지 풀링
  );
// 그룹 @ 메시지 이후에 메시지 풀링
TencentImSDKPlugin.v2TIMManager.getMessageManager().getHistoryMessageList(
    count: 20, // 20개의 메시지 풀링
    getType: HistoryMsgGetTypeEnum.V2TIM_GET_CLOUD_NEWER_MSG, // 그룹 @ 메시지 이후에 메시지 풀링
    lastMsgSeq: atSequence,// 풀 목록에 포함된 그룹 @ 메시지에서 풀링 시작
    groupID: "groupID" // 그룹 메시지 풀링
  );

FAQ

1. 메시지 기록을 가져올 때 로그에 "total count of request cloud message exceed max limit"이 표시되면 어떻게 해야 합니까?

현재 SDK 정책은 다음과 같습니다.

  1. getType이 클라우드 메시지 기록을 풀링하도록 설정되고 풀링할 메시지 수가 x로 설정된 경우 SDK는 클라우드에서 x개의 메시지를 풀링합니다.
  2. SDK는 삭제된 메시지 및 현재 사용자와 관련 없는 메시지와 같은 유효하지 않은 메시지를 필터링합니다.
  3. 클라우드에 유효하지 않은 메시지 기록이 너무 많으면 SDK가 여러 페이징 풀링을 수행합니다.
    시스템 안정성과 견고성을 보장하기 위해 SDK는 최대 3개의 자동 페이징 가져오기를 수행합니다. 이 한도를 초과하면 “total count of request cloud message exceed max limit”라는 메시지가 로그에 표시됩니다.

이러한 제한 메커니즘이 비즈니스 레이어에 미치는 영향을 최소화하려면 다음 조치를 취하여 유효하지 않은 메시지를 줄이십시오.

  • 온라인 메시지를 사용할 수 있습니다. 즉, 메시지를 보낼 때 onlineUserOnly YES/true로 설정하십시오.
  • 그룹 메시지의 경우 대상 그룹 메시지를 사용하여 수신자를 지정합니다.

2. 클라우드 메시지 기록 가져오기 중에 메시지가 ‘손실’된 경우 어떻게 해야 합니까?

getType이 클라우드 메시지 기록을 가져오도록 설정되고 메시지 수가 count인 경우 SDK는 다음 작업을 수행합니다.

  1. 로컬 데이터베이스에서 count 메시지를 가져옵니다.
  2. 클라우드에서 count 메시지를 가져오고 삭제된 메시지와 같은 유효하지 않은 메시지를 필터링합니다. 숫자가 count보다 작으면 페이징 풀링이 트리거됩니다.
  3. 로컬 및 클라우드 메시지를 병합하고 메시지 상태와 같은 정보를 업데이트합니다.
  4. 병합된 메시지 목록에서 count 메시지를 반환합니다.

일반적으로, 메시지 ‘손실’은 2단계에서 너무 많은 유효하지 않은 메시지 풀링을 나타내며, 이는 질문 1의 제한 메커니즘을 트리거하고 실제로 클라우드에서 풀링한 메시지 수가 충분하지 않게 됩니다.
질문 1의 해결 방법에 설명된 대로 이 문제를 해결하는 것이 좋습니다.

3. 메시지 기록 풀링 시 그룹 명함 등 그룹 구성원 정보가 실시간으로 업데이트 되지 않는 경우 어떻게 해야 하나요?

  • 메시지가 생성되면 SDK는 그룹 이름 카드 및 role과 같은 현재 그룹 구성원 정보를 업데이트하고 로컬 데이터베이스에 저장합니다.
  • 그룹 메시지 기록을 풀링하면 SDK는 메시지가 생성되었을 때 그룹 구성원 정보를 직접 반환하고 실시간으로 업데이트하지 않습니다.

최신 그룹 구성원 정보를 얻으려면 getGroupMembersInfo(상세 보기) API를 사용할 수 있습니다.

4. 메시지 기록 풀링 시 랙이 발생하면 어떻게 해야 합니까?

SDK는 메시지 풀링에 최적화되었습니다. 랙이 발생하면 풀링한 메시지 수(count)를 줄일 수 있습니다.