5.2 MO
베이스 URL
섹션 제목: “베이스 URL”| 구분 | 접속 URL |
|---|---|
| 상용 | https://api.msghub.uplus.co.kr |
| 검수 | https://api.msghub-qa.uplus.co.kr |
1. MO 메시지 조회
섹션 제목: “1. MO 메시지 조회”고객이 발신한 MO(Mobile Originated) 메시지를 조회합니다. SMS, MMS 등 다양한 유형의 메시지를 조회할 수 있습니다.
📌 주의사항
섹션 제목: “📌 주의사항”- MO 메시지는 최대 7일간 보관되며, 이후에는 자동으로 삭제됩니다.
- MMS 메시지의 경우
contentInfoLst에 컨텐츠 정보가 포함되며, 실제 컨텐츠는 별도 API를 통해 조회해야 합니다. moType에 따라 메시지 형식이 다르게 표시됩니다:SMSMO: 일반 SMS 메시지MMSMO: MMS 메시지RCSMO: RCS 메시지
1) 요청 (Request)
섹션 제목: “1) 요청 (Request)”URL
섹션 제목: “URL”GET /mo/v1/msg HTTP/1.1Headers
섹션 제목: “Headers”| 필드명 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
2) 응답 (Response)
섹션 제목: “2) 응답 (Response)”Response Body
섹션 제목: “Response Body”| 필드명 | 타입 | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
| data[].moKey | String | MO 메시지 고유 키 |
| data[].moNumber | String | 수신번호 |
| data[].moType | String | 메시지 유형 |
| data[].moCallback | String | 발신번호 |
| data[].productCode | String | 상품 코드 |
| data[].moTitle | String | 메시지 제목 (MMS/RCS) |
| data[].moMsg | String | 메시지 내용 |
| data[].telco | String | 이통사 |
| data[].contentCnt | Integer | 컨텐츠 개수 |
| data[].contentInfoLst[].contentName | String | 컨텐츠 파일명 |
| data[].contentInfoLst[].contentSize | String | 컨텐츠 크기 |
| data[].contentInfoLst[].contentExt | String | 컨텐츠 확장자 |
| data[].contentInfoLst[].contentUrl | String | 컨텐츠 URL |
| data[].moRecvDt | String | 수신 일시 |
3) 요청 예시 (Sample)
섹션 제목: “3) 요청 예시 (Sample)”Curl
섹션 제목: “Curl”curl -X GET "https://api.msghub.uplus.co.kr/mo/v1/msg" \ -H "Authorization: Bearer {token}" \ -H "Content-Type: application/json"Response
섹션 제목: “Response”{ "code": "10000", "message": "성공", "data": [ { "moKey": "1234", "moNumber": "15445367", "moType": "SMSMO", "moCallback": "01012345678", "productCode": "", "moTitle": "테스트", "moMsg": "테스트", "telco": "LGU", "contentCnt": 1, "contentInfoLst": [ { "contentName": "", "contentSize": "", "contentExt": "", "contentUrl": "" } ], "moRecvDt": "2024-01-29T09:22:55" } ]}2. MO 메시지 전달
섹션 제목: “2. MO 메시지 전달”MO 메시지는 MO 가입 시 받은 웹훅 URL 정보로 전달합니다. Webhook 전달 후 성공 시 큐에서 삭제되고, 실패시 재처리 가능합니다
📌 주의사항
섹션 제목: “📌 주의사항”- MO 메시지를 수신할수 있는 웹훅 URL정보를 사전에 등록해서 사용해야 합니다.
- 퍼블릭 웹훅URL만 지원이 되며, 전용선으로 연결 시에는 지원되지 않습니다.
- webhook 수신 성공시 성공코드는 10000이며, 성공메시지는 success로 전달해주세요.
- webhook 수신 실패시 실패코드는 20000 이상으로 설정하고, 실패메시지를 전달해주세요.
1) 요청 (Request)
섹션 제목: “1) 요청 (Request)”URL
섹션 제목: “URL”POST {WEBHOOK_URL} HTTP/1.1Headers
섹션 제목: “Headers”| 필드명 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| Content-Type | String | ● | application/json |
Requset Body
섹션 제목: “Requset Body”| 필드명 | 타입 | 설명 |
|---|---|---|
| moCnt | Integer | MO 건수 |
| moLst[].moKey | String | MO 메시지 고유 키 |
| moLst[].moNumber | String | 수신번호 |
| moLst[].moType | String | 메시지 유형 |
| moLst[].moCallback | String | 발신번호 |
| moLst[].productCode | String | 상품 코드 |
| moLst[].moTitle | String | 메시지 제목 (MMS/RCS) |
| moLst[].moMsg | String | 메시지 내용 |
| moLst[].telco | String | 이통사 |
| moLst[].moRecvDt | String | 수신 일시 |
| moLst[].contentCnt | Integer | 컨텐츠 개수 |
| moLst[].contentInfoLst[].contentName | String | 컨텐츠 파일명 |
| moLst[].contentInfoLst[].contentSize | String | 컨텐츠 크기 |
| moLst[].contentInfoLst[].contentExt | String | 컨텐츠 확장자 |
| moLst[].contentInfoLst[].contentUrl | String | 컨텐츠 URL |
Requset Body
섹션 제목: “Requset Body”| 필드명 | 타입 | 설명 |
|---|---|---|
| code | Integer | 결과코드 |
| message | String | 결과메시지 |
2 ) 요청 예시 (Sample)
섹션 제목: “2 ) 요청 예시 (Sample)”Curl
섹션 제목: “Curl”curl -X POST "https://{WEBHOOK_URL}"-H "accept: */*"-H "Content-Type: application/json"-d { "moCnt": 1, "moLst": [ { "moKey": "1234", "moNumber": "15445367", "moType": "SMSMO", "moCallback": "01012345678", "productCode": "", "moTitle": "테스트", "moMsg": "테스트", "telco": "LGU", "moRecvDt": "2024-01-29T09:22:55" "contentCnt": 1, "contentInfoLst": [ { "contentName": "", "contentSize": "", "contentExt": "", "contentUrl": "" } ] } ]}Response
섹션 제목: “Response”{ "code": "10000", "message": "success", }3. MMS MO 컨텐츠 조회
섹션 제목: “3. MMS MO 컨텐츠 조회”MMS MO 메시지에 첨부된 컨텐츠를 조회합니다. 이미지, 동영상 등 다양한 형식의 컨텐츠를 조회할 수 있습니다.
📌 주의사항
섹션 제목: “📌 주의사항”- 컨텐츠는 최대 7일간 보관되며, 이후에는 자동으로 삭제됩니다.
- 컨텐츠 URL은 일회성이며, 24시간 이내에만 유효합니다.
- 컨텐츠 크기가 큰 경우 다운로드에 시간이 걸릴 수 있습니다.
1) 요청 (Request)
섹션 제목: “1) 요청 (Request)”URL
섹션 제목: “URL”GET /mo/v1/file/{moKey} HTTP/1.1Headers
섹션 제목: “Headers”| 필드명 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
2) 응답 (Response)
섹션 제목: “2) 응답 (Response)”컨텐츠 파일이 직접 전송됩니다. Content-Type은 컨텐츠 형식에 따라 다르게 설정됩니다.
3) 요청 예시 (Sample)
섹션 제목: “3) 요청 예시 (Sample)”Curl
섹션 제목: “Curl”curl -X GET "https://api.msghub.uplus.co.kr/mo/v1/file/1234" \ -H "Authorization: Bearer {token}" \ -H "Content-Type: application/json" \ --output mms_content.jpg4. MO 컨텐츠 생성 샘플
섹션 제목: “4. MO 컨텐츠 생성 샘플”MO 컨텐츠 생성에 대한 샘플을 제공합니다. 개발자가 MO 컨텐츠를 생성할 때 참고할 수 있는 예시를 제공합니다.
📌 주의사항
섹션 제목: “📌 주의사항”- 이 API는 샘플 데이터만 제공하며, 실제 MO 메시지와는 무관합니다.
- 샘플 데이터는 개발 및 테스트 목적으로만 사용해야 합니다.
- 실제 운영 환경에서는 이 API를 사용하지 않습니다.
1) 요청 (Request)
섹션 제목: “1) 요청 (Request)”URL
섹션 제목: “URL”GET /mo/direct/v1/mmsMoSample HTTP/1.1Headers
섹션 제목: “Headers”| 필드명 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| Authorization | String | ● | 사용자 인증 토큰 |
| Content-Type | String | ● | application/json |
2) 응답 (Response)
섹션 제목: “2) 응답 (Response)”Response Body
섹션 제목: “Response Body”| 필드명 | 타입 | 설명 |
|---|---|---|
| code | String | 결과 코드 |
| message | String | 결과 메시지 |
| data | Object | 샘플 데이터 |
3) 요청 예시 (Sample)
섹션 제목: “3) 요청 예시 (Sample)”Curl
섹션 제목: “Curl”curl -X GET "https://api.msghub.uplus.co.kr/mo/direct/v1/mmsMoSample" \ -H "Authorization: Bearer {token}" \ -H "Content-Type: application/json"