Versions Compared

Version Old Version 7 New Version 8
Changes made by

Hannah

Hannah

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Type

Required

Description

item

Object

true

– requestId

String

true

발신 요청 ID

...

Message List

[URL]

Panel
bgColor#F4F5F7

POST /api/message/list.v1.0

[Request Paramenter]

Name

Type

Required

Description

page

Integer

false

페이지 번호

  • default : 1

pageSize

Integer

false

페이지 조회 건수

  • defualt : 10

requestId

String

false

발신 요청 ID

messageId

String

false

발신 메시지 ID

messageProductType

String

false

메시지 상품 유형

  • SMS (sms)

  • LMS (lms)

  • MMS (mms)

  • Email (email)

  • Push (push)

  • 알림톡 (alimTalk)

  • 친구톡 Text (friendTalkText)

  • 친구톡 Image(friendTalkImage)

  • 친구톡 Wide Image(friendTalkWideImage)

sendingStatus

String

false

발송 상태

  • 대기 (waiting)

  • 발송중 (sending)

  • 완료 (completed)

  • 실패 (fail)

  • 취소 (cancel)

receiver

String

false

수신자

  • format : 010-0000-0000

channelId

String

false

카카오톡 채널 ID

senderKey

String

false

카카오톡 발신프로필키

templateCode

String

false

카카오톡 알림톡 템플릿 코드

yyyyMM

String

false

발송 연월

requestDate

String

false

발송 요청일 검색기간

  • format : yyyyMMdd~yyyyMMdd

scheduledDate

String

false

발송 예정일 검색기간

  • format : yyyyMMdd~yyyyMMdd

completedDate

String

false

발송 완료일 검색기간

  • format : yyyyMMdd~yyyyMMdd

[Response]

Code Block
{
    "time": String,
    "result": String,
    "resultMessage": String,
    "locale": String,
    "totalCount": Integer,
    "resultCount": Integer,
    "pageSize": Integer,
    "pageCount": Integer,
    "currentPage": Integer,
    "items": [
        {
            "id": String,
            "label": String,
            "messageId": String,
            "requestId": String,
            "messageProductType": {
                "value": String,
                "label": String
            },
            "sendingStatus": {
                "value": String,
                "label": String
            },
            "receiver": String,
            "channelId": String,
            "senderKey": String,
            "templateCode": String,
            "yyyyMM": String,
            "requestDate": String,
            "scheduledDate": String,
            "completedDate": String,
            "subject": String,
            "content": String
        }
    ]
}

Name

Type

Required

Description

totalCount

Integer

true

총 건수

resultCount

Integer

true

현재 조회중 건수

pageSize

Integer

true

페이지 조회 건수

pageCount

Integer

true

총 페이지 수

currentPage

Integer

true

현재 페이지 번호

items

Object

false

메시지 정보

– id

String

false

ID

– messageId

String

true

발신 메시지 ID

– requestId

String

true

발신 요청 ID

– messageProductType

Object

true

메시지 상품 유형

  • SMS (sms)

  • LMS (lms)

  • MMS (mms)

  • Email (email)

  • Push (push)

  • 알림톡 (alimTalk)

  • 친구톡 Text (friendTalkText)

  • 친구톡 Image(friendTalkImage)

  • 친구톡 Wide Image(friendTalkWideImage)

– – value

String

true

메시지 상품 유형 코드

– – label

String

true

메시지 상품 유형 명

– sendingStatus

Object

true

발송 상태

  • 대기 (waiting)

  • 발송중 (sending)

  • 완료 (completed)

  • 실패 (fail)

  • 취소 (cancel)

– – value

String

true

발송 상태 코드

– – label

String

true

발송 상태 명

– receiver

String

true

수신자

  • format : 010-0000-0000

– channelId

String

false

카카오톡 채널 ID

– senderKey

String

false

카카오톡 발신프로필키

– templateCode

String

false

카카오톡 알림톡 템플릿 코드

– yyyyMM

String

true

발송 연월

– requestDate

String

true

발송 요청일

– scheduledDate

String

true

발송 예정일

– completedDate

String

false

발송 완료일

– subject

String

false

제목

– content

String

true

메시지 본문