취소

POST https://api.pushwoosh.com/messaging/v2/cancel

이전에 생성된 메시지를 message_code로 식별하여 취소합니다. 메시지가 다음 상태 중 하나일 때만 취소가 가능합니다:

pending: 생성되었지만 아직 전송을 위해 선택되지 않았습니다.
waiting: 미래의 전송 시간으로 예약되었습니다.
processing: 현재 배달을 위해 준비 중입니다.

메시지가 여전히 취소 가능한 상태인지 확인하려면 메시지 상태 확인을 참조하십시오.

요청

Authorization: Token <API_TOKEN> 헤더에 서버 API 토큰으로 인증합니다.

필드	유형	필수	설명
`message_code`	문자열	예	취소할 메시지의 메시지 코드로, `Notify`에서 `result.message_code`로 반환됩니다.

요청 예시

curl -X POST https://api.pushwoosh.com/messaging/v2/cancel \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "message_code": "XXXX-XXXXXXXX-XXXXXXXX"
  }'

응답

성공 시, 빈 JSON 본문과 함께 HTTP 200을 반환합니다.

{}

오류

오류는 표준 gRPC-Gateway 오류 봉투(envelope)를 사용합니다: { "code": ..., "message": ..., "details": [...] }.

HTTP 상태	조건
`400`	`message_code`가 누락되었습니다.
`400`	메시지가 취소 가능한 상태가 아닙니다 (더 이상 `pending`, `waiting` 또는 `processing`이 아님).
`403`	메시지가 다른 계정에 속해 있습니다.
`404`	주어진 `message_code`에 대한 메시지가 존재하지 않습니다.
`500`	메시지를 로드하거나 취소를 게시하는 동안 내부 오류가 발생했습니다. 요청을 재시도하십시오.

예시

더 이상 존재하지 않는 메시지를 취소하면 HTTP 404가 반환됩니다:

{
  "code": 5,
  "message": "message not found",
  "details": []
}

메시지 상태 확인

취소하기 전에 메시지가 여전히 취소 가능한 상태인지 확인할 수 있습니다. Control Panel의 메시지 테이블에서 상태 열을 읽는 것 외에도(캠페인 → 일회성 메시지), messages:list를 사용하여 프로그래밍 방식으로 상태를 쿼리할 수 있습니다:

filters.messages_codes 배열에 message_code를 전달합니다 (필수적인 filters.application과 함께).
items[]에서 일치하는 항목의 status 필드를 읽습니다.

취소

요청

요청 예시

응답

오류

메시지 상태 확인

관련 항목