리포트 처리

리포트 요청 (Polling 방식) #

실시간으로 처리가 완료된 메시지의 결과를 전달합니다.
메시지 결과는 한번만 전달됩니다.

▶ 클라이언트에서 리포트 요청기능 구현 시 주의사항
1) 리포트 요청 결과가 1건이라도 있을 경우, 처리 후 바로 다음 리포트 요청을 시작해야 합니다.
만약 리포트가 없으면 잠시 쉬었다가 다시 요청해야 합니다. 리포트는 최대 100개까지 한 번에 받아서 배열(Array)로 전달됩니다.
2) 리포트 요청 결과가 안 오면, 무한히 요청하는 것을 막기 위해 10초마다 요청하되, 10초 이내에 요청하면 실패처리합니다.
3) 리포트 결과에는 report key가 있습니다. 리포트 처리가 끝나면 해당 report key를 리포트 처리 결과 전달 API로 전달해야 합니다.
만약 120초 동안 전달되지 않으면 리포트는 다시 내려가며, 클라이언트는 중복 수신을 방지하기 위해 확인 처리를 해야 합니다.
4) 리포트를 요청하지 않으면 81시간 후에 자동으로 만료처리됩니다.

Request #

URL

GET /msg/v1.2/report HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

Response #

Name	Type	Description
code	String	리포트 요청에 대한 결과 응답코드
message	String	리포트 요청에 대한 결과 응답코드 설명
data	List	결과 데이터 목록
data.rptKey	String	리포트 키
data.rptCnt	Integer	리포트 개수
data.rptLst	List	리포트 목록
data.rptLst[].msgKey	String	U+ 메시지 허브 시스템에서 부여한 메시지 고유 키
data.rptLst[].cliKey	String	클라이언트키: 고객사에서 부여하는 메시지 고유 키
data.rptLst[].ch	String	채널
data.rptLst[].resultCode	String	메시지 발송 결과코드
data.rptLst[].resultCodeDesc	String	메시지 발송 결과코드 설명
data.rptLst[].fbReasonLst	List<FbReason>	Fallback 사유
data.rptLst[].telco	String	이통사(*xMS, RCS만 해당)
data.rptLst[].rptDt	String	결과 수신 일시
data.rptLst[].productCode	String	상품코드

Sample #

Curl

curl -X GET "https://api.msghub.uplus.co.kr/msg/v1.2/report"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ..."

Response

{
  "code": "10000",
  "message": "성공",
  "data": {
    "rptKey": "rptKey",
    "rptCnt": 100,
    "rptLst": [
      {
        "msgKey": "msgKey",
        "cliKey": "cliKey",
        "ch": "SMS",
        "resultCode": "21003",
        "resultCodeDesc": "발송타임아웃",
        "fbReasonLst": [
          {
            "ch":"RCS",
            "fbResultCode":"51004",
            "fbResultDesc":"Parameter Error",
            "telco":"KT"
          }
        ],
        "productCode": "SMS",
        "telco": null,
        "rptDt": null
      },
      {
        "msgKey": "msgKey",
        "cliKey": "cliKey",
        "ch": "SMS",
        "resultCode": "21003",
        "resultCodeDesc": "발송타임아웃",
        "fbReasonLst": [
          {
            "ch":"RCS",
            "fbResultCode":"51004",
            "fbResultDesc":"Parameter Error",
            "telco":"KT"
          }
        ],
        "productCode": "SMS",
        "telco": null,
        "rptDt": null
      }
      ....
      ]
  }
}

참고

결과 코드 참고