콘텐츠로 이동

5.2 MO

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

고객이 발신한 MO(Mobile Originated) 메시지를 조회합니다. SMS, MMS 등 다양한 유형의 메시지를 조회할 수 있습니다.

  1. MO 메시지는 최대 7일간 보관되며, 이후에는 자동으로 삭제됩니다.
  2. MMS 메시지의 경우 contentInfoLst에 컨텐츠 정보가 포함되며, 실제 컨텐츠는 별도 API를 통해 조회해야 합니다.
  3. moType에 따라 메시지 형식이 다르게 표시됩니다:
    • SMSMO: 일반 SMS 메시지
    • MMSMO: MMS 메시지
    • RCSMO: RCS 메시지

GET /mo/v1/msg HTTP/1.1
필드명타입필수 여부설명
AuthorizationString사용자 인증 토큰
Content-TypeStringapplication/json

필드명타입설명
codeString결과 코드
messageString결과 메시지
data[].moKeyStringMO 메시지 고유 키
data[].moNumberString수신번호
data[].moTypeString메시지 유형
data[].moCallbackString발신번호
data[].productCodeString상품 코드
data[].moTitleString메시지 제목 (MMS/RCS)
data[].moMsgString메시지 내용
data[].telcoString이통사
data[].contentCntInteger컨텐츠 개수
data[].contentInfoLst[].contentNameString컨텐츠 파일명
data[].contentInfoLst[].contentSizeString컨텐츠 크기
data[].contentInfoLst[].contentExtString컨텐츠 확장자
data[].contentInfoLst[].contentUrlString컨텐츠 URL
data[].moRecvDtString수신 일시

Terminal window
curl -X GET "https://api.msghub.uplus.co.kr/mo/v1/msg" \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json"
{
"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"
}
]
}

MO 메시지는 MO 가입 시 받은 웹훅 URL 정보로 전달합니다. Webhook 전달 후 성공 시 큐에서 삭제되고, 실패시 재처리 가능합니다

  1. MO 메시지를 수신할수 있는 웹훅 URL정보를 사전에 등록해서 사용해야 합니다.
  2. 퍼블릭 웹훅URL만 지원이 되며, 전용선으로 연결 시에는 지원되지 않습니다.
  3. webhook 수신 성공시 성공코드는 10000이며, 성공메시지는 success로 전달해주세요.
  4. webhook 수신 실패시 실패코드는 20000 이상으로 설정하고, 실패메시지를 전달해주세요.

POST {WEBHOOK_URL} HTTP/1.1
필드명타입필수 여부설명
Content-TypeStringapplication/json
필드명타입설명
moCntIntegerMO 건수
moLst[].moKeyStringMO 메시지 고유 키
moLst[].moNumberString수신번호
moLst[].moTypeString메시지 유형
moLst[].moCallbackString발신번호
moLst[].productCodeString상품 코드
moLst[].moTitleString메시지 제목 (MMS/RCS)
moLst[].moMsgString메시지 내용
moLst[].telcoString이통사
moLst[].moRecvDtString수신 일시
moLst[].contentCntInteger컨텐츠 개수
moLst[].contentInfoLst[].contentNameString컨텐츠 파일명
moLst[].contentInfoLst[].contentSizeString컨텐츠 크기
moLst[].contentInfoLst[].contentExtString컨텐츠 확장자
moLst[].contentInfoLst[].contentUrlString컨텐츠 URL
필드명타입설명
codeInteger결과코드
messageString결과메시지

Terminal window
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": ""
}
]
}
]
}
{
"code": "10000",
"message": "success",
}

MMS MO 메시지에 첨부된 컨텐츠를 조회합니다. 이미지, 동영상 등 다양한 형식의 컨텐츠를 조회할 수 있습니다.

  1. 컨텐츠는 최대 7일간 보관되며, 이후에는 자동으로 삭제됩니다.
  2. 컨텐츠 URL은 일회성이며, 24시간 이내에만 유효합니다.
  3. 컨텐츠 크기가 큰 경우 다운로드에 시간이 걸릴 수 있습니다.

GET /mo/v1/file/{moKey} HTTP/1.1
필드명타입필수 여부설명
AuthorizationString사용자 인증 토큰
Content-TypeStringapplication/json

컨텐츠 파일이 직접 전송됩니다. Content-Type은 컨텐츠 형식에 따라 다르게 설정됩니다.


Terminal window
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.jpg

MO 컨텐츠 생성에 대한 샘플을 제공합니다. 개발자가 MO 컨텐츠를 생성할 때 참고할 수 있는 예시를 제공합니다.

  1. 이 API는 샘플 데이터만 제공하며, 실제 MO 메시지와는 무관합니다.
  2. 샘플 데이터는 개발 및 테스트 목적으로만 사용해야 합니다.
  3. 실제 운영 환경에서는 이 API를 사용하지 않습니다.

GET /mo/direct/v1/mmsMoSample HTTP/1.1
필드명타입필수 여부설명
AuthorizationString사용자 인증 토큰
Content-TypeStringapplication/json

필드명타입설명
codeString결과 코드
messageString결과 메시지
dataObject샘플 데이터

Terminal window
curl -X GET "https://api.msghub.uplus.co.kr/mo/direct/v1/mmsMoSample" \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json"