superplace
Developers
superplace API

손님에게 발송한 문자·알림톡과 내게 온 알림을 조회합니다.


발송 메시지 목록 조회

GET
https://api.superplace.so
/msg/v1/messages
OAuth 2.0

손님에게 발송한 알림톡, 문자 등을 발송 상태와 함께 돌려줍니다. 기본은 최신순입니다. 메시지마다 채널(channel), 받는 주소(to), 실제 발송된 문안(body), 상태(status)가 있습니다. 상태는 QUEUED(대기), SENT(발송), DELIVERED(도착), FAILED(실패) 중 하나입니다.

MCP 도구: msg_get_messages

발송 메시지 목록 조회 › query Parameters

page
​integer · min: 1

페이지 번호입니다. 1부터 시작합니다.

perPage
​integer · min: 1 · max: 200

한 페이지에 담을 건수입니다. 생략하면 서버 기본값이 적용됩니다.

start
​integer · min: 0

범위 조회의 시작 위치입니다. end와 함께 보내며, page·perPage를 함께 보내면 무시됩니다.

end
​integer · min: 0

범위 조회의 끝 위치입니다. 이 값은 포함되지 않습니다. 한 번에 200건까지 조회할 수 있습니다.

sort
​string · enum

정렬 기준입니다. 기본은 createdAt입니다. to는 받는 주소 순, status는 대기, 발송, 도착, 실패 순입니다. 같은 값끼리는 최신순입니다.

Enum values:
createdAt
to
status
Default: createdAt
order
​string · enum

정렬 방향입니다. 기본은 desc입니다. status를 desc로 정렬하면 실패한 메시지가 맨 위입니다.

Enum values:
asc
desc
Default: desc
filter
​string

조건 JSON입니다. status, channel, templateSlug, to, placeId, eventType, eventId, createdAt({"gte":…,"lte":…}, RFC3339)를 쓸 수 있습니다. 예: {"status":"FAILED"}

발송 메시지 목록 조회 › Responses

요청이 처리됐습니다. 결과는 data에 담겨 옵니다.

success
​enum · required
Enum values:
data
​array · required
total
​integer · required

내 알림 목록 조회

GET
https://api.superplace.so
/msg/v1/my/notifications
OAuth 2.0

내게 온 알림을 최신순으로 돌려줍니다. 알림마다 범위(scope), 채널, 제목, 내용, 상태, 읽은 시각이 있습니다.

MCP 도구: msg_get_my_notifications

내 알림 목록 조회 › query Parameters

start
​integer · min: 0

범위 조회의 시작 위치입니다. end와 함께 보내며, page·perPage를 함께 보내면 무시됩니다.

end
​integer · min: 0

범위 조회의 끝 위치입니다. 이 값은 포함되지 않습니다. 한 번에 200건까지 조회할 수 있습니다.

내 알림 목록 조회 › Responses

요청이 처리됐습니다. 결과는 data에 담겨 옵니다.

success
​enum · required
Enum values:
​object[] · required
total
​integer · required