3. 예약 메시지 취소

개요

예약 등록한 문자 메시지를 취소하는 방법입니다.

API Server URL: https://bizmsgapi.fingerpush.com/rest/mms/v1/cnclMms

발송 방법 및 전송/수신 파라미터 정의

HTTPS Headers

파라미터명	필수 여부	설명
Content-Type	필수	application/json
authorization	필수	Bearer {token} 토큰 발급 API에서 발급받은 JWT 토큰 값

HTTPS Parameters

SSL Protocol을 이용하여 파라미터들을 API Server에 전달합니다. API Server로 전달해야 할 파라미터들은 아래 표를 참조해 주세요.

[표 3.1] 문자 예약 취소 HTTPS, Parameters

파라미터명	필수 여부	Data Type	설명
msgIdx	필수	text(18)	캠페인 메시지 IDX

Request JSON Sample

{
  "msgIdx": "12345678910"
}

Response JSON

API서버에서 전달 받은 파라미터 처리 후 결과를 JSON 형태로 제공합니다.

{
  "code": "200",
  "message": "메시지발송 중지를 요청하였습니다."
}

[표 3.2] 발송 JSON 결과

값	설명
code	결과 코드
message	결과 메시지

처리결과에 따른 result 값은 아래와 같습니다.

[표 3.3] 발송 JSON 결과의 result code 유형

코드	내용	비고
200	정상처리 됨	취소 완료
401	접근 권한이 없습니다.	계정 서비스 권한 여부
4033	메시지에 대한 접근 권한이 없습니다.	문자 메시지 정보 없음
4035	유효한 호출이 아닙니다.	인증 토큰 누락
4036	유효한 호출이 아닙니다.	인증 토큰 만료
4037	유효한 호출이 아닙니다.	화이트리스트에 존재하지 않는 IP
500	서버 에러	결과 메시지 참고
503	필수 값이 없습니다.	결과 메시지 참고 - 이미 발송 완료된 메시지 입니다. - 이미 발송중인 메시지이므로 취소 하실 수 없습니다. - 이미 발송 실패한 메시지이므로 취소 하실 수 없습니다. - 현재 일시 정지 처리 중이므로 취소 하실 수 없습니다. - 일시 정지가 완료된 후 다시 시도해 주세요.