내 애플리케이션: 메시지 템플릿

신규 어드민 API 제공

이 문서는 제공 종료된 구버전 어드민 API에 대해 안내합니다. 신규 어드민 API에 대한 자세한 내용은 신규 어드민 API 제공 안내에서 확인할 수 있습니다.

이 문서는 카카오디벨로퍼스 앱(애플리케이션)의 메시지 템플릿에 대한 어드민 API 사용 방법을 안내합니다.

메시지 템플릿 관리

요청

:app_id 부분에 요청 대상 앱 ID를 입력해야 합니다.

메서드	호스트	리소스
`POST`	`internal-admin-kapi.kakao.com`	`/app/:app_id/messageTemplate`

* 모든 어드민 API는 사내망에서만 호출 가능, 인증 필요

액션

이름	설명
FIND_ALL	앱의 모든 메시지 템플릿 정보를 조회합니다.
CREATE	새로운 메시지 탬플릿을 생성합니다.

FIND_ALL

앱의 모든 메시지 템플릿 정보를 조회합니다.

요청 처리 성공 시 응답은 앱의 메시지 템플릿 정보 목록을 배열로 payload에 포함합니다.

요청 페이로드

없음

응답 페이로드

TalkMessageTemplate[]

요청 예제

curl -v -X POST "https://internal-admin-kapi.kakao.com/app/:app_id/messageTemplate" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND_ALL"
    }'

응답 예제

// HTTP/2 200
[
  {
    "id": 275472,
    "app_id": 1239848,
    "type": "BOTH",
    "subtype": "NONE",
    "deny": false,
    "template": {
      // ...
    },
    "status": "ACTIVE",
    "callback": false,
    "sender_type": "USER",
    "version": "4.0",
    "description": "Test",
    "created_at": "2023-05-10T05:23:34Z",
    "updated_at": "2023-05-10T05:53:14Z"
  },
  {
    "id": 285433,
    "app_id": 1239848,
    "type": "BOTH",
    "subtype": "NONE",
    "deny": false,
    "template": {
      // ...
    },
    "status": "ACTIVE",
    "callback": false,
    "sender_type": "USER",
    "version": "4.0",
    "description": "Test",
    "created_at": "2023-05-10T05:23:34Z",
    "updated_at": "2023-05-10T05:53:14Z"
  }
  // ...
]

CREATE

앱에 메시지 템플릿을 생성합니다.

요청 처리 성공 시 응답은 생성한 메시지 템플릿 정보를 payload에 포함합니다.

요청 페이로드

이름	타입	설명	필수
type	`MessageType`	메시지 발송 대상 유형	O
subtype	`String`	메시지 템플릿 UI 상태 분류 코드	O
deny	`Boolean`	메시지 템플릿의 기타 항목 사용 여부 `true`: 사용함 `false`: 사용 안함	X
template	`JSON`	메시지 템플릿 데이터	O
sender_type	`SenderType`	메시지 전송에 사용할 API	X
description	`String`	메시지 템플릿 설명(최대 45자)	X

응답 페이로드

TalkMessageTemplate

요청 예제

curl -v -X POST "https://internal-admin-kapi.kakao.com/app/:app_id/messageTemplate" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "CREATE",
        "payload": {
            "type": "BOTH",
            "subtype": "NONE",
            "deny": false,
            "template": "{
            ...
            }",
            "callback": false,
            "sender_type": "USER",
            "description": "Message for test"
    }'

응답 예제

// HTTP/2 200
{
  "id": 280066,
  "app_id": 1239848,
  "type": "BOTH",
  "subtype": "NONE",
  "deny": false,
  "template": {
    // ...
  },
  "status": "ACTIVE",
  "callback": false,
  "sender_type": "USER",
  "version": "4.0",
  "created_at": "2023-06-14T08:15:47Z",
  "updated_at": "2023-06-14T08:15:47Z"
}

개별 메시지 템플릿 관리

요청

:app_id 부분에 요청 대상 앱 ID를 입력해야 합니다.
:template_id 부분에 요청 대상 메시지 템플릿 ID를 입력해야 합니다.

메서드	호스트	리소스
`POST`	`internal-admin-kapi.kakao.com`	`/app/:app_id/messageTemplate/:template_id`

* 모든 어드민 API는 사내망에서만 호출 가능, 인증 필요

액션

이름	설명
FIND	메시지 템플릿 ID에 해당하는 메시지 템플릿 정보를 조회합니다.
UPDATE	메시지 템플릿 ID에 해당하는 메시지 템플릿 정보를 변경합니다.
DELETE	메시지 템플릿 ID에 해당하는 메시지 템플릿을 삭제합니다.
VALIDATE	메시지 템플릿 ID에 해당하는 메시지 템플릿의 유효성을 검사합니다.
VALIDATE_AND_UPDATE	메시지 템플릿 ID에 해당하는 메시지 템플릿의 유효성을 검사하고 유효한 경우 저장합니다.

FIND

메시지 템플릿 ID에 해당하는 메시지 템플릿 정보를 조회합니다.

요청 처리 성공 시 응답은 변경한 메시지 템플릿 정보를 payload에 포함합니다.

요청 페이로드

없음

응답 페이로드

TalkMessageTemplate

요청 예제

curl -v -X POST "https://internal-admin-kapi.kakao.com/app/:app_id/messageTemplate/:template_id" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "FIND"
    }'

응답 예제

// HTTP/2 200
{
  "id": 275472,
  "app_id": 1239848,
  "type": "BOTH",
  "subtype": "NONE",
  "deny": false,
  "template": {},
  "status": "ACTIVE",
  "callback": false,
  "sender_type": "USER",
  "version": "4.0",
  "description": "Message for test",
  "created_at": "2023-05-10T05:23:34Z",
  "updated_at": "2023-06-15T04:48:22Z"
}

UPDATE

메시지 템플릿 ID에 해당하는 메시지 템플릿 정보를 변경합니다.

요청 처리 성공 시 응답은 변경한 메시지 템플릿 정보를 payload에 포함합니다.

요청 페이로드

이름	타입	설명	필수
type	`MessageType`	메시지 발송 대상 유형	O
subtype	`String`	메시지 템플릿 UI 상태 분류 코드	O
deny	`Boolean`	메시지 템플릿의 기타 항목 사용 여부 `true`: 사용함 `false`: 사용 안함	X
template	`JSON`	메시지 템플릿 데이터	O
sender_type	`SenderType`	메시지 전송에 사용할 API	X
description	`String`	메시지 템플릿 설명	X

응답 페이로드

TalkMessageTemplate

요청 예제

curl -v -X POST "https://internal-admin-kapi.kakao.com/app/:app_id/messageTemplate/:template_id" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "UPDATE",
        "payload": {
            "type": "BOTH",
            "subtype": "NONE",
            "deny": false,
            "template": "{}",
            "callback": false,
            "sender_type": "USER",
            "description": "Message for test"
    }'

응답 예제

// HTTP/2 200
{
  "id": 275472,
  "app_id": 1239848,
  "type": "BOTH",
  "subtype": "NONE",
  "deny": false,
  "template": {},
  "status": "ACTIVE",
  "callback": false,
  "sender_type": "USER",
  "version": "4.0",
  "description": "Message for test",
  "created_at": "2023-05-10T05:23:34Z",
  "updated_at": "2023-06-15T04:48:22Z"
}

DELETE

메시지 템플릿 ID에 해당하는 메시지 템플릿을 삭제합니다.

요청 처리 성공 시 응답은 삭제한 메시지 템플릿 정보를 payload에 포함합니다.

요청 페이로드

없음

응답 페이로드

TalkMessageTemplate

요청 예제

curl -v -X POST "https://internal-admin-kapi.kakao.com/app/:app_id/messageTemplate/:template_id" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "DELETE"
    }'

응답 예제

// HTTP/2 200
{
  "id": 275472,
  "app_id": 1239848,
  "type": "BOTH",
  "subtype": "NONE",
  "deny": false,
  "template": {},
  "status": "ACTIVE",
  "callback": false,
  "sender_type": "USER",
  "version": "4.0",
  "description": "Message for test",
  "created_at": "2023-05-10T05:23:34Z",
  "updated_at": "2023-06-15T04:52:24Z"
}

VALIDATE

메시지 템플릿 ID에 해당하는 메시지 템플릿의 유효성을 검사합니다.

요청 처리 성공 시 응답은 메시지 템플릿의 유효성 검사 결과를 payload에 포함합니다.

요청 페이로드

없음

응답 페이로드

TalkMessageTemplateResult

요청 예제

curl -v -X POST "https://internal-admin-kapi.kakao.com/app/:app_id/messageTemplate/:template_id" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "VALIDATE"
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 1239848,
  "id": 280530,
  "template": {
    // ...
  },
  "argument_keys": [],
  "warning": {}
}

VALIDATE_AND_UPDATE

메시지 템플릿 ID에 해당하는 메시지 템플릿의 유효성을 검사하고 유효한 경우 저장합니다.

요청 처리 성공 시 응답은 유효성을 검사하고 저장한 메시지 템플릿 정보를 payload에 포함합니다.

요청 페이로드

없음

응답 페이로드

TalkMessageTemplateResult

요청 예제

curl -v -X POST "https://internal-admin-kapi.kakao.com/app/:app_id/messageTemplate/:template_id" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "ADMIN-API-META-RENDER: simple" \
  -u "${GROUP_NAME}:${GROUP_TOKEN}" \
  -H "ADMIN-API-USERID: ${USER_INFO}" \
  -d $'{
        "name": "VALIDATE_AND_UPDATE"
    }'

응답 예제

// HTTP/2 200
{
  "app_id": 1239848,
  "id": 280530,
  "template": {
    // ...
  },
  "argument_keys": [],
  "warning": {}
}

사이드 메뉴

오픈 문서

시작하기

카카오디벨로퍼스

로그인

커뮤니케이션

인공지능

플랫폼 API

API 제공

전용 API

어드민 API

더 보기

내 애플리케이션: 메시지 템플릿

메시지 템플릿 관리

요청

액션

FIND_ALL

요청 페이로드

응답 페이로드

요청 예제

응답 예제

CREATE

요청 페이로드

응답 페이로드

요청 예제

응답 예제

개별 메시지 템플릿 관리

요청

액션

FIND

요청 페이로드

응답 페이로드

요청 예제

응답 예제

UPDATE

요청 페이로드

응답 페이로드

요청 예제

응답 예제

DELETE

요청 페이로드

응답 페이로드

요청 예제

응답 예제

VALIDATE

요청 페이로드

응답 페이로드

요청 예제

응답 예제

VALIDATE_AND_UPDATE

요청 페이로드

응답 페이로드

요청 예제

응답 예제

도움이 되었나요?