Skip to Content
OpenAPIAPI 레퍼런스채널 노래책 API

채널 노래책 API

채널의 노래 목록 관리, 통합 검색, 카테고리 및 아티스트 API입니다.


노래 목록 조회

Endpoint
GET /v1/channels/{channelId}/songs

Request

Path Parameters

NameTypeDefault
channelIdnumber

채널 ID

Query Parameters

NameTypeDefault
pagenumber

페이지 번호

1
limitnumber

결과 수 (최대 100)

20
artistIdnumber

아티스트 ID 필터

categoryIdnumber

카테고리 ID 필터

proficiencynumber

숙련도 필터 (1-5)

difficultynumber

난이도 필터 (1-5)

sortBy"newest" | "oldest" | "title" | "artist" | "favorites_desc" | "favorites_asc" | "likes_desc" | "likes_asc"

정렬 기준

"newest"

Response

NameTypeDefault
songsSongResponse[]

노래 목록

totalnumber

전체 개수

pagenumber

현재 페이지

limitnumber

페이지 크기

Examples

Terminal
# 기본 조회 curl "https://openapi.meloming.com/v1/channels/1/songs" # 검색 + 필터 curl "https://openapi.meloming.com/v1/channels/1/songs?search=봄날&sortBy=newest&limit=20"

노래 상세 조회

Endpoint
GET /v1/channels/{channelId}/songs/{songId}

Request

Path Parameters

NameTypeDefault
channelIdnumber

채널 ID

songIdnumber

노래 ID

Response

응답 스키마는 노래 목록 조회의 SongResponse와 동일합니다.

Examples

Terminal
curl https://openapi.meloming.com/v1/channels/1/songs/123

노래 추가

인증 필요 - OAuth Access Token

Endpoint
POST /v1/channels/{channelId}/songs

Request

Request Body

NameTypeDefault
titlestring

노래 제목 (필수)

artistIdnumber

아티스트 ID (필수)

albumArtstring

앨범 아트 URL

karaokeUrlstring

노래방 영상 URL

coverUrlstring

커버 영상 URL

originalUrlstring

원곡 URL

difficultynumber

난이도 (1-5)

proficiencynumber

숙련도 (1-5)

songKeystring

bpmnumber

BPM

lyricsTextstring

가사 텍스트

categoryIdsnumber[]

카테고리 ID 목록

Response

생성된 노래 정보 (SongResponse)가 반환됩니다.

Examples

Terminal
curl -X POST "https://openapi.meloming.com/v1/channels/1/songs" \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "title": "노래 제목", "artistId": 1, "difficulty": 3, "proficiency": 4 }'

노래 수정

인증 필요 - 채널 소유자만 가능

Endpoint
PATCH /v1/channels/{channelId}/songs/{songId}

Request

수정하려는 필드만 Request Body에 포함합니다. 스키마는 CreateSongRequest와 동일하며 모든 필드가 선택 사항입니다.

Examples

Terminal
curl -X PATCH "https://openapi.meloming.com/v1/channels/1/songs/123" \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \ -H "Content-Type: application/json" \ -d '{"title": "수정된 제목", "difficulty": 4}'

노래 삭제

인증 필요 - 채널 소유자만 가능

Endpoint
DELETE /v1/channels/{channelId}/songs/{songId}

Examples

Terminal
curl -X DELETE "https://openapi.meloming.com/v1/channels/1/songs/123" \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

노래 통합 검색

모든 채널에서 노래를 검색합니다.

Endpoint
GET /v1/songs/search

Request

Query Parameters

NameTypeDefault
qstring

검색어 (제목, 아티스트명)

artistIdnumber

아티스트 ID 필터

categoryIdnumber

카테고리 ID 필터

sortBy"newest" | "oldest" | "title" | "artist"

정렬 기준

"newest"
pagenumber

페이지 번호

1
limitnumber

결과 수 (최대 100)

20

Response

NameTypeDefault
itemsGlobalSongSearchItem[]

검색 결과 목록

paginationPagination

페이지네이션 정보

Examples

Terminal
curl "https://openapi.meloming.com/v1/songs/search?q=봄날&limit=20"

채널 카테고리

채널에서 사용 중인 노래 카테고리 목록을 조회합니다.

Endpoint
GET /v1/channels/{channelId}/categories

Response

NameTypeDefault
idnumber

카테고리 ID

namestring

카테고리명

channelIdnumber

채널 ID

songCountnumber

해당 카테고리의 노래 수

Examples

Terminal
curl https://openapi.meloming.com/v1/channels/1/categories

채널 아티스트

채널에 등록된 아티스트 목록을 조회합니다.

Endpoint
GET /v1/channels/{channelId}/artists

Response

NameTypeDefault
idnumber

아티스트 ID

namestring

아티스트명

channelIdnumber

채널 ID

songCountnumber

해당 아티스트의 노래 수

Examples

Terminal
curl https://openapi.meloming.com/v1/channels/1/artists
Last updated on