For the complete documentation index, see llms.txt. This page is also available as Markdown.

문의

채팅방 목록 조회

get

채팅방 목록을 조회합니다.

필터

  • ALL: 전체 채팅방

  • UNREAD: 읽지 않은 메시지가 있는 채팅방

  • UNANSWERED: 진행 중인 세션이 있는 채팅방 (셀러가 답변하지 않은 상태가 아닌, 세션이 on-going인 상태)

페이징

  • page 파라미터를 사용한 offset 페이징을 지원합니다.

  • size는 최대 100까지 지정할 수 있습니다. (기본값: 20)

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
filterstring · enumOptional

필터

Default: ALLExample: ALLPossible values:
pageinteger · int32Optional

페이지 번호 (0부터 시작, offset 페이징)

Default: 0Example: 0
sizeinteger · int32Optional

페이지 크기

Default: 20Example: 20
partnerNamestringOptional

연동 프로그램명 또는 자사 서비스명

Example: 토스쇼핑
Responses
200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

application/json
resultTypestring · enumOptional

응답 결과 타입

Possible values:
get
/api/v3/shopping-fep/business-chat/rooms
200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

메시지 목록 조회

get

채팅방의 메시지 목록을 조회합니다.

페이징

  • before 파라미터를 사용한 커서 기반 페이징을 지원합니다.

  • before가 0이면 최신 메시지부터 조회합니다.

  • limit는 최대 100까지 지정할 수 있습니다. (기본값: 20)

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
roomIdinteger · int64Required

채팅방 ID

Example: 1
Query parameters
beforeinteger · int64Optional

이 메시지 ID 이전의 메시지 조회 (0이면 최신 메시지부터 조회)

Default: 0Example: 0
limitinteger · int32Optional

조회 건수

Default: 20Example: 20
partnerNamestringOptional

연동 프로그램명 또는 자사 서비스명

Example: 토스쇼핑
Responses
200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

application/json
resultTypestring · enumOptional

응답 결과 타입

Possible values:
get
/api/v3/shopping-fep/business-chat/rooms/{roomId}/messages
200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

답변 등록

post

메시지를 전송합니다.

메시지 전송 시 해당 메시지까지 자동 읽음 처리됩니다.

메시지 내용

  • text: 텍스트 메시지 (최대 500자)

  • imageUrls: 이미지 URL 목록 (최대 10개)

  • 텍스트 또는 이미지 중 하나는 필수입니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
partnerNamestringOptional

연동 프로그램명 또는 자사 서비스명

Example: 토스쇼핑
Body
roomIdinteger · int64Required

채팅방 ID

Example: 1
Responses
200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

application/json
resultTypestring · enumOptional

응답 결과 타입

Possible values:
post
/api/v3/shopping-fep/business-chat/messages
200

모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)

API 연동 중 문의사항이나 개선 제안이 있으신가요?

토스쇼핑 API 연동에 대한 질문이나, 건의사항이 있다면 연동/개발 문의에 남겨주세요. 다른 유저의 문의를 참고하거나, 토스쇼핑 담당자와 질의를 주고 받을 수 있어요.

마지막 업데이트

도움이 되었나요?