카카오모먼트

메시지 관리

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

메시지 버튼 쿠폰 목록 조회

기본 정보

메서드	URL	인증 방식
`GET`	`https://apis.moment.kakao.com/openapi/v4/messages/coupons`	비즈니스 토큰

권한	사전 설정	비즈니스 인증	비즈니스 동의항목
필요: 사용 권한 신청	비즈 앱 전환 비즈니스 인증 리다이렉트 URI 비즈니스 동의항목	필요	필요

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

비즈니스 토큰을 헤더에 담아 GET으로 요청합니다. profileId 파라미터로 메시지 버튼 쿠폰 목록을 조회할 카카오톡 채널의 프로필 ID를 전달해야 합니다.

요청이 성공하면 응답 본문에 JSON 객체로 쿠폰의 목록을 받습니다. 실패 시 에러 코드에서 원인을 확인합니다.

요청

헤더

이름	설명	필수
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` 인증 방식, 비즈니스 토큰으로 인증 요청	O

쿼리 파라미터

이름	타입	설명	필수
profileId	`Long`	카카오톡 채널 프로필 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	인증 방식
`GET`	`https://apis.moment.kakao.com/openapi/v4/messages/coupons/${ID}`	비즈니스 토큰

권한	사전 설정	비즈니스 인증	비즈니스 동의항목
필요: 사용 권한 신청	비즈 앱 전환 비즈니스 인증 리다이렉트 URI 비즈니스 동의항목	필요	필요

메시지 소재의 버튼으로 설정 가능한 쿠폰을 상세 조회합니다.

조회할 쿠폰 ID를 요청 URL에 포함하고 비즈니스 토큰을 헤더에 담아 GET으로 요청합니다. 특정 카카오톡 채널의 쿠폰을 조회하려면 profileId 파라미터로 카카오톡 채널 프로필 ID를 전달합니다.

요청이 성공하면 응답 본문에 JSON 객체로 쿠폰의 상세 정보를 받습니다. 실패 시 에러 코드에서 원인을 확인합니다.

요청

헤더

이름	설명	필수
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` 인증 방식, 비즈니스 토큰으로 인증 요청	O

경로 변수

이름	타입	설명	필수
ID	`Long`	쿠폰 ID	O

쿼리 파라미터

이름	타입	설명	필수
profileId	`Long`	카카오톡 채널 프로필 ID 참고: 카카오톡 채널 프로필 ID 확인 방법	O

응답

본문

이름	타입	설명
id	`Long`	쿠폰 ID
title	`String`	쿠폰 제목
content	`String`	쿠폰 내용
statusCode	`String`	쿠폰의 상태
permalink	`String`	쿠폰 링크
entryImage	`EntryImage`	쿠폰 상세 이미지
createdAt	`String`	쿠폰 생성일시

예제

요청

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	인증 방식
`GET`	`https://apis.moment.kakao.com/openapi/v4/messages/adViews`	비즈니스 토큰

권한	사전 설정	비즈니스 인증	비즈니스 동의항목
필요: 사용 권한 신청	비즈 앱 전환 비즈니스 인증 리다이렉트 URI 비즈니스 동의항목	필요	필요

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

비즈니스 토큰과 광고계정 ID를 헤더에 담아 GET으로 요청합니다. 요청이 성공하면 응답 본문에 JSON 객체로 애드뷰 목록을 받습니다. 실패 시 에러 코드에서 원인을 확인합니다.

요청

헤더

이름	설명	필수
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` 인증 방식, 비즈니스 토큰으로 인증 요청	O
adAccountId	`adAccountId: ${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	인증 방식
`GET`	`https://apis.moment.kakao.com/openapi/v4/messages/posts/${PROFILE_ID}`	비즈니스 토큰

권한	사전 설정	비즈니스 인증	비즈니스 동의항목
필요: 사용 권한 신청	비즈 앱 전환 비즈니스 인증 리다이렉트 URI 비즈니스 동의항목	필요	필요

메시지 소재의 버튼으로 설정 가능한 카카오톡 채널의 소식 목록을 조회할 수 있습니다.

조회 대상 카카오톡 채널의 프로필 ID를 요청 URL에 포함하고 비즈니스 토큰과 광고계정 ID를 헤더에 담아 GET으로 요청합니다. 요청이 성공하면 응답 본문에 JSON 객체로 소식의 목록을 받습니다. 실패 시 에러 코드에서 원인을 확인합니다.

요청

헤더

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

경로 변수

이름	타입	설명	필수
PROFILE_ID	`String`	카카오톡 채널 프로필 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	인증 방식
`GET`	`https://apis.moment.kakao.com/openapi/v4/messages/bizForms`	비즈니스 토큰

권한	사전 설정	비즈니스 인증	비즈니스 동의항목
필요: 사용 권한 신청	비즈 앱 전환 비즈니스 인증 리다이렉트 URI 비즈니스 동의항목	필요	필요

메시지 소재의 버튼으로 설정 가능한 비즈니스폼 목록을 조회할 수 있습니다.

비즈니스 토큰과 광고계정 ID를 헤더에 담아 GET으로 요청합니다. 요청이 성공하면 응답 본문에 JSON 객체로 비즈니스폼의 목록을 받습니다. 실패 시 에러 코드에서 원인을 확인합니다.

요청

헤더

이름	설명	필수
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` 인증 방식, 비즈니스 토큰으로 인증 요청	O
adAccountId	`adAccountId: ${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	인증 방식
`GET`	`https://apis.moment.kakao.com/openapi/v4/messages/bizForms/${BIZ_FORM_ID}`	비즈니스 토큰

권한	사전 설정	비즈니스 인증	비즈니스 동의항목
필요: 사용 권한 신청	비즈 앱 전환 비즈니스 인증 리다이렉트 URI 비즈니스 동의항목	필요	필요

메시지 소재의 버튼으로 설정 가능한 비즈니스폼을 조회할 수 있습니다.

조회 대상 비즈니스폼의 ID를 요청 URL에 포함하고 비즈니스 토큰과 광고계정 ID를 헤더에 담아 GET으로 요청합니다. 실패 시 에러 코드에서 원인을 확인합니다.

요청

헤더

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

경로 변수

이름	타입	설명	필수
BIZ_FORM_ID	`Long`	비즈니스폼 ID	O

응답

본문

이름	타입	설명
id	`Long`	모먼트에 연동된 비즈니스폼 ID 메시지 소재 생성시 필요한 ID
adAccountId	`Long`	광고계정 ID
bizFormId	`Long`	비즈니스폼 ID
title	`String`	비즈니스폼 제목
flowType	`String`	비즈니스폼 유형, 아래 중 하나 `APPLY`(바로응모형) `SURVEY`(설문조사형) `RESERV`(신청예약형)
linkedDate	`String`	모먼트에 연동된 일시 `yyyy-MM-dd'T'HH:mm:ss` 형식
beginDate	`String`	비즈니스폼 시작일 `yyyy-MM-dd'T'HH:mm:ss` 형식
endDate	`String`	비즈니스폼 종료일 `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"
}

사이드 메뉴

시작하기

카카오디벨로퍼스

로그인

커뮤니케이션

카카오맵

내비게이션

광고

검색

더 보기

메시지 관리

메시지 버튼 쿠폰 목록 조회

기본 정보

요청

헤더

쿼리 파라미터

응답

본문

예제

요청

응답

메시지 버튼 쿠폰 상세 조회

기본 정보

요청

헤더

경로 변수

쿼리 파라미터

응답

본문

예제

요청

응답

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

기본 정보

요청

헤더

응답

본문

예제

요청

응답

메시지 버튼 소식 목록 조회

기본 정보

요청

헤더

경로 변수

응답

본문

예제

요청

응답

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

기본 정보

요청

헤더

응답

본문

예제

요청

응답

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

기본 정보

요청

헤더

경로 변수

응답

본문

예제

요청

응답

더 보기

도움이 되었나요?

메시지 관리