목적

이 API는 외부 서비스의 회원가입, 예약, 문의 폼 등에서 수집한 고객 정보를 Sidetalk 고객 연락처에 생성하거나 업데이트합니다.

동일한 memberId가 이미 존재하면 기존 고객 정보를 업데이트하고, 존재하지 않으면 새 고객 정보를 생성합니다.

URL

💡https://api.sidetalk.ai/v1/users

HTTP 메서드

POST

헤더

헤더 값 설명
Content-Type application/json 요청 본문이 JSON 형식임을 나타냅니다.
Authorization Bearer <api_key> Sidetalk 대시보드에서 설치하기 메뉴에 제공된 API 키를 사용하세요.

본문

파라미터 타입 필수 설명
memberId String 예 외부 서비스의 회원 고유 ID입니다. 동일한 memberId로 다시 요청하면 기존 고객 정보가 업데이트됩니다.
userName String 아니요 고객 이름입니다. Sidetalk 고객 정보의 userName에 저장됩니다.
userEmail String 아니요 고객 이메일입니다. Sidetalk 고객 정보의 userEmail에 저장됩니다.
userPhone String 아니요 고객 전화번호입니다. Sidetalk 고객 정보의 userPhone에 저장됩니다.
customerMemory String 아니요 고객 메모입니다.
extraFields Object 아니요 추가 고객 정보 항목입니다. key는 Sidetalk 대시보드 고객정보 설정의 항목 코드와 동일해야 합니다.

extraFields 사용 방법

Sidetalk 고객정보 설정에서 추가 항목을 만든 경우, 해당 항목의 항목 코드를 extraFields의 key로 사용합니다.

예를 들어 고객정보 설정에 다음 항목이 있다면:

항목 이름 항목 코드
회사 이름 company_name

요청 본문은 다음처럼 전송합니다.

{
  "extraFields": {
    "company_name": "코스모스팜"
  }
}

요청 예시

curl -X POST <https://api.sidetalk.ai/v1/users> \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ${API_KEY}" \
  -d '{
      "memberId": "user_123",
      "userName": "홍길동",
      "userEmail": "[email protected]",
      "userPhone": "01012345678",
      "customerMemory": "VIP 고객",
      "extraFields": {
          "company_name": "코스모스팜"
      }
  }'

응답 본문