V.Chat Cloud Doc

# 사용자 관리 API 명세

채팅방 사용자를 조회하며 사용자의 이용을 제한하고 해제 할 수 있게 하는 사용자 관련 API입니다.
기존 REST API처럼 요청 URL과 요청 변수로 호출하는 방법은 동일하나, 추가적으로 토큰 API (opens new window)를 통해 토큰을 발급받아, HTTP로 호출할 때 Header에 토큰과 토큰을 발급 받을 때 사용한 API KEY를 같이 전송해 주시면 호출 가능합니다.

TIP

✔️ API_KEY, roomId, clientKey 확인, X-AUTH-TOKEN 발급은 준비사항의 각 항목을 참조하세요.

# 채팅방 유저 조회(listUser)

(opens new window)

# 1. API 기본 정보

요청 URL 메서드 응답 형식 설명
https://vchatcloud.com/openapi/v1/users/{roomId} GET JSON 채팅방 사용자 목록과 상세 정보를 요청합니다.

# 2. 요청

# 헤더

요청 헤더명 설명 필수 여부
API_KEY 사용자 API KEY를 전달하는 헤더 Y
X-AUTH-TOKEN 접근 토큰을 전달하는 헤더 Y

# 변수

요청 변수명 타입 기본값 설명 필수 여부
roomId String 채팅방 아이디(채널키) Y

# 3. 응답 결과

필드 타입 설명 필수 여부
result_cd Number 결과 코드 Y
result_msg String 결과 메시지 Y
list List 채팅방 유저 리스트 Y

# listUser list

필드 타입 설명 필수 여부
roomId String 채팅방 아이디(채널 키) Y
clientKey String 유저 키 Y
nickName String 유저 대화명 Y
grade String 유저 등급 Y

# 4. 예시

# 요청

curl -X GET "https://vchatcloud.com/openapi/v1/users/{roomId}"
     -H "API_KEY: {API_KEY}"
     -H "X-AUTH-TOKEN: {X-AUTH-TOKEN}"
1
2
3

# 응답

{
  "result_cd": 1,
  "result_msg": "",
  "list": [
    {
      "clientKey": "{clientKey}",
      "nickName": "운영자",
      "grade": "userManager",
      "roomId": "{roomId}"
    },
    {
      "clientKey": "{clientKey}",
      "nickName": "Han",
      "grade": "user",
      "roomId": "{roomId}"
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

TIP

✔️ 결과 코드는 코드 정의 > 결과 코드를 참조하세요.

# 채팅방 추방 유저 조회(listExileUser)

(opens new window)

# 1. API 기본 정보

요청 URL 메서드 응답 형식 설명
https://vchatcloud.com/openapi/v1/exiles/{roomId} GET JSON 추방된 사용자 목록과 상세 정보를 요청합니다.

# 2. 요청

# 헤더

요청 헤더명 설명 필수 여부
API_KEY 사용자 API KEY를 전달하는 헤더 Y
X-AUTH-TOKEN 접근 토큰을 전달하는 헤더 Y

# 변수

요청 변수명 타입 기본값 설명 필수 여부
roomId String 채팅방 아이디(채널키) Y

# 3. 응답 결과

필드 타입 설명 필수 여부
result_cd Number 결과 코드 Y
result_msg String 결과 메시지 Y
list List 채팅방 추방 유저 리스트 Y

# listExileUser list

필드 타입 설명 필수 여부
clientKey String 유저 키 Y
nickName String 유저 대화명 Y
exileDate String 추방 날짜 Y

# 4. 예시

# 요청

curl -X GET "https://vchatcloud.com/openapi/v1/exiles/{roomId}" 
     -H "API_KEY: {API_KEY}" 
     -H "X-AUTH-TOKEN: {X-AUTH-TOKEN}"
1
2
3

# 응답

{
  "result_cd": 1,
  "result_msg": "",
  "list": [
    {
      "clientKey": "{clientKey}",
      "nickName": "Han",
      "muteDate": "20211004123017"
    },
    {
      "clientKey": "{clientKey}",
      "nickName": "Richard",
      "muteDate": "20220218011600"
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

TIP

✔️ 결과 코드는 코드 정의 > 결과 코드를 참조하세요.

# 채팅방 유저 추방(exileUser)

(opens new window)

# 1. API 기본 정보

요청 URL 메서드 응답 형식 설명
https://vchatcloud.com/openapi/v1/exiles/{roomId}/{clientKey} POST JSON 사용자 추방을 요청합니다.

# 2. 요청

# 헤더

요청 헤더명 설명 필수 여부
API_KEY 사용자 API KEY를 전달하는 헤더 Y
X-AUTH-TOKEN 접근 토큰을 전달하는 헤더 Y

# 변수

요청 변수명 타입 기본값 설명 필수 여부
roomId String 채팅방 아이디(채널키) Y
clientKey String 유저키 Y

# 3. 응답 결과

필드 타입 설명 필수 여부
result_cd Number 결과 코드 Y
result_msg String 결과 메시지 Y

# 4. 예시

# 요청

curl -X POST "https://vchatcloud.com/openapi/v1/exiles/{roomId}/{clientKey}"
     -H "API_KEY: {API_KEY}" 
     -H "X-AUTH-TOKEN: {X-AUTH-TOKEN}"
1
2
3

# 응답

{
  "result_cd": 1,
  "result_msg": ""
}
1
2
3
4

TIP

✔️ 결과 코드는 코드 정의 > 결과 코드를 참조하세요.

# 채팅방 유저 추방 해제(unexileUser)

(opens new window)

# 1. API 기본 정보

요청 URL 메서드 응답 형식 설명
https://vchatcloud.com/openapi/v1/exiles/{roomId}/{clientKey} PUT JSON 사용자 추방 해제를 요청합니다.

# 2. 요청

# 헤더

요청 헤더명 설명 필수 여부
API_KEY 사용자 API KEY를 전달하는 헤더 Y
X-AUTH-TOKEN 접근 토큰을 전달하는 헤더 Y

# 변수

요청 변수명 타입 기본값 설명 필수 여부
roomId String 채팅방 아이디(채널키) Y
clientKey String 유저키 Y

# 3. 응답 결과

필드 타입 설명 필수 여부
result_cd Number 결과 코드 Y
result_msg String 결과 메시지 Y

# 4. 예시

# 요청

curl -X PUT "https://vchatcloud.com/openapi/v1/exiles/{roomId}/{clientKey}" 
     -H "API_KEY: {API_KEY}" 
     -H "X-AUTH-TOKEN: {X-AUTH-TOKEN}"
1
2
3

# 응답

{
  "result_cd": 1,
  "result_msg": ""
}
1
2
3
4

TIP

✔️ 결과 코드는 코드 정의 > 결과 코드를 참조하세요.

# 채팅방 글쓰기 제한 유저 조회(listMuteUser)

(opens new window)

# 1. API 기본 정보

요청 URL 메서드 응답 형식 설명
https://vchatcloud.com/openapi/v1/mute/{roomId} GET JSON 글쓰기 제한된 사용자 목록과 상세 정보를 요청합니다.

# 2. 요청

# 헤더

요청 헤더명 설명 필수 여부
API_KEY 사용자 API KEY를 전달하는 헤더 Y
X-AUTH-TOKEN 접근 토큰을 전달하는 헤더 Y

# 변수

요청 변수명 타입 기본값 설명 필수 여부
roomId String 채팅방 아이디(채널키) Y

# 3. 응답 결과

필드 타입 설명 필수 여부
list List 채팅방 글쓰기 제한 유저 리스트 Y

# listMuteUser list

필드 타입 설명 필수 여부
clientKey String 유저 키 Y
nickName String 유저 대화명 Y
muteDate String 추방 날짜 Y

# 4. 예시

# 요청

curl -X GET "https://vchatcloud.com/openapi/v1/mute/{roomId}" 
     -H "API_KEY: {API_KEY}" 
     -H "X-AUTH-TOKEN: {X-AUTH-TOKEN}"
1
2
3

# 응답

{
  "result_cd": 1,
  "result_msg": "",
  "list": [
    {
      "clientKey": "{clientKey}",
      "nickName": "Richard",
      "muteDate": "20210610140000"
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11

TIP

✔️ 결과 코드는 코드 정의 > 결과 코드를 참조하세요.

# 채팅방 유저 글쓰기 제한(muteUser)

(opens new window)

# 1. API 기본 정보

요청 URL 메서드 응답 형식 설명
https://vchatcloud.com/openapi/v1/mute/{roomId}/{clientKey} POST JSON 사용자 글쓰기 제한을 요청합니다.

# 2. 요청

# 헤더

요청 헤더명 설명 필수 여부
API_KEY 사용자 API KEY를 전달하는 헤더 Y
X-AUTH-TOKEN 접근 토큰을 전달하는 헤더 Y

# 변수

요청 변수명 타입 기본값 설명 필수 여부
roomId String 채팅방 아이디(채널키) Y
clientKey String 유저키 Y

# 3. 응답 결과

필드 타입 설명 필수 여부
result_cd Number 결과 코드 Y
result_msg String 결과 메시지 Y

# 4. 예시

# 요청

curl -X POST "https://vchatcloud.com/openapi/v1/mute/{roomId}/{clientKey}" 
     -H "API_KEY: {API_KEY}" 
     -H "X-AUTH-TOKEN: {X-AUTH-TOKEN}"
1
2
3

# 응답

{
  "result_cd": 1,
  "result_msg": ""
}
1
2
3
4

TIP

✔️ 결과 코드는 코드 정의 > 결과 코드를 참조하세요.

# 채팅방 유저 글쓰기 제한 해제(unmuteUser)

(opens new window)

# 1. API 기본 정보

요청 URL 메서드 응답 형식 설명
https://vchatcloud.com/openapi/v1/mute/{roomId}/{clientKey} PUT JSON 사용자 글쓰기 제한 해제를 요청합니다.

# 2. 요청

# 헤더

요청 헤더명 설명 필수 여부
API_KEY 사용자 API KEY를 전달하는 헤더 Y
X-AUTH-TOKEN 접근 토큰을 전달하는 헤더 Y

# 변수

요청 변수명 타입 기본값 설명 필수 여부
roomId String 채팅방 아이디(채널키) Y
clientKey String 유저키 Y

# 3. 응답 결과

필드 타입 설명 필수 여부
result_cd Number 결과 코드 Y
result_msg String 결과 메시지 Y

# 4. 예시

# 요청

curl -X PUT "https://vchatcloud.com/openapi/v1/mute/{roomId}/{clientKey}" 
     -H "API_KEY: {API_KEY}" 
     -H "X-AUTH-TOKEN: {X-AUTH-TOKEN}"
1
2
3

# 응답

{
  "result_cd": 1,
  "result_msg": ""
}
1
2
3
4

TIP

✔️ 결과 코드는 코드 정의 > 결과 코드를 참조하세요.

← 채팅 →

Copyright © 2020 | E7Works.Inc & JOYTUNE Corp.