5.1 080 수신거부

목차

• 1. 080수신거부 번호목록 등록
• 2. 080수신거부 번호목록 조회
• 3. 080수신거부 번호 삭제
• 4. 080수신거부 번호목록 기간 조회
• Appendix

베이스 URL

구분	접속 URL
상용	https://api.msghub.uplus.co.kr
검수	https://api.msghub-qa.uplus.co.kr

1. 080수신거부 번호목록 등록

080 수신거부 번호목록을 등록합니다. 한 번의 요청으로 여러 개의 번호를 등록할 수 있습니다.

📌 주의사항

1. 발신번호(callback)는 *로 설정 가능하며, 이 경우 모든 발신번호에 대해 수신거부가 적용됩니다.
2. 동일한 수신번호와 발신번호 조합은 중복 등록이 불가능합니다.
3. 등록된 번호는 즉시 수신거부가 적용되며, 별도의 확인 절차가 필요하지 않습니다.

---

1) 요청 (Request)

URL

POST /client/v1/080/ars080Reject HTTP/1.1

Headers

필드명	타입	필수 여부	설명
apiKey	String	●	API 인증 키

Request Body

필드명	타입	필수 여부	설명	크기
phone	String	●	수신거부할 전화번호	최대 20자
callback	String	●	발신번호 (* 사용 가능)	최대 20자

---

2) 응답 (Response)

Response Body

필드명	타입	설명
code	String	결과 코드
message	String	결과 메시지

---

3) 요청 예시 (Sample)

Curl

curl -X POST "https://api.msghub.uplus.co.kr/client/v1/080/ars080Reject" \
  -H "apiKey: {your-api-key}" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "phone": "01012341234",
      "callback": "15441234"
    },
    {
      "phone": "01056785678",
      "callback": "*"
    }
  ]'

Response

{
  "code": "10000",
  "message": "성공"
}

---

2. 080수신거부 번호목록 조회

등록된 080 수신거부 번호목록을 조회합니다. 페이지네이션을 지원하여 대량의 데이터도 효율적으로 조회할 수 있습니다.

📌 주의사항

1. mnt-api 호스트를 사용합니다.
2. phone 파라미터를 사용하여 특정 번호만 필터링하여 조회할 수 있습니다.
3. listCnt는 한 페이지당 조회할 항목 수를 지정하며, 시스템 성능을 고려하여 적절한 값을 설정해야 합니다.
4. 삭제된 번호(delYn: "Y")도 조회 결과에 포함됩니다.
5. aniNumber 은 수신거부를 요청한 발신번호입니다. 수신거부번호와 다른 경우 표기됩니다.

---

1) 요청 (Request)

URL

POST https://mnt-api.msghub.uplus.co.kr/client/v1.2/080/ars080RejectList HTTP/1.1

Headers

필드명	타입	필수 여부	설명
apiKey	String	●	API 인증 키

Query Parameter

필드명	타입	필수 여부	설명
phone	String	-	조회할 전화번호
listCnt	Integer	●	페이지당 조회 건수
pageIdx	Integer	●	페이지 번호 (1부터 시작)

---

2) 응답 (Response)

Response Body

필드명	타입	설명
code	String	결과 코드
message	String	결과 메시지
data.listCnt	Integer	페이지당 조회 건수
data.pageIdx	Integer	현재 페이지 번호
data.rejectList[].phone	String	수신거부 전화번호
data.rejectList[].aniNumber	String	수신거부를 요청한 발신번호
data.rejectList[].callback	String	발신번호
data.rejectList[].delYn	String	삭제 여부 (Y/N)
data.rejectList[].updDt	String	최종 수정 일시
data.rejectList[].delDt	String	삭제 일시 (null 가능)
data.totalCnt	Integer	전체 조회 건수

---

3) 요청 예시 (Sample)

Curl

curl -X POST "https://mnt-api.msghub.uplus.co.kr/client/v1/080/ars080RejectList?phone=010....&listCnt=10&pageIdx=1" \
  -H "apiKey: {your-api-key}" \
  -H "Content-Type: application/json" \

Response

{
  "code": "10000",
  "message": "성공",
  "data": {
    "listCnt": 10,
    "pageIdx": 1,
    "rejectList": [
      {
        "phone": "01012341234",
        "callback": "",
        "aniNumber" : "01011112222",
        "delYn": "N",
        "updDt": "2023-06-15 14:30:00",
        "delDt": null
      }
    ],
    "totalCnt": 1
  }
}

---

3. 080수신거부 번호 삭제

등록된 080 수신거부 번호를 삭제합니다. 삭제된 번호는 더 이상 수신거부가 적용되지 않습니다.

📌 주의사항

1. 삭제는 즉시 적용되며, 복구가 불가능합니다.
2. 이미 삭제된 번호를 다시 삭제 요청해도 성공으로 처리됩니다.
3. 발신번호가 *인 경우, 해당 수신번호에 대한 모든 발신번호의 수신거부가 해제됩니다.

---

1) 요청 (Request)

URL

DELETE /client/v1/080/ars080RejectDelete HTTP/1.1

Headers

필드명	타입	필수 여부	설명
apiKey	String	●	API 인증 키

Request Body

필드명	타입	필수 여부	설명	크기
phone	String	●	삭제할 수신번호	최대 20자
callback	String	●	삭제할 발신번호	최대 20자

---

2) 응답 (Response)

Response Body

필드명	타입	설명
code	String	결과 코드
message	String	결과 메시지

---

3) 요청 예시 (Sample)

Curl

curl -X DELETE "https://api.msghub.uplus.co.kr/client/v1/080/ars080RejectDelete" \
  -H "apiKey: {your-api-key}" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "01012341234",
    "callback": "15441234"
  }'

Response

{
  "code": "10000",
  "message": "성공"
}

---

4. 080수신거부 번호목록 기간 조회

080 수신거부 번호목록 기간별로 조회합니다.

📌 주의사항

1. mnt-api 호스트를 사용합니다.
2. aniNumber 은 수신거부를 요청한 발신번호입니다. 수신거부번호와 다른 경우 표기됩니다.
3. status는 active / inactive 로 표기됩니다. active는 수신거부번호가 삭제되어 차단이 아닌 상태, inactive는 차단상태임을 의미합니다.

---

1) 요청 (Request)

URL

GET https://mnt-api.msghub.uplus.co.kr/client/v1/080/ars080BlockNumberList HTTP/1.1

Headers

필드명	타입	필수 여부	설명
apiKey	String	●	API 인증 키

Query Parameters

필드명	타입	필수 여부	설명	크기
080ArsNumber	String	●	080ars 차단 번호	최대 20자
fromTime	String	●	검색할 시작 일자 YYYYMMDDHHMMSS 형식	-
toTime	String	●	검색할 종료 일자 YYYYMMDDHHMMSS 형식	-
page	Number	-	검색할 페이지 번호 default: 1	-
pageSize	Number	-	검색할 페이지 사이즈 default : 10	최대 300

---

2) 응답 (Response)

Response Body

필드명	타입	설명
code	String	결과 코드
message	String	결과 메시지
data[].blockNumber	String	수신거부번호
data[].aniNumber	String	수신거부를 요청한 발신번호
data[].updateTime	String	등록일자
data[].status	String	상태
meta.totalItems	Integer	전체 조회 건수
meta.totalPages	Integer	전체 페이지
meta.080ArsNumber	String	080 차단 번호
meta.fromTime	String	검색할 시작 일자
meta.toTime	String	검색할 종료 일자
meta.pageSize	Integer	검색 건수
meta.page	Integer	현재 페이지

---

3) 요청 예시 (Sample)

Curl

curl -X GET "https://mnt-api.msghub.uplus.co.kr/client/v1/080/ars080BlockNumberList?080ArsNumber=080......&fromTime=20240901000000&toTime=20240930000000" \
  -H "apiKey: {your-api-key}" \
  -H "Content-Type: application/json"

Response

{
 "code": "10000",
  "message": "성공",
  "data": [
    {
      "blockNumber": "01000000001",
      "aniNumber" : "01011112222",
      "updateTime": "2024-09-06 14:06:45",
      "status": "active"
    },
    {
      "blockNumber": "01000000002",
      "aniNumber" : "01011112222",
      "updateTime": "2024-09-06 14:06:45",
      "status": "inactive"
    }
    ...
  ],
  "meta": {
    "totalItems": 15,
    "totalPages": 2,
    "080ArsNumber": "08000000000",
    "fromTime": "20240901000000",
    "pageSize": 10,
    "page": 1,
    "toTime": "20240930000000"
  }
}

---

Appendix

결과 코드

• 결과 코드