쪽지 목록 조회

HTTP request

GET /note/list HTTP/1.1
Authorization: "access token"
Accept: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 186

[ {
  "id" : 1,
  "targetId" : 2,
  "name" : "닉네임",
  "contents" : "하이",
  "mine" : true,
  "publishedAt" : "2023. 06. 19. 17:21",
  "checked" : false,
  "deleteStatus" : 0
} ]

Response fields

Path Type Description

[].id

Number

쪽지 고유번호

[].targetId

Number

상대방 고유번호

[].name

String

상대방 닉네임

[].contents

String

마지막 쪽지 내용

[].mine

Boolean

마지막 쪽지 전송자 구분

[].publishedAt

String

마지막 쪽지 전송 일시

[].checked

Boolean

마지막 전송된 쪽지 읽은 상태 분류

[].deleteStatus

Number

게시글 등록일

쪽지 내역 조회

HTTP request

GET /note/history/1 HTTP/1.1
Authorization: "access token"
Accept: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 123

[ {
  "id" : 1,
  "mine" : true,
  "contents" : "하이",
  "publishedAt" : "2023. 06. 19. 17:21",
  "deleteStatus" : 0
} ]

Response fields

Path Type Description

[].id

Number

쪽지 대화 내역 고유번호

[].mine

Boolean

쪽지 전송자 구분

[].contents

String

내용

[].publishedAt

String

마지막 쪽지 전송 일시

[].deleteStatus

Number

게시글 등록일

쪽지 전송

HTTP request

POST /note/send HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: "access token"
Accept: application/json
Content-Length: 52
Host: localhost:8080

{
  "targetId" : 1,
  "contents" : "쪽지 내용"
}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 20

{
  "status" : 200
}

Response fields

Path Type Description

status

Number

응답 상태코드

쪽지 읽음 처리

HTTP request

PATCH /note/checked/1 HTTP/1.1
Authorization: "access token"
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 20

{
  "status" : 200
}

Response fields

Path Type Description

status

Number

응답 상태코드

쪽지 내역 삭제

HTTP request

DELETE /note/history/1 HTTP/1.1
Authorization: "access token"
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 20

{
  "status" : 200
}

Response fields

Path Type Description

status

Number

응답 상태코드