대량 사용자 관리 API

일괄 사용자 관리 API를 사용하면 json 파일의 콘텐츠를 사용하여 한 번의 작업으로 여러 사용자를 만들거나 수정할 수 있습니다.

업로드할 수 있는 레코드 수에는 제한이 없지만 요청은 더 작은 배치로 실행하는 것이 좋습니다.

이 프로세스는 일괄 사용자 관리의 안내에 따라 CCAI Platform 포털에서도 실행할 수 있습니다.

사용자 일괄 동기화 도구 참조 애플리케이션은 Google Workspace 그룹 또는 Microsoft Entra ID와 같은 디렉터리와 CCaaS 간에 사용자 동기화를 실행하도록 제공됩니다. 이 참조 애플리케이션은 대량 사용자 관리 API를 활용합니다.

역할 및 권한

일괄 사용자 관리 API를 사용하려면 API 호출이 두 번 필요합니다. 하나는 JSON 파일을 업로드하고 작업을 만들고 다른 하나는 이를 처리합니다. 선택적 API 호출을 사용하여 작업이 올바르게 처리되도록 할 수도 있습니다.

선택사항: JSON 템플릿을 가져옵니다. 이렇게 하면 이전 템플릿을 가져온 이후에 생성된 추가 역할이나 팀이 포함된 최신 템플릿이 검색됩니다. Google에서는 이 단계를 권장합니다.
선택사항: 사용자 구성 데이터 가져오기 이렇게 하면 미러링할 모든 사용자 (이메일 주소를 지정한 경우 단일 사용자)의 목록이 검색됩니다.
json 파일 업로드 파일에서 한 명 이상의 사용자를 추가하거나 업데이트할 수 있습니다. 작업 ID를 기록해 둡니다.
json 파일의 요청 처리 그러면 대량 작업이 시작됩니다.
선택사항: 상태 확인을 받습니다. 작업 ID를 제공하여 처리 상태를 확인합니다.
선택사항: 업데이트된 작업 목록을 가져옵니다. 모든 대량 사용자 관리 작업 목록을 가져옵니다.
선택사항: 스키마 오류 로그를 가져옵니다. 스키마 오류 로그를 가져올 작업 ID를 지정합니다.
선택사항: 오류 가져오기 오류를 가져옵니다.

사용	json 파일 업로드
URL	apps/api/v1/bulk/users/upload
메서드	POST / PUT
요청	content-type: multipart/form-data `{ "id" : {job_id} #optional. Required in case of PUT method. "file": {json file} }`
응답	헤더: `Link: http://ujet.co/apps/api/v1/bulk/users_jobs/12345` 본문 `{ "id": 12345, # job_id "status": "created" "link": "http://ujet.co/apps/api/v1/bulk/users_jobs/12345" }`

사용	템플릿
URL	apps/api/v1/bulk/users/template
메서드	GET
요청	(비어 있음)
응답	`[ { "email":"user1@yourcompany.co", "new_email":user1@yourcompany.cx", "agent_number":"A-001", "first_name":"John", "last_name":"aa", "status":"Active", "location":"Mexico", "max_chat_limit":2, "max_chat_limit_enabled":0, "roles": [ {"name":"Admin","value": 0 }, {"name":"Manager","value": 1 }, {"name":"Agent","value": 0 }, {"name":Developer","value": 1 } ] }, ... ]`

사용자를 비활성화하려면 status 값을 Inactive로 변경합니다(예: "status":"Inactive").

사용	현재 json 파일의 처리를 요청합니다.
URL	/v1/bulk/users/proceed
메서드	POST
요청	`{ "id": 12345 # job_id }`
응답	헤더: `Link: http://ujet.co/apps/api/v1/bulk/users_jobs/12345` 본문 `1{"id": 12345 # job_id3 "status": "valid_scheme",4 "link": "http://ujet.co/apps/api/v1/bulk/users_jobs/12345"5}`

사용	상태 확인
URL	apps/api/v1/bulk/users/jobs/#{job_id}
메서드	GET
요청	경로 변수 - `job_id`
응답	`{ "id": 12345, "created_at": "2022-01-07T06:40:34.000Z", "process_requested_at": "2022-01-07T06:45:34.000Z", "filename": "100row.json", "total_rows": 100, "affected_rows": 52, "failed_rows": 0, "status": "in_progress", "uploaded_user_name": null, "proceed_user_name": null, "uploaded_api_user_name": "api_user_name_1", "proceed_api_user_name": "api_user_name_2", "scheme_errors": [] "update_errors": [] }`

사용	업데이트 작업 목록 가져오기
URL	apps/api/v1/bulk/users/jobs
메서드	GET
요청	`{ "page": 1, "per_page": 20 }`
응답	헤더 `Link: <next link> Total: 12345 Per-Page: 201` 본문 `[ { "id": 12345, "created_at": "2022-01-07T06:21:10.000Z", "process_requested_at": "2022-01-07T06:22:25.000Z", "filename": "100row.json", "total_rows": 100, "affected_rows": 52, "failed_rows": 0, "status": "in_progress", "uploaded_user_name": null, "proceed_user_name": null, "uploaded_api_user_name": "api_user_name_1", "proceed_api_user_name": "api_user_name_2", "scheme_errors": [], "update_errors": [] }, ... ]`
참고	출력은 job_id의 역순으로 정렬되므로 가장 최근 데이터가 먼저 표시됩니다.

사용	스키마 오류 로그 가져오기
URL	/v1/bulk/users/errors/scheme/#{job_id}
메서드	GET
요청	경로 변수 - `job_id`
응답	content-type: application/json `[ { "message": "Must be a valid email", "column": 1, "row": null }, { "message": "Non-empty string", "column": 10, "row": 10 } ]`

사용	업데이트 오류 로그 가져오기
URL	/v1/bulk/users/errors/update/#{job_id}
메서드	GET
요청	경로 변수 - job_id
응답	content-type: application/json `1[2 {3 "message": "Must be a valid email",4 "column": 1,5 "row": null,6 "error_type": "warning"7 },8 {9 "message": "Non-empty string",10 "column": 10,11 "row": 10,12 "error_type": "error"13 } 14]`