Skip to content

Latest commit

 

History

History
179 lines (127 loc) · 3.82 KB

room.md

File metadata and controls

179 lines (127 loc) · 3.82 KB

room

룸 정보 조회

GET /room

소켓룸에 대한 정보를 반환합니다.

Headers

Name Value
Authorization Bearer <API 키>

Body

Body 스키마 없음

Response

{% tabs %} {% tab title="성공시" %} model<room(REST API)>

{
    "error": 0,
    "id": "your socket id",
    "users": [
        {
            "platform": "soop",
            "streamer_id": "streamer_id"
        }
    ],
    "users_limit": 20,
    "createdAt": "2024-02-28T14:09:34.319Z",
    "updatedAt": "2024-02-28T14:09:34.319Z"
}

{% endtab %}

{% tab title="실패시" %}

{
    "error": 400,
    "message": "인증정보가 없습니다. (apikey)",
    "data": {}
}

{% endtab %} {% endtabs %}

룸에 스트리머 등록

PUT /room/user

소켓룸에 스트리머를 추가합니다.

Headers

Name Value
Authorization Bearer <API 키>

Body

{% hint style="info" %} 안내

아이디 입력을 실수하는 것을 방지하고자 애청자 50 미만의 계정은 등록할 수 없습니다. {% endhint %}

Name Type Description
platform string

방송 플랫폼

지원되는 값 : soop, chzzk

user string

등록할 스트리머 아이디
- 치지직의 경우 채널 ID (?)

Response

{% tabs %} {% tab title="성공시" %} model<room(REST API)>

{
    "error": 0,
    "id": "your socket id",
    "users": [
        {
            "platform": "soop",
            "streamer_id": "streamer_id"
        }
    ],
    "users_limit": 20,
    "createdAt": "2024-02-28T14:25:07.307Z",
    "updatedAt": "2024-02-28T14:25:07.307Z"
}

{% endtab %}

{% tab title="실패시" %}

{
    "error": 400,
    "message": "인증정보가 없습니다. (apikey)",
    "data": {}
}

{% endtab %} {% endtabs %}

룸에서 스트리머 삭제

DELETE /room/user

소켓룸에 스트리머를 추가합니다.

Headers

Name Value
Authorization Bearer <API 키>

Body

Name Type Description
platform string

방송 플랫폼

지원되는 값 : soop

user string

등록할 스트리머 아이디

- 치지직의 경우 채널 ID (?)

Response

{% tabs %} {% tab title="성공시" %} model<room(REST API)>

{
    "error": 0,
    "id": "your socket id",
    "users": [
        {
            "platform": "soop",
            "streamer_id": "streamer_id"
        }
    ],
    "users_limit": 20,
    "createdAt": "2024-02-28T14:25:07.307Z",
    "updatedAt": "2024-02-28T14:25:07.307Z"
}

{% endtab %}

{% tab title="실패시" %}

{
    "error": 400,
    "message": "인증정보가 없습니다. (apikey)",
    "data": {}
}

{% endtab %} {% endtabs %}