콘텐츠로 이동

기본 설정 상태 수정



POST /api/v1/account/status/modify

개요

현재 호출 자격의 온콜 상태 값 수정을 요청합니다. 현재 표준 API Key 진입점에는 자격 적합성 제한이 존재합니다.

호출 전 및 사용 단계

이 경로는 현재 호출 자격의 온콜/휴가 상태를 위한 것으로, 워크스페이스 멤버 관리나 계정 활성화/비활성화가 아닙니다. 다른 계정을 지정할 수 있는 accountUUID 파라미터는 없습니다.

현재 표준 DF-API-KEY 호출에는 자격 적합성 제한이 있습니다. 일반 워크스페이스 Key와 개인 Key의 현재 actor는 모두 Key UUID이지만, 상태를 처리하는 비즈니스 조회는 계정 UUID로 읽습니다. 따라서 정상 Key는 일반 계정에 매칭되지 않아 보통 500을 반환하며, working/mute를 변경하거나 역할 권한을 높이거나 워크스페이스 Key를 개인 Key로 교체하는 것으로는 해결할 수 없습니다. 이 페이지는 호환성 점검을 위해 공개 경로와 선언을 유지하며, 위조된 200 성공 예시를 제공하지 않습니다. 콘솔의 개인 계정 기능을 사용하거나, 서버 측에서 이 진입점을 수정한 후에 자동 전환을 연동하시기 바랍니다.

요청 필드는 accountStatus만 선언하며, 계정 UUID를 추가로 제출하거나 인증 헤더를 교체하여 이 제한을 우회할 수 없습니다. 오류 발생 시 traceId를 기록하고 관리자에게 문의하며, 자동 반복 재시도를 피하시기 바랍니다. Front 계정 로그인 세션 인터페이스는 다른 자격 체계를 사용하므로, 그 성공 동작이 이 OpenAPI Key 진입점의 사용 가능성을 의미하지 않습니다. 과거 사용자 정의 데이터나 내부 직접 호출도 일반적인 성공 계약으로 간주할 수 없습니다.

요청 헤더

파라미터명 타입 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예시: <DF-API-KEY>
획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 획득합니다.

Body 요청 파라미터

파라미터명 타입 필수 설명
accountStatus string Y 필수 문자열이며 빈 문자열을 허용하고, 열거/길이 제한이 없다고 선언합니다. 하지만 빈 값/임의의 문자열로는 현재 Key 호출이 성공하지 않습니다. 이 값은 계정 활성화/비활성화 status도 아닙니다.
빈 문자열 허용: True
null 허용: False
예시: working
획득 또는 입력 방법: 온콜 중에는 working, 휴가 중에는 mute를 사용합니다. 현재 Key 자격 제한은 값과 무관합니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/account/status/modify' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"accountStatus":"working"}'

응답

현재 표준 API Key 요청은 보통 HTTP 500과 아래 오류 JSON을 반환합니다. 이 페이지는 정상 Key로 얻을 수 있는 200 계정 상세를 확인하지 못했으므로, 연동 전에 자격 적합성 제한을 먼저 해결해야 합니다.

필드 타입 설명
code integer 현재 자격 적합성 실패 시 보통 500입니다. 파라미터/인증 오류는 실제 HTTP와 외곽 구조에 따라 반환됩니다.
content object 이 페이지의 500 예시는 빈 객체 {}이며, 계정 상세가 아닙니다.
errorCode string 이 문제는 보통 ft.InternalServerError입니다. 그 외 인증/파라미터 오류는 오류 표와 공통 설명을 참고하십시오.
message string 호출자 대상 오류 텍스트로, 요청 언어에 따라 표시될 수 있습니다.
success boolean 현재 오류는 false이며, HTTP 연결 성공만으로 판단할 수 없습니다.
traceId string 문제 해결 상관 ID이며, 피드백 시 제공해 주십시오.
{
  "code": 500,
  "content": {},
  "errorCode": "ft.InternalServerError",
  "message": "内部错误",
  "success": false,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하십시오.

이 페이지는 현재 표준 OpenAPI 호출에서 관찰 가능한 실패 구조를 보여줍니다. Front 로그인 세션과 내부에서 계정 UUID를 직접 전달하는 성공 응답을 이 경로의 성공 예시로 가장하지 않았습니다. 과거의 비정상 계정/Key 데이터는 별도로 확인해야 합니다.

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방식
406 ft.ParameterValidationFailed 요청 필드 누락, 또는 필드 값이 선언된 검증 조건 위반 파라미터 파싱 실패 파라미터 위치, 필드명, 타입, 값을 확인하십시오.
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않음 요청 JSON 형식 오류 content.reason, line, column에 따라 JSON을 수정하십시오.
400 ft.JsonFormatError 요청 JSON 최상위가 객체가 아님 일부 json 파일 형식 오류 accountStatus를 포함한 JSON 객체를 제출하십시오.
500 ft.InternalServerError 정상 API Key의 actor가 일반 계정에 매칭되지 않아 빈 객체를 직접 업데이트; 또는 기타 미처리 저장소 오류 내부 오류 현재 진입점은 온콜 상태 자동 전환에 사용할 수 없습니다. 관리자에게 자격 적합성 처리를 요청하고 traceId를 보존하며, 무분별한 재시도를 중단하십시오.

문서 평가

이 페이지가 도움이 되었나요?