EspoCRM 참조 구현

이 문서에서는 EspoCRM을 사용하여 Contact Center AI Platform (CCAI Platform) 맞춤 CRM과 통합하는 예를 제공합니다. EspoCRM은 무료 오픈소스 CRM 애플리케이션으로, 기업이 맞춤설정 가능한 인터페이스를 통해 판매, 마케팅, 고객 지원을 관리할 수 있도록 지원합니다. 연락처 관리, 활동 추적, 영업 자동화, 재고 관리와 같은 기능을 제공하며 자체 호스팅 또는 클라우드 배포 옵션이 있습니다.

EspoCRM 인스턴스를 직접 설정하려면 EspoCRM 설치 페이지를 참고하세요.

시작하기 전에

다음 단계를 따르세요.

  • CCAI Platform의 트래픽을 허용하도록 방화벽을 구성합니다.

  • EspoCRM 인스턴스에서 API 사용자를 만듭니다(예: google_integration_user). 자세한 내용은 EspoCRM 문서의 API를 참고하세요.

  • 다음 항목에 액세스하는 생성, 읽기, 업데이트 작업이 있는 EspoCRM 인스턴스에서 역할을 만듭니다.

    • 연락처: 발신자를 찾거나 만들기
    • Cases: 티켓을 검색하고 기록합니다.

    자세한 내용은 ExpoCRM 문서의 역할 관리를 참고하세요.

EspoCRM에서 CCAI Platform으로의 연결 구성

EspoCRM에서 CCAI Platform으로의 연결을 구성하려면 다음 단계를 따르세요.

  1. CCAI Platform 포털에서 설정 > 개발자 설정을 클릭합니다. 설정 메뉴가 표시되지 않으면 메뉴를 클릭합니다.
  2. Agent Platform(상담사 플랫폼)에서 Custom CRM(맞춤 CRM)을 선택합니다.
  3. CCAI Platform 포털에 CRM 표시 전환 버튼을 사용 설정으로 클릭합니다.
  4. 표시 URL 필드에 CCAI Platform 포털에 삽입할 URL을 입력합니다(예: https://YOUR_ESPO_DOMAIN/#Case/view/{RECORD_ID}).
  5. CRM 조회 방법에서 일반 API를 선택합니다.
  6. 커스텀 헤더를 사용하여 인증하려면 다음 단계를 따르세요.
    1. 인증 방법 섹션에서 맞춤 헤더를 선택합니다.
    2. 필드 추가를 클릭합니다. 필드 추가 대화상자가 표시됩니다.
      1. 필드 키 필드에 X-Api-Key를 입력합니다.
      2. 필드 값 필드에 EspoCRM에서 API 사용자를 만들 때 생성된 API 키를 입력합니다.
      3. 저장을 클릭합니다.
  7. CRM 조회 URL을 설정하려면 다음 단계를 따르세요.
    1. CRM 조회 URL 섹션의 레코드 조회 URL 필드에 레코드를 조회할 URL을 입력합니다(예: https://YOUR_ESPO_DOMAIN/#Case/view/{RECORD_ID}).
    2. 계정 조회 URL 필드에 계정을 조회할 URL을 입력합니다(예: https://YOUR_ESPO_DOMAIN/#Contact/view/{ACCOUNT_ID}).
    3. 저장을 클릭합니다. ## API 엔드포인트 구성

EspoCRM과 호환되는 엔드포인트를 구성하여 통합에 계정 (연락처) 및 레코드 (케이스)를 조회하는 구성요소가 있는지 확인합니다. 호환되는 변수에 대한 자세한 내용은 EspoCRM 문서의 API 개요를 참고하세요.

API 계정 엔드포인트 구성

이 섹션에서는 API 계정 엔드포인트를 구성하는 방법을 설명합니다.

쿼리로 계정 찾기 엔드포인트 구성

쿼리로 계정 찾기 엔드포인트를 구성하려면 다음 단계를 따르세요.

  1. CCAI 플랫폼에서 설정 > 개발자 설정을 클릭합니다. 설정 메뉴가 표시되지 않으면 메뉴를 클릭합니다.
  2. CRM 창에서 API 계정 섹션으로 이동합니다.
  3. 쿼리로 계정 찾기 엔드포인트의 경우 설정을 클릭합니다. 일반 API 엔드포인트 설정 페이지가 표시됩니다.
  4. URL 필드에 계정을 조회할 URL을 입력합니다(예: https://YOUR_ESPO_DOMAIN/api/v1/Contact).
  5. 메서드에서 GET을 선택합니다.

  6. 요청 매개변수를 구성하려면 다음 단계를 따르세요.

    1. 첫 번째 요청 매개변수를 구성하려면 다음 단계를 따르세요.
      1. 필드 추가를 클릭합니다. 필드 추가 대화상자가 표시됩니다.
      2. 필드 키 필드에 where[0][attribute]를 입력합니다.
      3. 필드 값 필드에 phoneNumber를 입력합니다.
      4. 저장을 클릭합니다.

    2. 나머지 요청 매개변수를 구성하려면 다음 표의 정보를 사용하여 이전 단계를 반복합니다. 첫 번째 요청 매개변수를 이미 만들었습니다.

      필드 키 필드 값
      where[0][attribute] phoneNumber
      where[0][type] equals
      where[0][value] {PHONE_NUMBER}
      sortBy createdAt
      asc false

  7. 응답 데이터 위치 필드에 data.list를 입력합니다.

  8. 저장을 클릭합니다.

  9. 개발자 설정으로 돌아가기를 클릭하여 개발자 설정 페이지로 돌아갑니다.

ID로 계정 찾기 엔드포인트 구성

ID로 계정 찾기 엔드포인트를 구성하려면 다음 단계를 따르세요.

  1. CRM 창에서 API 계정 섹션으로 이동합니다.
  2. ID로 계정 찾기 엔드포인트의 경우 설정을 클릭합니다. 일반 API 엔드포인트 설정 페이지가 표시됩니다.
  3. URL 필드에 계정을 조회할 URL을 입력합니다(예: https://YOUR_ESPO_DOMAIN/api/v1/Contact/{ACCOUNT_ID}).
    1. 메서드에서 GET을 선택합니다.
  4. 응답 데이터 위치를 data로 설정합니다.
  5. 저장을 클릭합니다.
  6. 개발자 설정으로 돌아가기를 클릭하여 개발자 설정 페이지로 돌아갑니다.

계정 만들기 엔드포인트 구성

계정 생성 엔드포인트를 구성하려면 다음 단계를 따르세요.

  1. CRM 창에서 API 계정 섹션으로 이동합니다.
  2. 계정 엔드포인트 만들기에서 설정을 클릭합니다. 일반 API 엔드포인트 설정 페이지가 표시됩니다.
  3. URL 필드에 계정을 조회할 URL을 입력합니다(예: https://YOUR_ESPO_DOMAIN/api/v1/Contact).
  4. 메서드에서 POST를 선택합니다.

  5. 요청 매개변수를 구성하려면 다음 단계를 따르세요.

    1. 첫 번째 요청 매개변수를 구성하려면 다음 단계를 따르세요.
      1. 요청 매개변수에서 필드 추가를 클릭합니다. 필드 추가 대화상자가 표시됩니다.
      2. 필드 키 필드에 phoneNumber를 입력합니다.
      3. 필드 값 필드에 {PHONE_NUMBER}를 입력합니다.
      4. 저장을 클릭합니다.

    2. 나머지 요청 매개변수를 구성하려면 다음 표의 정보를 사용하여 이전 단계를 반복합니다. 첫 번째 요청 매개변수를 이미 만들었습니다.

      매개변수 키 매개변수 값
      phoneNumber {PHONE_NUMBER}
      firstName New Caller
      lastName {CALL_ID}
      name New Caller {CALL_ID}

  6. 응답 데이터 위치를 data로 설정합니다.

  7. 객체 ID 위치를 id로 설정합니다.

  8. 저장을 클릭합니다.

  9. 개발자 설정으로 돌아가기를 클릭하여 개발자 설정 페이지로 돌아갑니다.

계정 업데이트 엔드포인트 구성

계정 업데이트 엔드포인트를 구성하려면 다음 단계를 따르세요.

  1. CRM 창에서 API 계정 섹션으로 이동합니다.
  2. 계정 엔드포인트 업데이트에서 설정을 클릭합니다. 일반 API 엔드포인트 설정 페이지가 표시됩니다.
  3. URL 필드에 계정을 조회할 URL을 입력합니다(예: https://YOUR_ESPO_DOMAIN/api/v1/Contact).
  4. 메서드에서 PUT을 선택합니다.

  5. 요청 매개변수를 구성하려면 다음 단계를 따르세요.

    1. 첫 번째 요청 매개변수를 구성하려면 다음 단계를 따르세요.
      1. 요청 매개변수에서 필드 추가를 클릭합니다. 필드 추가 대화상자가 표시됩니다.
      2. 필드 키 필드에 contactId를 입력합니다.
      3. 필드 값 필드에 {PHONE_NUMBER}를 입력합니다.
      4. 저장을 클릭합니다.

    2. 나머지 요청 매개변수를 구성하려면 다음 표의 정보를 사용하여 이전 단계를 반복합니다. 첫 번째 요청 매개변수를 이미 만들었습니다.

      매개변수 키 매개변수 값
      contactId {PHONE_NUMBER}
      phoneNumber New Caller

  6. 응답 데이터 위치를 data로 설정합니다.

  7. 저장을 클릭합니다.

  8. 개발자 설정으로 돌아가기를 클릭하여 개발자 설정 페이지로 돌아갑니다.

API 레코드 엔드포인트 구성

이 섹션에서는 API 레코드 엔드포인트를 구성하는 방법을 설명합니다.

쿼리로 레코드 찾기 엔드포인트 구성

쿼리로 레코드 찾기 엔드포인트를 구성하려면 다음 단계를 따르세요.

  1. CRM 창에서 API 레코드 섹션으로 이동합니다.
  2. 쿼리 엔드포인트로 레코드 찾기의 경우 설정을 클릭합니다. 일반 API 엔드포인트 설정 페이지가 표시됩니다.
  3. URL 필드에 계정을 조회할 URL을 입력합니다(예: https://YOUR_ESPO_DOMAIN/api/v1/Case).
  4. 메서드에서 GET을 선택합니다.

  5. 요청 매개변수를 구성하려면 다음 단계를 따르세요.

    1. 첫 번째 요청 매개변수를 구성하려면 다음 단계를 따르세요.
      1. 요청 매개변수에서 필드 추가를 클릭합니다. 필드 추가 대화상자가 표시됩니다.
      2. 필드 키 필드에 where[0][attribute]를 입력합니다.
      3. 필드 값 필드에 contactId를 입력합니다.
      4. 저장을 클릭합니다.

    2. 나머지 요청 매개변수를 구성하려면 다음 표의 정보를 사용하여 이전 단계를 반복합니다. 첫 번째 요청 매개변수를 이미 만들었습니다.

      필드 키 필드 값
      where[0][attribute] contactId
      where[0][type] equals
      where[0][value] {ACCOUNT_ID}
      contactId {ACCOUNT_ID}
      sortBy createdAt
      asc false

  6. 응답 데이터 위치 필드에 data.list를 입력합니다.

  7. 저장을 클릭합니다.

  8. 개발자 설정으로 돌아가기를 클릭하여 개발자 설정 페이지로 돌아갑니다.

ID로 레코드 찾기 엔드포인트 구성

SDK 기반 상호작용에서 자주 사용되며, 상호작용과 연결할 특정 레코드 ID를 전달할 수 있습니다. ID로 레코드 찾기 엔드포인트를 구성하려면 다음 단계를 따르세요.

  1. CRM 창에서 API 레코드 섹션으로 이동합니다.
  2. ID로 레코드 찾기 엔드포인트에서 설정을 클릭합니다. 일반 API 엔드포인트 설정 페이지가 표시됩니다.
  3. URL 필드에 계정을 조회할 URL을 입력합니다(예: https://YOUR_ESPO_DOMAIN/api/v1/Case/{RECORD_ID}).
  4. 메서드에서 GET을 선택합니다.
  5. 응답 데이터 위치 필드에 data를 입력합니다.
  6. 저장을 클릭합니다.
  7. 개발자 설정으로 돌아가기를 클릭하여 개발자 설정 페이지로 돌아갑니다.

레코드 생성 엔드포인트 구성

레코드 생성 엔드포인트를 구성하려면 다음 단계를 따르세요.

  1. CRM 창에서 API 레코드 섹션으로 이동합니다.
  2. 레코드 엔드포인트 만들기에서 설정을 클릭합니다. 일반 API 엔드포인트 설정 페이지가 표시됩니다.
  3. URL 필드에 계정을 조회할 URL을 입력합니다(예: https://YOUR_ESPO_DOMAIN/api/v1/Case).
  4. 메서드에서 POST를 선택합니다.

  5. 요청 매개변수를 구성하려면 다음 단계를 따르세요.

    1. 첫 번째 요청 매개변수를 구성하려면 다음 단계를 따르세요.
      1. 요청 매개변수에서 필드 추가를 클릭합니다. 필드 추가 대화상자가 표시됩니다.
      2. 필드 키 필드에 description를 입력합니다.
      3. 필드 값 필드에 CALL Session:{CALL_ID}를 입력합니다.
      4. 저장을 클릭합니다.

    2. 나머지 요청 매개변수를 구성하려면 다음 표의 정보를 사용하여 이전 단계를 반복합니다. 첫 번째 요청 매개변수를 이미 만들었습니다.

      매개변수 키 매개변수 값
      description Call Session: {CALL_ID}
      name Inbound Call from {ANI}
      contactId {ACCOUNT_ID}
      status New
      cchatId {CHAT_ID}
      ccallId {CALL_ID}
      cChannel {CHANNEL}
      Type {SESSION_TYPE}

  6. 응답 데이터 위치 필드에 data를 입력합니다.

  7. 객체 ID 위치 필드에 id를 입력합니다.

  8. 저장을 클릭합니다.

  9. 개발자 설정으로 돌아가기를 클릭하여 개발자 설정 페이지로 돌아갑니다.

레코드 업데이트 엔드포인트 구성

레코드 업데이트 엔드포인트를 구성하려면 다음 단계를 따르세요.

  1. CRM 창에서 API 레코드 섹션으로 이동합니다.
  2. 레코드 업데이트 엔드포인트에서 설정을 클릭합니다. 일반 API 엔드포인트 설정 페이지가 표시됩니다.
  3. URL 필드에 계정을 조회할 URL을 입력합니다(예: https://YOUR_ESPO_DOMAIN/api/v1/Case/{RECORD_ID}).
  4. 메서드에서 PUT을 선택합니다.

  5. 요청 매개변수를 구성하려면 다음 단계를 따르세요.

    1. 첫 번째 요청 매개변수를 구성하려면 다음 단계를 따르세요.
      1. 요청 매개변수에서 필드 추가를 클릭합니다. 필드 추가 대화상자가 표시됩니다.
      2. 필드 키 필드에 parentId를 입력합니다.
      3. 필드 값 필드에 {RECORD_ID}를 입력합니다.
      4. 저장을 클릭합니다.

    2. 나머지 요청 매개변수를 구성하려면 다음 표의 정보를 사용하여 이전 단계를 반복합니다. 첫 번째 요청 매개변수를 이미 만들었습니다.

      매개변수 키 매개변수 값
      parentId {RECORD_ID}
      parentType Case
      status New
      description {TICKET_DESCRIPTION}

  6. 응답 데이터 위치 필드에 data를 입력합니다.

  7. 저장을 클릭합니다.

  8. 개발자 설정으로 돌아가기를 클릭하여 개발자 설정 페이지로 돌아갑니다.