Important
- 이 기능은 생산 환경에서 사용 가능한 미리 보기 기능입니다.
- 생산 준비 완료된 미리 보기 버전은 추가 이용 약관에 따릅니다.
[이 문서는 시험판 설명서이며 변경될 수 있습니다.]
오류 메시지가 일관되고 이해하기 쉽도록 오류 응답을 표준화해야 합니다. 다음 표에서는 응답 본문에 필요한 오류 개체에 대한 스키마를 보여줍니다.
| 이름 | 데이터 형식 | 필수 | Description |
|---|---|---|---|
| errorCode | String | 예 | 짧고 식별하기 쉬운 오류 범주입니다. |
| errorMessage | String | No | 오류에 대한 자세한 내용은 개발자에게 친숙한 메시지입니다. |
| activityId | String | No | 요청의 고유 식별자 |
| details | Object | No | 오류에 대한 자세한 정보입니다. 내용은 오류 유형에 따라 달라질 수 있습니다. 다음 예제에서는 사용자에게 올바른 권한이 없는 경우를 보여 줍니다. { |
다음 표에는 몇 가지 시나리오와 예상되는 오류 코드가 나열되어 있습니다.
| 시나리오 | 오류 코드 | HTTP 상태 코드 |
|---|---|---|
| 사용자가 연결된 CRM(고객 관계 관리) 시스템이 입력에 지정된 시스템과 다릅니다. | CRM 연결 오류 | 400 |
| CRM 레코드 시스템을 찾을 수 없거나 삭제되었습니다. | 기록을 찾을 수 없음 | 404 |
| 사용자가 인증되지 않았습니다. (이 시나리오는 일반적으로 토큰이 만료될 때 발생합니다.) | 지정된 토큰이 잘못되었습니다 | 401 |
| 사용자에게 작업을 수행할 수 있는 권한이 없습니다. (즉, 사용자에게 권한이 부족합니다.) | INSUFFICIENT_PERMISSIONS | 403 |
| 커넥터에 너무 많은 요청이 전송되었습니다. | REQUEST_THROTTLED | 429 |
| 처리되지 않은 서비스 오류가 발생했습니다. | 내부_서버_오류 | 500 |