본문 바로가기메인 메뉴 바로가기사이드 메뉴 바로가기

kakao developers

관련사이트
  • 문서
  • 카카오모먼트
  • 메시지 관리

사이드 메뉴

문서 홈

시작하기

카카오디벨로퍼스

로그인

커뮤니케이션

광고

지도

내비게이션

검색

더 보기

카카오모먼트

메시지 관리

이 문서는 메시지 관리 API 사용 방법을 안내합니다.

메시지 버튼 쿠폰 목록 조회

기본 정보
메서드URL인증 방식
GEThttps://apis.moment.kakao.com/openapi/v4/messages/coupons비즈니스 토큰
권한사전 설정비즈니스 인증비즈니스 동의항목
필요: 사용 권한 신청비즈 앱 전환
비즈니스 인증 리다이렉트 URI
비즈니스 동의항목		필요필요

메시지 소재의 버튼으로 설정 가능한 쿠폰 목록을 반환합니다.

요청

헤더
이름설명필수
AuthorizationAuthorization: Bearer ${BUSINESS_ACCESS_TOKEN}
인증 방식, 비즈니스 토큰으로 인증 요청		O
쿼리 파라미터
이름타입설명필수
profileIdLong카카오톡 채널 프로필 ID

참고: 카카오톡 채널 프로필 ID 확인 방법		O

응답

본문
이름타입설명
-ChannelCoupon[]쿠폰 정보 목록

예제

요청
curl -X GET "https://apis.moment.kakao.com/openapi/v4/messages/coupons?profileId=${PROFILE_ID}" \

    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}"
응답
// HTTP/1.1 200 OK

// Content-Type: application/json;charset=UTF-8

[

  {

    "id": 12345,

    "title": "첫 번째 테스트 쿠폰",

    "content": "첫 번째 테스트 쿠폰입니다.",

    "statusCode": "done",

    "permalink": "http://xxx.kakao.com/_xxx/coupons/_xxx",

    "entryImage": {

      "type": "image",

      "url": "http://xxx.kakao.com/img_xl.jpg",

      "thumbnail": null,

      "previewImage": null,

      "playUrl": null,

      "name": null

    },

    "createdAt": "2021-01-11T15:43:12"

  },

  {

    "id": 12346,

    "title": "두번째 테스트 쿠폰",

    "content": "두번째 테스트 쿠폰입니다.",

    "statusCode": "done",

    "permalink": "http://xxx.kakao.com/_xxx/coupons/_xxx",

    "entryImage": {

      "type": "image",

      "url": "http://xxx.kakao.com/img_xl.jpg",

      "thumbnail": null,

      "previewImage": null,

      "playUrl": null,

      "name": null

    },

    "createdAt": "2021-01-11T15:43:12"

  }

]

메시지 버튼 쿠폰 상세 조회

기본 정보
메서드URL인증 방식
GEThttps://apis.moment.kakao.com/openapi/v4/messages/coupons/${ID}비즈니스 토큰
권한사전 설정비즈니스 인증비즈니스 동의항목
필요: 사용 권한 신청비즈 앱 전환
비즈니스 인증 리다이렉트 URI
비즈니스 동의항목		필요필요

메시지 소재의 버튼으로 설정 가능한 쿠폰 상세 정보를 반환합니다.

요청

헤더
이름설명필수
AuthorizationAuthorization: Bearer ${BUSINESS_ACCESS_TOKEN}
인증 방식, 비즈니스 토큰으로 인증 요청		O
경로 변수
이름타입설명필수
IDLong쿠폰 IDO
쿼리 파라미터
이름타입설명필수
profileIdLong카카오톡 채널 프로필 ID

참고: 카카오톡 채널 프로필 ID 확인 방법		O

응답

본문
이름타입설명
idLong쿠폰 ID
titleString쿠폰 제목
contentString쿠폰 내용
statusCodeString쿠폰의 상태
permalinkString쿠폰 링크
entryImageEntryImage쿠폰 상세 이미지
createdAtString쿠폰 생성일시

예제

요청
curl -X GET "https://apis.moment.kakao.com/openapi/v4/messages/coupons/${ID}?profileId=${PROFILE_ID}" \

    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}"
응답
// HTTP/1.1 200 OK

// Content-Type: application/json;charset=UTF-8

{

  "id": 12345,

  "title": "테스트 쿠폰입니다.",

  "content": "테스트입니다.",

  "statusCode": "done",

  "permalink": "http://xxx.kakao.com/xxx/coupons/xxx",

  "entryImage": null,

  "createdAt": "2021-02-26T16:12:31"

}

메시지 버튼 애드뷰 목록 조회

기본 정보
메서드URL인증 방식
GEThttps://apis.moment.kakao.com/openapi/v4/messages/adViews비즈니스 토큰
권한사전 설정비즈니스 인증비즈니스 동의항목
필요: 사용 권한 신청비즈 앱 전환
비즈니스 인증 리다이렉트 URI
비즈니스 동의항목		필요필요

메시지 소재의 버튼으로 설정 가능한 애드뷰 목록을 반환합니다.

요청

헤더
이름설명필수
AuthorizationAuthorization: Bearer ${BUSINESS_ACCESS_TOKEN}
인증 방식, 비즈니스 토큰으로 인증 요청		O
adAccountIdadAccountId: ${AD_ACCOUNT_ID}
광고계정 ID		O

응답

본문
이름타입설명
-AdView[]애드뷰 목록

예제

요청
curl -X GET "https://apis.moment.kakao.com/openapi/v4/messages/adViews" \

    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}"

    -H "adAccountId: ${AD_ACCOUNT_ID}"
응답
// HTTP/1.1 200 OK

// Content-Type: application/json;charset=UTF-8

[

  {

    "id": 1234,

    "name": "애드뷰1",

    "type": "COMPACT",

    "templateType": "IMAGE"

  },

  {

    "id": 5678,

    "name": "애드뷰2",

    "type": "COMPACT",

    "templateType": "IMAGE"

  }

]

메시지 버튼 소식 목록 조회

기본 정보
메서드URL인증 방식
GEThttps://apis.moment.kakao.com/openapi/v4/messages/posts/${PROFILE_ID}비즈니스 토큰
권한사전 설정비즈니스 인증비즈니스 동의항목
필요: 사용 권한 신청비즈 앱 전환
비즈니스 인증 리다이렉트 URI
비즈니스 동의항목		필요필요

메시지 소재의 버튼으로 설정 가능한 카카오톡 채널의 소식 목록을 반환합니다.

요청

헤더
이름설명필수
AuthorizationAuthorization: Bearer ${BUSINESS_ACCESS_TOKEN}
인증 방식, 비즈니스 토큰으로 인증 요청		O
adAccountIdadAccountId: ${AD_ACCOUNT_ID}
광고계정 ID		O
경로 변수
이름타입설명필수
PROFILE_IDString카카오톡 채널 프로필 ID

참고: 카카오톡 채널 프로필 ID 확인 방법		O

응답

본문
이름타입설명
-ChannelPost[]소식 목록

예제

요청
curl -X GET "https://apis.moment.kakao.com/openapi/v4/messages/posts/${PROFILE_ID}" \

    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \

    -H "adAccountId: ${AD_ACCOUNT_ID}"
응답
// HTTP/1.1 200 OK

// Content-Type: application/json;charset=UTF-8

[

  {

    "id": 1234,

    "title": "소식",

    "status": "published",

    "permalink": "http://kakao.com/_xxxx/1",

    "createdDate": "2021-01-01T00:00:00",

    "publishedDate": "2021-01-01T00:00:00"

  },

  {

    "id": 1235,

    "title": "소식 2",

    "status": "published",

    "permalink": "http://kakao.com/_xxxx/2",

    "createdDate": "2021-01-02T00:00:00",

    "publishedDate": "2021-01-02T00:00:00"

  }

]

메시지 버튼 비즈니스폼 목록 조회

기본 정보
메서드URL인증 방식
GEThttps://apis.moment.kakao.com/openapi/v4/messages/bizForms비즈니스 토큰
권한사전 설정비즈니스 인증비즈니스 동의항목
필요: 사용 권한 신청비즈 앱 전환
비즈니스 인증 리다이렉트 URI
비즈니스 동의항목		필요필요

메시지 소재의 버튼으로 설정 가능한 비즈니스폼 목록을 반환합니다.

요청

헤더
이름설명필수
AuthorizationAuthorization: Bearer ${BUSINESS_ACCESS_TOKEN}
인증 방식, 비즈니스 토큰으로 인증 요청		O
adAccountIdadAccountId: ${AD_ACCOUNT_ID}
광고계정 ID		O

응답

본문
이름타입설명
-BusinessForm[]비즈니스폼 목록

예제

요청
curl -X GET "https://apis.moment.kakao.com/openapi/v4/messages/bizForms" \

    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \

    -H "adAccountId: ${AD_ACCOUNT_ID}"
응답
// HTTP/1.1 200 OK

// Content-Type: application/json;charset=UTF-8

[

  {

    "id": 1,

    "adAccountId": 1234,

    "bizFormId": 10,

    "title": "비즈니스폼",

    "flowType": "APPLY",

    "linkedDate": "2021-06-15T23:59:59",

    "beginDate": "2021-06-15T23:59:59",

    "endDate": "2021-06-15T23:59:59"

  },

  {

    "id": 2,

    "adAccountId": 1235,

    "bizFormId": 11,

    "title": "비즈니스폼2",

    "flowType": "BANANA",

    "linkedDate": "2021-06-16T23:59:59",

    "beginDate": "2021-06-16T23:59:59",

    "endDate": "2021-06-16T23:59:59"

  }

]

메시지 버튼 비즈니스폼 상세 조회

기본 정보
메서드URL인증 방식
GEThttps://apis.moment.kakao.com/openapi/v4/messages/bizForms/${BIZ_FORM_ID}비즈니스 토큰
권한사전 설정비즈니스 인증비즈니스 동의항목
필요: 사용 권한 신청비즈 앱 전환
비즈니스 인증 리다이렉트 URI
비즈니스 동의항목		필요필요

메시지 소재의 버튼으로 설정 가능한 비즈니스폼을 반환합니다.

요청

헤더
이름설명필수
AuthorizationAuthorization: Bearer ${BUSINESS_ACCESS_TOKEN}
인증 방식, 비즈니스 토큰으로 인증 요청		O
adAccountIdadAccountId: ${AD_ACCOUNT_ID}
광고계정 ID		O
경로 변수
이름타입설명필수
BIZ_FORM_IDLong비즈니스폼 IDO

응답

본문
이름타입설명
idLong모먼트에 연동된 비즈니스폼 ID
메시지 소재 생성시 필요한 ID
adAccountIdLong광고계정 ID
bizFormIdLong비즈니스폼 ID
titleString비즈니스폼 제목
flowTypeString비즈니스폼 유형, 아래 중 하나
  • APPLY(바로응모형)
  • SURVEY(설문조사형)
  • RESERV(신청예약형)
linkedDateString모먼트에 연동된 일시
yyyy-MM-dd'T'HH:mm:ss 형식
beginDateString비즈니스폼 시작일
yyyy-MM-dd'T'HH:mm:ss 형식
endDateString비즈니스폼 종료일
yyyy-MM-dd'T'HH:mm:ss 형식

예제

요청
curl -X GET "https://apis.moment.kakao.com/openapi/v4/messages/bizForms/${ID}" \

    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \

    -H "adAccountId: ${AD_ACCOUNT_ID}"
응답
// HTTP/1.1 200 OK

// Content-Type: application/json;charset=UTF-8

{

  "id": 1,

  "adAccountId": 1234,

  "bizFormId": 10,

  "title": "비즈니스폼",

  "flowType": "APPLY",

  "linkedDate": "2021-06-15T23:59:59",

  "beginDate": "2021-06-15T23:59:59",

  "endDate": "2021-06-15T23:59:59"

}

더 보기

도움이 되었나요?

    카카오모먼트 > 메시지 관리 - 카카오디벨로퍼스 | 문서