고객 데이터를 삭제하는 데 사용됩니다.
이 API를 사용하려면 오직 봇 관리자 콘솔에서 생성된 애플리케이션에서 만들어진 JWT가 필요합니다. 이 API를 사용하려면 앱은 봇 분석 아래에 있는 사용자 데이터 삭제의 관리자 API 범위가 필요합니다.
DELETE https://{{host}}/api/public/bot/eraseUsersData 참고 사항: 이 기능은 플랫폼의 v7.1에 도입되었습니다. 다음과 같은 경우 사용자 삭제가 처리되지 않습니다.
- 요청받은 사용자는 하나 이상의 계정에 속하지 않는 계정 소유자입니다.
- 요청받은 사용자는 봇 소유자이거나 하나 이상의 봇 공동 개발자입니다.
쿼리 매개 변수
| 매개 변수 | 설명 |
|---|---|
| host | 환경 URL(예: https://bots.kore.ai) |
본문 매개 변수
| 매개 변수 | 설명 |
|---|---|
| userIds |
세부 정보를 삭제해야 하는 사용자 ID의 배열입니다. 예: [“userId1”, “userId2”]. 사용자 이메일 ID 또는 엔터프라이즈에서 할당한 고유 ID가 될 수 있습니다. v7.3 이후 채널 사용자 ID도 사용할 수 있습니다. 이 필드에 사용할 수 있는 값은 다음과 같습니다.
|
| botIds | 사용자 세부 정보를 삭제해야 하는 봇 ID의 배열(예: [“botId1”, “botId2”]) |
| RemoveDataFromAllBots (선택 사항) | 지정된 사용자 세부 정보를 모든 봇에서 제거해야 하는지를 결정합니다. true 또는 false로 설정합니다. |
권한 부여
다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다: auth: {{JWT}}
콘텐츠 유형 응답
application/json
샘플 요청
curl -X POST \
https://{{host}}/api/public/bot/eraseUsersData\
-H 'Content-Type: application/json' \
-H 'auth: YOUR_JWT_ACCESS_TOKEN' \
-d '{
userIds: ["userId1","userId2","userId3"],
botIds: ["botId1","botId2","botId3"]
RemoveDataFromAllBots: true // optional
}'
샘플 응답
{
"requestId": "eud-123",
"status"”: "in-progress"
}