최종 사용자 엔드포인트

최종 사용자 API 엔드포인트는 최종 사용자 객체에 대한 액세스를 제공합니다. Contact Center AI Platform (CCAI Platform)의 각 최종 사용자에 대해 최종 사용자 객체가 생성됩니다.

다음은 호출 API 엔드포인트입니다.

최종 사용자 업데이트

이 엔드포인트를 사용하면 다음을 포함한 최종 사용자 세부정보를 업데이트할 수 있습니다.

  • 이메일 주소

  • name

  • 전화번호

{
    "identifier": "string",
    "email": "string",
    "name": "string",
    "phone": "string"
}

엔드포인트:

Method: POST
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/end_users

헤더:

키 값 설명
Content-Type application/json
수락 application/json

본문:

{
    "identifier": "abc123",
    "email": "joe@mydomain.com",
    "name": "Joe Smith",
    "phone": "+16171231234"
}

요청 및 응답 예시

다음 섹션에서는 엔드포인트에 대한 요청의 예를 제공합니다.

최종 사용자 ID 및 식별자

이 예시에서는 ID를 제공하여 최종 사용자를 업데이트하는 방법을 보여줍니다.

요청

헤더:

키 값 설명
Content-Type application/json

본문:

{
    "identifier": "string",
    "email": "string",
    "name": "string",
    "phone": "string"
}
응답
{
    "id": "integer",
    "identifier": "string"
}

상태 코드: 200

최종 사용자 가져오기

이 엔드포인트는 id 또는 identifier를 사용하여 최종 사용자를 검색하는 기능을 제공합니다.

엔드포인트:

Method: GET
Type:
URL: https://{subdomain}.{domain}/apps/api/v1/end_users

헤더:

키 값 설명
Content-Type application/json

질문:

키 값 설명
id 정수 최종 사용자의 내부 ID
identifier 문자열 최종 사용자의 외부 식별자

요청 및 응답 예시

다음 섹션에서는 엔드포인트에 대한 요청의 예를 제공합니다.

ID로 가져오기

이 예시에서는 ID를 제공하여 최종 사용자를 검색하는 방법을 보여줍니다.

요청

헤더:

키 값 설명
Content-Type application/json

질문:

키 값 설명
id 정수 최종 사용자의 내부 ID
응답
{
    "id": "integer",
    "identifier": "string"
}

상태 코드: 200

식별자로 가져오기

이 예시에서는 식별자를 제공하여 최종 사용자를 가져오는 방법을 보여줍니다.

요청

헤더:

키 값 설명
Content-Type application/json

질문:

키 값 설명
identifier 문자열 최종 사용자의 외부 식별자
응답
{
    "id": "integer",
    "identifier": "string"
}

상태 코드: 200