# 회원

## **1. 개요**

REST API를 이용한 오프사이트 캠페인의 발송 대상의 회원 정보를 그루비에 전송하는 API 입니다.

***

## **2. 주요 기능**

회원 API를 통해 회원 ID, 전화번호, 수신 동의 여부, 이름 정보를 그루비로 전송합니다. 연동된 데이터는 오프사이트 캠페인의 타겟팅 및 발송 데이터로 활용됩니다.

* **필수 정보:** 회원 ID, 전화번호
* **선택 정보:** 회원 이름, 수신 동의 여부

{% hint style="warning" %}

* 수신 동의 여부(isReceive) 값을 전송하지 않을 경우 수신 거부(false)로 저장됩니다.
* 브랜드 메시지(비친구 대상) 또는 SMS 발송 사용 시, 반드시 수신 동의 여부를 전송해 주세요. (미전송 시 발송 불가)
  {% endhint %}

***

## **3. 회원 API : v1 과 v2**

* 회원 API v1, v2 모두 요청, 응답 데이터는 동일합니다.
* 두 방식의 차이점은 key 값의 차이입니다.

<table><thead><tr><th width="82.720703125"></th><th>회원 v1</th><th>회원 v2</th></tr></thead><tbody><tr><td>key</td><td>회원 ID(memberId)</td><td>전화번호(phoneNumber)</td></tr><tr><td>설명</td><td>회원 ID가 유니크한 값 입니다.<br>회원 ID는 중복될 수 없으며, 전화번호는 중복 값을 가질 수도 있습니다.</td><td>전화번호가 유니크한 값 입니다.<br>전화번호는 중복될 수 없으며, 회원 ID는 중복 값을 가질 수도 있습니다.</td></tr></tbody></table>

***

## **4. 사용 예시**

**우리 사이트는 한 회원 당 전화번호는 하나만 가지고 있어야 합니다. → 회원 API v1 사용**

* 만약 이미 저장된 회원 ID에 저장된 번호와 다른 전화번호를 저장 요청한다면, 해당 회원 ID에 새로운 전화번호로 업데이트됩니다.

<figure><img src="https://files.helpdocs.io/p92xn84cjv/articles/2fmx7y6zq3/1723517862752/image.png" alt="" width="563"><figcaption></figcaption></figure>

{% hint style="info" %}
[회원 API v1](https://docs.groobee.ai/developer-guide/api-guide/member/v1) 문서를 확인해 주세요.
{% endhint %}

**우리 사이트는 한 회원이 다수의 전화번호를 가질 수 있는 구조입니다. → 회원 API v2 사용**

* 만약 이미 저장된 회원 ID와 동일한 회원 ID에 중복되지 않는 새로운 전화번호를 저장 요청한다면, 회원 ID와 전화번호가 추가되어 한 회원이 2개 이상의 전화번호를 가질 수 있습니다.

<figure><img src="https://files.helpdocs.io/p92xn84cjv/articles/2fmx7y6zq3/1723517878620/image.png" alt="" width="563"><figcaption></figcaption></figure>

{% hint style="info" %}
[회원 API v2](https://docs.groobee.ai/developer-guide/api-guide/member/v2) 문서를 확인해 주세요.
{% endhint %}

***

## **5. 주의 사항**

• 회원 API v1, v2 버전을 혼용하여 사용할 시 데이터가 혼재될 수 있습니다. 두 버전을 혼용해서 사용하지 말아주세요.

• 캠페인 중 브랜드 메시지(비친구 대상) 및 SMS 캠페인 진행 시에는 수신 동의 여부를 필수로 전송해야 합니다.

• 회원 이름은 정보를 전송하지 않으면 정보가 없는 상태로 응답합니다.

<br>