상세 관리

API 목록

No	Method	API	Description
1	GET	/v1/openapi/addr/detail/{addrGrpNo}	주소록 상세 목록 조회 API
3	DELETE	/v1/openapi/addr/detail	주소록 상세 개별 삭제 API
2	DELETE	/v1/openapi/addr/detail/{addrGrpNo}	주소록 상세 전체 삭제 API

1. 주소록 상세 목록 조회

주소록의 상세 목록을 조회한다.

GET https://api.megabird.co.kr:8080/v1/openapi/addr/detail/{addGrpNo}

Headers

Name	Type	Description
Authorization*	String	발급받은 API Key
Content-Type*	String	application/json

Path Parameters

Name	Type	Required	Description
addGrpNo*	Integer	Y	주소록 그룹번호

Query Parameters

Name	Type	Description
vl	String	이름 또는 휴대폰번호
offset	Integer	페이지별 행 건수
page	Integer	페이지 번호

Response Example

200: OK

{
  "success": true,
  "code": "200",
  "message": "성공",
  "data": {
    "totalCount": 100000,
    "result": [
      {
        "mbnum": "01012341234",
        "addrNm": "",
        "var1Vl": "",
        "var2Vl": "",
        "var3Vl": "",
        "var4Vl": "",
        "addrGrpNm": "1021",
        "rjtYn": null,
        "addrGrpNo": "317"
      },
      {
        "mbnum": "01023452345",
        "addrNm": "",
        "var1Vl": "",
        "var2Vl": "",
        "var3Vl": "",
        "var4Vl": "",
        "addrGrpNm": "1021",
        "rjtYn": null,
        "addrGrpNo": "317"
      },
      {
        "mbnum": "01034563456",
        "addrNm": "",
        "var1Vl": "",
        "var2Vl": "",
        "var3Vl": "",
        "var4Vl": "",
        "addrGrpNm": "1021",
        "rjtYn": null,
        "addrGrpNo": "317"
      }
    ]
  },
  "timestamp": "2023-03-03T13:33:50.168255"
}

403: Forbidden

{
    "message": ""
}

2. 주소록 상세 개별 삭제

주소록 그룹 내 주소록 개별 삭제한다.

DELETE https://api.megabird.co.kr:8080/v1/openapi/addr/detail

Headers

Name	Type	Description
Content-Type*	String	application/json
Authorization*	String	발급받은 API Key

Request Body

Name	Type	Required	Description
mbnum*	String	Y	휴대폰번호
addrGrpNo*	String	Y	주소록 그룹번호
adrBk*	Array	Y	주소록 그룹상세 Data adrBk : [ { "addrGrpNo": "123", "mbnum": "01012341234" } ]

Response Example

200: OK

{
  "success": true,
  "code": "200",
  "message": "성공",
  "data": {
    "addrGrpNo": null,
    "deletedCnt": 1
  },
  "timestamp": "2023-03-03T14:01:49.349689"
}

403: Forbidden

{
    "message": ""
}

3. 주소록 상세 전체삭제

주소록 그룹 내 주소록 전체 삭제한다.

DELETE https://api.megabird.co.kr:8080/v1/openapi/addr/detail/{addrGrpNo}

Path Parameters

Name	Type	Required	Description
addrGrpNo*	Integer	Y	주소록 그룹번호

Headers

Name	Type	Description
Authorization*	String	발급받은 API Key
Content-Type*	String	application/json

Response Example

200: OK

{
  "success": true,
  "code": "200",
  "message": "성공",
  "data": "",
  "timestamp": "2023-03-03T10:54:22.988545"
}

400: Bad Request

{
  "status": 400,
  "code": 3100,
  "message": "유효성 검사에 실패하였습니다.",
  "success": false,
  "timestamp": "2023-03-03T10:49:50.151145",
  "description": [
    {
      "code": "NotNull",
      "field": "addrGrpNo",
      "errorType": "field",
      "message": "[주소그룹번호] 필수입력값입니다."
    }
  ]
}