응답 객체
콜백 객체
키 | 타입 | 설명 |
---|---|---|
callback_type | string | 콜백 타입 - CREATE 또는 UPDATE 또는 END |
video | object | 방송 객체 |
방송 객체
키 | 타입 | 설명 |
---|---|---|
video_key | string | 방송 키 |
state | string | 방송 상태. LIVE 또는 VOD |
url | string | 방송 URL |
thumbnail_url | string | 방송 썸네일 URL |
duration | long | 방송 길이(millisecond) |
watch_count | long | LIVE 시청자 수 |
heart_count | long | 하트 수 |
view_count | long | 조회 수 |
like_count | long | 좋아요 수 |
video_download_url | long | (방송 종료시 포함) 비디오 파일 |
chat_download_url | string | (방송 종료시 포함) 채팅 메시지 파일 |
preview_url | string | 하이라이트 URL |
preview_duration | long | 하이라이트 길이(millisecond) |
started_at | long | 방송 시간 시간 (unix timestamp, millisecond) |
ended_at | long | 방송 종료 시간 (unix timestamp, millisecond) |
recorded_at | long | 녹화 시작 시간 (unix timestamp, millisecond) |
stats | object | (방송 종료시 포함) 방송 통계 객체 |
방송 통계 객체
키 | 타입 | 설명 |
---|---|---|
total_watcher_count | long | 누적 시청자 수 |
live_watcher_count | long | 라이브 시청자 수 |
max_watcher_count | long | 최대 시청자 수 |
total_message_count | long | 전체 채팅 메시지 개수 |
like_count | long | 좋아요 수 |
heart_count | long | 하트 수 |
avg_live_watch_time | long | 평균 시청 시간 (초) |
total_watcher_trend | Array | 누적 시청자 추이 객체 Array |
vod | Object | VOD 시청 통계. 기본 통계 객체 |
preview | Object | Preview 시청 통계. 기본 통계 객체 |
기본 통계 객체
키 | 타입 | 설명 |
---|---|---|
view_count | long | 조회 수 |
avg_watch_count | long | 평균 시청 시간 (초) |
누적 시청자 추이 객체
키 | 타입 | 설명 |
---|---|---|
time | long | 방송 시작 후 시간 (분) |
total_watcher_count | long | 누적 시청자 수 |
채팅 메시지 객체
키 | 타입 | 설명 |
---|---|---|
message_id | string | 채팅 메시지 ID |
message | string | 채팅 메시지 본문 |
created_at | long | 메시지를 보낸 시간. (unix timestamp, millisecond) |
어드민 채팅 메시지 객체
키 | 타입 | 설명 |
---|---|---|
message_id | string | 채팅 메시지 ID |
message | string | 채팅 메시지 본문 |
created_at | long | 메시지를 보낸 시간. (unix timestamp, millisecond) |
message_type | string | 메시지 타입. ex) MESSAGE, DM |
custom_type | string | 사용자 정의 타입. ex) QUESTION, ANSWER |
data | string | 사용자 정의 데이터. 사용자가ㅡ필요한 데이터를 정의해서 사용 |
사용자 객체
키 | 타입 | 설명 |
---|---|---|
user_id | string | 사용자 ID |
username | string | 사용자 이름 |
profile_photo_proifle | string | 프로필 사진 URL |
방송 호스트 객체
키 | 타입 | 설명 |
---|---|---|
host | string | 서버 주소 |
stream_key | string | 스트림 키 |
메시지 통계 객체
키 | 타입 | 설명 |
---|---|---|
total_message_count | long | 채팅 메시지 개수 |
응답 코드
Http code | error | error description |
---|---|---|
400 | 40000 | Invalid user_id - valid value of 'user_id' is range 1 to 80. |
400 | 40001 | Invalid video_key - valid value of 'video_key' is range 4 to 100. |
400 | 40002 | Invalid type - valid value of 'type' is either 'BROADCASTED' or 'UPLOADED'. |
400 | 40003 | Invalid user_name - max size of 'user_name' is range 80. |
400 | 40004 | Invalid user_avatar_url - max size of 'user_avatar_url' is 200. |
400 | 40005 | Invalid chat_room_id - valid value of 'chat_room_id' is range 1 to 200. |
400 | 40005 | Invalid title - valid value of 'title' is range 1 to 100. |
400 | 40006 | Invalid content - valid value of 'content' is range 1 to 4000. |
400 | 40007 | Invalid visibility - valid value of 'visibility' is either 'PUBLIC' or 'PRIVATE'. |
400 | 40008 | Invalid chat_room_id - valid value of 'chat_room_id' is range 1 to 200. |
400 | 40009 | Invalid data - valid value of 'data' is range 1 to 2000. |
400 | 40011 | Invalid state - valid value of 'state' is either 'LIVE' or 'VOD'. |
400 | 40012 | Invalid cursor. |
400 | 40013 | Invalid count - check the limitation of count. |
400 | 40014 | Invalid like - valid value of 'like' is 'true'. |
400 | 40015 | Invalid keyword - valid value of 'keyword' is range 1 to 200. |
400 | 40016 | Invalid sort - valid value of 'sort' is either 'asc' or 'desc'. |
400 | 40017 | Invalid reason - valid value of 'reason' is range 1 to 400. |
400 | 40018 | Invalid video_key - Already exist. |
400 | 40019 | Invalid video_key format - ‘video_key’ should contain only alphanumeric without space. |
400 | 40020 | Required request body is missing. |
400 | 40400 | Not found - specified video key is not exist. |
400 | 40401 | Invalid state - the state of specified video key is not valid. |
400 | 40402 | Not permitted - the user_id does not have permission. |
400 | 40403 | Already liked. |
400 | 40404 | Invalid visibility - specified video key is private. |
400 | 40418 | Invalid visibility - specified video key is private. |
400 | 40419 | Highlight Not found - Highlight does not exist. |