Chat

채팅 API로 채팅 전송, 채팅 공지 등록, 채팅 설정 조회, 채팅 설정 변경을 할 수 있습니다. 채팅 API를 호출하려면 사용자 계정으로 인증하여 얻은 Access Token이 필요합니다. API Scope는 채팅 메시지 전송, 채팅 공지 등록, 채팅 설정 조회, 채팅 설정 변경입니다.


채팅 메시지 전송

채팅 메시지를 전송할 수 있습니다.

HTTP Request
Description

POST /open/v1/chats/send

채팅 메시지 전송

Request Body

Field
Type
Description

message

String

전송할 메시지 내용. 메시지 내용은 최대 100자로 제한

Response Body

Field
Type
Description

messageId

String

전송된 메시지 ID

채팅 공지 등록

채팅 공지사항을 등록할 수 있습니다. 신규 메시지 또는 전송된 기존메시지로 공지사항을 등록이 가능합니다.

HTTP Request
Description

POST /open/v1/chats/notice

채팅 공지사항 등록

Request Body

Field
Type
Required
Description

message

String

Optional

신규 메시지로 공지사항 등록 시 전송할 메시지 내용. 메시지 내용은 최대 100자로 제한

messageId

String

Optional

기존 메시지로 공지사항 등록 시 사용하는 전송된 메시지 ID

Response

Code
Description

200

공지사항 등록 성공

채팅 설정 조회

채널의 채팅 설정을 조회할 수 있습니다.

HTTP Request
Description

GET /open/v1/chats/settings

채팅 설정 조회

Response Body

Field
Type
Description

chatAvailableCondition

String

본인인증 여부 설정 조건

  • NONE (제한 없음)

  • REAL_NAME (네이버 본인인증한 시청자만 채팅 허용)

chatAvailableGroup

String

채팅 참여 범위 설정 조건

  • ALL (모든 시청자)

  • FOLLOWER (팔로워 전용)

  • MANAGER (운영자 전용)

  • SUBSCRIBER (구독자 전용)

minFollowerMinute

Int

FOLLOWER 모드 설정된 경우 적용된 최소 팔로잉 기간 조건

allowSubscriberInFollowerMode

boolean

FOLLOWER 모드 설정된 경우 구독자는 최소 팔로잉 기간 조건 대상에서 제외 허용 할지 여부

채팅 설정 변경

채널의 채팅 설정을 변경할 수 있습니다.

HTTP Request
Description

PUT /open/v1/chats/settings

채팅 설정 변경

Request Body

Field
Type
Description

chatAvailableCondition

String

본인인증 여부 설정 조건

  • NONE (제한 없음)

  • REAL_NAME (네이버 본인인증한 시청자만 채팅 허용)

chatAvailableGroup

String

채팅 참여 범위 설정 조건

  • ALL (모든 시청자)

  • FOLLOWER (팔로워 전용)

  • MANAGER (운영자 전용)

  • SUBSCRIBER (구독자 전용)

minFollowerMinute

Int

FOLLOWER 모드 설정된 경우 적용된 최소 팔로잉 기간 조건 0, 5, 10, 30, 60, 1440, 10080, 43200 값만 허용

allowSubscriberInFollowerMode

boolean

FOLLOWER 모드 설정된 경우 구독자는 최소 팔로잉 기간 조건 대상에서 제외 허용 할지 여부

Last updated