API를 통한 세션 중간 인증

이 페이지에서는 SDK 채널에서 세션 중 인증을 위해 통화 및 채팅 API 엔드포인트를 사용하는 방법을 설명합니다.

사용자는 인증 없이 지원 채팅과 같은 지원 세션을 시작할 수 있습니다. 최종 사용자 인증이 필요하면 인증 흐름을 시작할 수 있습니다. 인증에 성공하면 end_user 식별자를 업데이트하여 세션을 인증된 최종 사용자에 연결할 수 있습니다.

URI 및 인증

이 새 엔드포인트의 기본 URI는 comm_type에 따라 다릅니다.

call comm_type의 경우:

POST https://<subdomain>.<domain>/apps/api/v1/calls/:call_id/end_user

chat comm_type의 경우:

POST https://<subdomain>.<domain>/apps/api/v1/chats/:chat_id/end_user

API 작업

다음 섹션에서는 API 작업에 대한 세부정보를 확인할 수 있습니다.

매개변수

API 요청 본문에는 다음 필드가 있어야 합니다.

ID	필드 이름	유형	필수 여부	설명	예시 값
0	identifier	문자열	예	제공된 고유한 외부 식별자입니다.
1	name	문자열	없음	상호작용과 연결된 일반 이름 또는 식별자입니다. 고객 조회에 도움이 됩니다.	John Doe
2	email	문자열	없음	상호작용과 연결된 일반 이메일 주소입니다. 고객 조회에 도움이 됩니다.	[e-mail]
3	phone	문자열	없음	상호작용과 연결된 일반 전화번호입니다. 고객 조회에 도움이 됩니다.	123-456-7890

API 샘플

다음 섹션에서는 샘플 API 요청 및 응답을 확인할 수 있습니다.

성공 응답 샘플

202 Accepted

{
 "message": "accepted"
}

실패 응답 샘플

다음 섹션에서 실패 응답 샘플을 확인할 수 있습니다.

오류 응답

400 잘못된 요청 - 요청에 필수 식별자 필드가 누락되었습니다.

{
  "message": "param is missing or the value is empty: identifier"
}

401 승인되지 않음 - 인증에 실패했습니다.

{
  "message": "Not Found"
}

404 Not Found - 제공된 ID에 해당하는 통화 또는 채팅이 없습니다.

세션이 활성화되지 않음

400 {"message": "Call is already ended"}
400 {"message": "Chat is already ended"}

지원되지 않는 CRM 요청

400 잘못된 요청 - 인스턴스의 CRM 구성이 이 업데이트 경로를 지원하지 않습니다.

{
  "message": "Unsupported CRM request"
}

요청이 중복됨

400 {"message": "Duplicate request: Please wait for the interval to expire"}

API 요청 샘플

다음 섹션에서는 통화 및 채팅 커뮤니케이션 유형의 샘플 API 요청을 확인할 수 있습니다.

통화 커뮤니케이션 유형

POST https://<subdomain>.<domain>/apps/api/v1/calls/:call_id/end_user
Content-Type: application/json
-u apiuser:APIUSER_TOKEN

{
    "identifier": "unique_external_id",
    "name": "John Doe",
    "email": "[e-mail]",
    "phone": "123-456-7890"
}

채팅 커뮤니케이션 유형

POST https://<subdomain>.<domain>/apps/api/v1/chats/:chat_id/end_user
Content-Type: application/json
-u apiuser:APIUSER_TOKEN

{
    "identifier": "unique_external_id",
    "name": "Jane Smith",
    "email": "[e-mail]",
    "phone": "098-765-4321"
}

Apps API 참고 리소스

추가 앱 API 엔드포인트는 앱 API 게시를 참고하세요.