회원 API v2.0.0

설명

등록한 회원 정보를 조회합니다.

회원 정보는 회원 ID, 회원 전화번호를 쿼리 파라미터로 전달하여 조회할 수 있습니다.
※ '회원 정보'란 그루비에서 SMS 또는 카카오 모먼트 메세지를 발송하기 위해 등록한 회원의 정보입니다.

응답은 그루비 API 공통응답 형식의 "processValue" 필드에 조회한 회원의 정보를 JSON 배열로 반환합니다.

curl -X GET "https://api.groobee.io/v2/users/sms?memberId=${회원아이디}" \ 

                  -H "x-api-key: ${x-api-key}" \

                  -H "Content-Type": application/json
          

회원 ID로 조회 시 등록한 회원 ID의 목록이 출력됩니다.

※ 회원 API v2 에서는 phoneNumber 를 회원 정보의 유일 값으로 사용합니다.

{
                  "httpStatus": { 

                      "code": "200",

                      "reasonPhrase": "OK"

                  },

                  "processCode": "0",

                  "processValue": [

                      {

                          "memberId": "groobee",

                          "phoneNumber": "010-8012-0817",

                          "isReceive": "false",

                          "name": "그루비"

                      },

                      {

                          "memberId": "groobee",

                          "phoneNumber": "010-8012-0815",

                          "isReceive": "false",

                          "name": "그루비"

                      },

                      {

                          "memberId": "groobee",

                          "phoneNumber": "010-8012-0814",

                          "isReceive": "false",

                          "name": "그루비"

                      }

                  ]

          }

curl -X GET "https://api.groobee.io/v2/users/sms?phoneNumber=${전화번호}" \

                    -H "x-api-key: ${x-api-key}" \

                    -H "Content-Type": application/json

          

전화번호로 조회 시 등록한 회원의 정보가 출력됩니다.

※ 회원 API v2 에서는 phoneNumber 를 회원 정보의 유일 값으로 사용합니다.

{ 

                  "httpStatus": {

                      "code": "200",

                      "reasonPhrase": "OK"

                  },

                  "processCode": "0",


                  "processValue": [

                      {

                          "memberId": "plateer",

                          "phoneNumber": "010-8012-0812",

                          "isReceive": "false",

                          "name": "플래티어"

                      }

                  ]

          }

설명

회원 정보를 저장/수정 합니다.

회원 대상으로 SMS 또는 카카오 모먼트 메세지를 발송하기 위해 회원 정보를 저장/수정합니다.

‘저장/수정' 시 등록된 회원의 정보가 없으면 등록되고, 회원의 정보가 있으면 '전화번호’를 기준으로 회원의 정보가 변경됩니다.

회원 정보 '저장/수정' 응답은 성공/실패 시 모두 정상 응답하며 입력받은 회원 정보의 오류가 있으면 정상 데이터는 처리하고 오류 데이터 행을 오류코드와 함께 반환합니다.

예제

  curl -X POST "https://api.groobee.io/v2/users/sms" \ 

                    -H "x-api-key: ${x-api-key}" \

                    -H "Content-Type": application/json \

                    -d '[

                          {

                              "memberId": "groobee", 

                              "phoneNumber": "010-9999-9001", 

                              "isReceive": "true",

                              "name": "그루비"

                        },

                        {

                              "memberId": "plateer", 

                              "phoneNumber": "010-9999-9002", 

                              "isReceive": "true",

                              "name": "플래티어"

                        }

                      ]'

          

{ 

                "httpStatus": { 

                  "code": "200",

                  "reasonPhrase": "OK"

                },

                "processCode": "0", 

                "processValue": [

                ]

          }

데이터 오류가 있을 경우 실패 응답에 실패한 데이터 및 오류코드를 함께 응답합니다.

{

                "httpStatus":

                    { "code": "200",

                    "reasonPhrase": "OK"

                },

                  "processCode": "0", 

                  "processValue": [

                      {

                          "memberId": "",

                          "phoneNumber": "010-9999-9001", 

                          "isReceive": "true",

                          "name": "그루비",

                          "failureCode": "F01",

                          "failureMessage": "memberId가 유효하지 않습니다"

                      }
                ]
          }

설명

회원 정보를 삭제합니다.

• 입력된 회원의 ID를 기준으로 요청한 회원의 정보를 모두 삭제합니다.
• POST 요청으로 수행되며, 쿼리 파라미터 'delete' 를 인자로 추가합니다.
• 삭제 시 입력되었던 회원의 정보는 복구할 수 없습니다.

회원정보 '삭제' 응답은 성공/실패 시 모두 정상 응답하며 입력받은 회원 정보의 오류가 있으면 정상 데이터는 처리하고 오류데이터 행을 오류코드와 함께 반환합니다.

예제

  curl -X POST "https://api.groobee.io/v2/users/sms" \ 

                  -H "x-api-key: ${x-api-key}" \

                  -H "Content-Type": application/json \

                  -d '[

                      {

                        "phoneNumber": "010-9999-9002",

                      },

                      {

                        "phoneNumber": "010-9999-9001",

                      }

                    ]

          

{

                "httpStatus": 

                    { "code": "200",

                    "reasonPhrase": "OK"

                },

                "processCode": "0", 

                "processValue": [

              ]

          }

데이터 오류가 있을 경우 실패 응답에 실패한 데이터 및 오류코드를 함께 응답합니다.

{

                "httpStatus": 

                    { "code": "200",

                      "reasonPhrase": "OK"

                },

                "processCode": "0", 

                "processValue": [

                    {

                      "phoneNumber": "", 

                      "failureCode": "F02",

                      "failureMessage": "phoneNumber가 유효하지 않습니다"

                    }

              ]

          }