이메일 API

Xanadu API 참조

Release

xanadu

ft:locale

ko-KR

ft:publication_title

Xanadu API 참조

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

이메일 API

릴리스 버전: Xanadu

업데이트 날짜 2026년 01월 09일

읽기11분

이메일 API는 REST를 사용하여 이메일 메시지를 보내고 받을 수 있는 엔드포인트를 제공합니다.

사용자에게 이메일을 보내려면 email_api_send 역할이 있어야 합니다.

주:

이메일 [sys_email] 테이블에 대한 읽기/쓰기 액세스 권한이 없는 경우 오류가 발생할 수 있습니다.

이메일 - GET /now/email/{id}

지정된 이메일 기록에 대한 이메일 상세 정보를 반환합니다.

URL 형식

버전이 지정된 URL: /api/now/{api_version}/email/{id}

지원되는 요청 매개변수

표 1. 경로 매개변수
이름	설명
api_version	옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 `v1` 또는 `v2`입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다. 데이터 유형: 문자열
id	상세 정보를 반환할 이메일의 Sys_id입니다. 이메일 [sys_email] 테이블에 있습니다.

표 2. 쿼리 매개변수
이름	설명
sysparm_fields	응답에 반환할 쉼표로 구분된 필드 목록입니다. 데이터 유형: 문자열

표 3. 요청 본문 매개변수(XML 또는 JSON)
이름	설명
없음

헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

표 4. 요청 헤더
헤더	설명
수용	응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다. 기본값: application/json

표 5. 응답 헤더
헤더	설명
없음

상태 코드

다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

표 6. 상태 코드
상태 코드	설명
200	성공입니다. 요청이 성공적으로 처리되었습니다.
401	승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
403	기록을 찾을 수 없거나 요청하는 사용자에게 기록에 대한 액세스 권한이 없음을 나타냅니다. 사용자에게 적절한 역할 및 액세스 권한이 있는지 확인합니다.
500	내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

응답 본문 매개변수(JSON 또는 XML)


요소	설명
숨은 참조	이메일 메시지의 숨은 참조 수신자의 이메일 주소 목록입니다. blind_copied 필드에 매핑합니다. 데이터 유형: 배열
참조	이메일 메시지를 복사한 수신자의 이메일 주소 목록입니다. 복사된 필드에 매핑합니다. 데이터 유형: 배열
헤더	메시지와 연결된 헤더와 해당 값의 이름-값 쌍입니다. 데이터 유형: 객체
html	이메일 메시지의 HTML 지원 본문입니다. 본문 필드에 매핑합니다. 데이터 유형: 문자열
id	이메일 기록의 Sys_id입니다. 데이터 유형: 문자열
중요도	전자 메일 메시지의 중요도입니다. 중요도 필드에 매핑합니다. 데이터 유형: 문자열
상태	이메일 메시지의 처리 상태입니다. 시스템 예약된 작업에서 이메일 메시지를 처리했는지 여부를 나타냅니다. 값은 다음과 같습니다. 오류 무시됨 처리됨 준비 데이터 유형: 문자열
제목	이메일 메시지의 제목입니다. 제목 필드에 매핑합니다. 데이터 유형: 문자열
텍스트	이메일 메시지의 텍스트 전용 본문입니다. body_text 필드에 매핑합니다. 데이터 유형: 문자열
대상	이메일 메시지를 직접 받는 사람의 이메일 주소 목록입니다. 수신자 필드에 매핑됩니다. 데이터 유형: 배열
유형	수신 또는 발신 메일로서 전자 메일 메시지의 현재 상태입니다. 값은 다음과 같습니다. 받음 수신-무시됨 전송-실패 전송-무시됨 전송-준비 보냄 데이터 유형: 문자열

샘플 cURL 요청

curl "http://instance.servicenow.com/api/now/email/06e095427f0022007f005212bdfa91b3" \
--request GET \
--header "Accept:application/json" \
--user "user-name":"password"

{
  "result" : {
    "headers" : {
      "X-ServiceNow-SysEmail-Version" : "2",
      "X-ServiceNow-Source" : "Notification-24e34b54c61122aa0108c1b7a33697cf"
    },
    "cc" : [
      ""
    ],
    "type" : "send-ready",
    "html" : "<html><head></head><body><div><p><font size=\"5\" color=\"#808080\" face=\"helvetica\"><strong>Incident has been closed.</strong></font></p></div>\n\t\t<div><p><font size=\"4\" color=\"#808080\" face=\"helvetica\"><strong>Summary details</strong></font></p><p><font size=\"3\" color=\"#808080\" face=\"helvetica\">Closed by: System Administrator</font></p><p><font size=\"3\" color=\"#808080\" face=\"helvetica\">Closed notes: Fixed</font></p></div>\n\t\t<div><p><font size=\"3\" color=\"#808080\" face=\"helvetica\">You can view all the details of the incident by following the link below:</font></p><font face=\"helvetica\"><a href=\"incident.do?sys_id=e8e875b0c0a80164009dc852b4d677d5&amp;sysparm_stack=incident_list.do?sysparm_query=active=true\" style=\"background-color: #278efc;border: 1px solid #0368d4;color: #ffffff;font-size: 16px;font-family: Helvetica, Arial, sans-serif;text-decoration: none; border-radius: 3px;-webkit-border-radius: 3px;-moz-border-radius: 3px;display: inline-block;padding: 5px;\">Take me to the Incident</a></font><br /><br /><p><font size=\"3\" color=\"#808080\" face=\"helvetica\">Thank you.</font></p></div><div> </div><div style=\"display:inline\">Ref:MSG0000006</div></body></html>",
    "bcc" : [
      ""
    ],
    "subject" : "Your incident INC0000005 has been closed",
    "to" : [
      "alejandro.mascall@example.com"
    ],
    "state" : "ready",
    "id" : "06e095427f0022007f005212bdfa91b3",
    "importance" : "",
    "text" : ""
  }
}

이메일 - POST /now/email

전달된 정보를 사용하여 이메일 기록을 생성합니다.