소명 템플릿 설정

현재 세션이 속한 테넌트의 특정 소명 템플릿을 설정합니다.

필요 권한

마스터 계정으로 이용할 수 있습니다.

HTTP 요청

POST /api/sonar/push-templates/:type

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     -d template="$emp_name $emp_title님, 메일함에서 소명 요청을 확인해주세요." \
     -X POST \
     https://HOSTNAME/api/sonar/push-templates/sms_explain_req_msg

요청 매개변수

키	필수	타입	설명	비고
type	O	문자열	템플릿 유형	하단 표 참조
template	X	문자열	템플릿 내용	최대 16MB, 미지정 시 null 초기화

템플릿 유형은 아래의 키를 사용할 수 있습니다:

템플릿 유형	설명
explanation_domain	소명 제출 도메인. https://DOMAIN 형태
mail_explain_req_subject	소명 요청 메일의 제목
mail_explain_req_body	소명 요청 메일의 본문
mail_explain_review_req_subject	소명 검토 요청 메일의 제목
mail_explain_review_req_body	소명 검토 요청 메일의 본문
sms_explain_req_msg	소명 요청 알림 SMS
sms_explain_review_req_msg	소명 검토 요청 SMS

템플릿 내용에는 아래의 매크로를 사용할 수 있습니다:

매크로	설명
$category	분류
$emp_key	소명자 사번
$emp_name	소명자 성명
$emp_title	소명자 직급
$url	소명 제출 URL
$expire_date	소명 제출 마감일 (yyyy-MM-dd)
$expire_time	소명 제출 마감시각 (HH:mm:ss)
$user_note	수동 소명 요청 시 설명

정상 응답

{}

오류 응답

지원하지 않는 템플릿 유형인 경우

HTTP 상태 코드 400 응답

{
    "error_code": "invalid-argument",
    "error_msg": "type should be one of explanation_domain, mail_explain_req_subject, mail_explain_req_body, mail_explain_review_req_subject, mail_explain_review_req_body, sms_explain_req_msg, sms_explain_review_req_msg."
}

설정 권한이 없는 경우

HTTP 상태 코드 500 응답

{
    "error_code": "illegal-state",
    "error_msg": "no-permission"
}