# 채팅 API 명세

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

TIP

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

# 공지사항 보내기(sendNotice)

# 1. API 기본 정보

요청 URL	메서드	응답 형식	설명
https://vchatcloud.com/openapi/v1/notice/{roomId}	POST	JSON	공지사항 전송을 요청합니다.

# 2. 요청

# 헤더

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

# 변수

요청 변수명	타입	설명	필수 여부	비고
roomId	String	채팅방 아이디(채널키)	Y
nickName	String	유저 대화명	Y	50자 이내
notice	String	공지사항 메시지	Y	100자 이내

# 3. 응답 결과

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

# 4. 예시

# 요청

curl -X POST "https://vchatcloud.com/openapi/v1/notice/{roomId}"
     -H "API_KEY: {API_KEY}" 
     -H "X-AUTH-TOKEN: {X-AUTH-TOKEN}" 
     -H "Content-Type: application/x-www-form-urlencoded"
     -d "nickName={nickName}&notice={notice}"

1
2
3
4
5

# 응답

{
  "result_cd": 1,
  "result_msg": ""
}

1
2
3
4

TIP

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

# 커스텀 메세지 보내기(sendCustom)

# 1. API 기본 정보

요청 URL	메서드	응답 형식	설명
https://vchatcloud.com/openapi/v1/custom/{roomId}	POST	JSON	커스텀 메시지를 전송 요청합니다.

# 2. 요청

# 헤더

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

# 변수

요청 변수명	타입	기본값	설명	필수 여부	비고
roomId	String		채팅방 아이디(채널키)	Y
jsonString	jsonString		JSON 메시지	Y
nickName	String		유저 대화명	Y	50자 이내
sendDate❔	String	null	전송일시	△	`YYYYMMDDHH24MISS`

# 3. 응답 결과

필드	타입	설명	필수 여부
result_cd	Number	결과 코드	Y
result_msg	String	결과 메시지	Y
data	Object	응답 데이터	△

# sendCustom data

필드	타입	설명	필수 여부
scheduleId	String	커스텀 메시지 예약번호	△

# 4. 예시

# 요청, 즉시 전송

curl -X POST "https://vchatcloud.com/openapi/v1/custom/{roomId}"
     -H "API_KEY: {API_KEY}" 
     -H "X-AUTH-TOKEN: {X-AUTH-TOKEN}" 
     -d "jsonString={jsonString}&nickName={nickName}"
     or
     -d "jsonString={jsonString}&nickName={nickName}&sendDate="

1
2
3
4
5
6

# 응답, 즉시 전송

{
  "result_cd": 1,
  "result_msg": "",
  "data": {
    "scheduleId": "S00000000000000" // 즉시전송 scheduleId: S00000000000000
  }
}

1
2
3
4
5
6
7

# 요청, 예약 전송

curl -X POST "https://vchatcloud.com/openapi/v1/custom/{roomId}"
     -H "API_KEY: {API_KEY}" 
     -H "X-AUTH-TOKEN: {X-AUTH-TOKEN}" 
     -d "jsonString={jsonString}&nickName={nickName}&sendDate={sendDate}"

1
2
3
4

# 응답, 예약 전송

{
  "result_cd": 1,
  "result_msg": "",
  "data": {
    "scheduleId": "S00000000000107" // 예약전송 scheduleId: S+숫자 14자리
  }
}

1
2
3
4
5
6
7

TIP

✔️ sendDate는 참고사항을 참조하세요.
✔️ 결과 코드는 코드 정의 > 결과 코드를 참조하세요.

# 커스텀 메세지 취소 시키기(cancelCustom)

# 1. API 기본 정보

요청 URL	메서드	응답 형식	설명
https://vchatcloud.com/openapi/v1/custom/{roomId}/{scheduleId}	DEL	JSON	커스텀 메시지 전송 취소를 요청합니다.

# 2. 요청

# 헤더

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

# 변수

요청 변수명	타입	기본값	설명	필수 여부
roomId	String		채팅방 아이디(채널키)	Y
scheduleId	String		커스텀 메시지 예약번호	Y

# 3. 응답 결과

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

# 4. 예시

# 요청

curl -X DELETE "https://vchatcloud.com/openapi/v1/custom/{roomId}/{scheduleId}"
     -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

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

# 귓속말 보내기(sendWhisperMessage)

# 1. API 기본 정보

요청 URL	메서드	응답 형식	설명
https://vchatcloud.com/openapi/v1/whisper/{roomId}/{clientKey}	POST	JSON	귓속말 전송을 요청합니다.

# 2. 요청

# 헤더

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

# 변수

요청 변수명	타입	설명	필수 여부	비고
roomId	String	채팅방 아이디(채널키)	Y
clientKey	String	유저키	Y
nickName	String	유저 대화명	Y	50자 이내
message	String	귓속말 메시지	Y	100자 이내

# 3. 응답 결과

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

# 4. 예시

# 요청

curl -X POST "https://vchatcloud.com/openapi/v1/whisper/{roomId}/{clientKey}"
     -H "API_KEY: {API_KEY}" 
     -H "X-AUTH-TOKEN: {X-AUTH-TOKEN}" 
     -H "Content-Type: application/x-www-form-urlencoded"
     -d "nickName={nickName}&message={message}"

1
2
3
4
5

# 응답

{
  "result_cd": 1,
  "result_msg": ""
}

1
2
3
4

TIP

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

← 사용자 관리 코드정의 →