Notification > KakaoTalk Bizmessage > Alimtalk > API v1.1 Guide

알림톡

[API 도메인]

도메인
https://api-alimtalk.cloud.toast.com

메시지

메시지 치환 발송 요청

[URL]

POST  /alimtalk/v1.1/appkeys/{appkey}/messages
Content-Type: application/json;charset=UTF-8

[Path parameter]

타입 설명
appkey String 고유의 appkey

[Header]

{
  "X-Secret-Key": String
}
타입 필수 설명
X-Secret-Key String O 콘솔에서 생성할 수 있다. [참고]

[Request body]

{
    "plusFriendId": String,
    "templateCode": String,
    "requestDate": String,
    "recipientList": [{
        "recipientNo": String,
        "templateParameter": {
            String: String
        },
        "isResend" : boolean,
        "resendType" : String,
        "resendTitle" : String,
        "resendContent" : String,
        "resendSendNo" : String
    }]
}
타입 필수 설명
plusFriendId String X 플러스친구 아이디 (최대 30자)
templateCode String O 등록한 발송 템플릿 코드 (최대 20자)
requestDate String X 요청 일시 (yyyy-MM-dd HH:mm)
(입력하지 않을 경우 즉시 발송)
recipientList List O 수신자 리스트 (최대 1000명)
- recipientNo String O 수신번호 (최대 15자)
- templateParameter Object X 템플릿 파라미터
(템플릿에 치환할 변수 포함 시, 필수)
-- key String X 치환 키(#{key})
-- value String X 치환 키에 매핑되는 Value값
- isResend boolean X 발송 실패 시, 문자 대체발송 여부
Console에서 발송 실패 설정 시, default로 재발송 됩니다.
- resendType String X 대체 발송 타입 (SMS,LMS)
값이 없을 경우, 템플릿 본문 길이에 따라 타입이 구분됩니다.
- resendTitle String X LMS 대체 발송 제목 (최대 20자)
(값이 없을 경우, 플러스친구 아이디로 재발송됩니다.)
- resendContent String X 대체 발송 내용 (최대 1000자)
(값이 없을 경우, 템플릿 내용으로 재발송됩니다.)
- resendSendNo String X 대체 발송 발신번호 (최대 13자)
(SMS 상품에 등록된 발신번호가 아닐 경우, 대체발송이 실패할 수 있습니다.)
  • 플러스친구 아이디 필드를 보내지 않을 경우, 첫 번째 등록한 플러스친구로 발송됩니다.
  • 요청 일시는 호출하는 시점부터 90일 후까지 설정 가능합니다.

[예시]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" https://api-alimtalk.cloud.toast.com/alimtalk/v1.1/appkeys/{appkey}/messages -d '{"plusFriendId":"{플러스친구 아이디}","templateCode":"{템플릿 코드}","requestDate":"2018-10-01 00:00","recipientList":[{"recipientNo":"{수신번호}","templateParameter":{"{치환자 필드}":"{치환 데이터}"}}]}'

메시지 전문 발송 요청

[URL]

POST  /alimtalk/v1.1/appkeys/{appkey}/raw-messages
Content-Type: application/json;charset=UTF-8

[Path parameter]

타입 설명
appkey String 고유의 appkey

[Header]

{
  "X-Secret-Key": String
}
타입 필수 설명
X-Secret-Key String O 콘솔에서 생성할 수 있다. [참고]

[Request Body]

{
    "plusFriendId": String,
    "templateCode": String,
    "requestDate": String,
    "recipientList": [
        {
            "recipientNo": String,
            "content": String,
            "buttons": [
                {
                    "ordering": Integer,
                    "type": String,
                    "name": String,
                    "linkMo": String,
                    "linkPc": String,
                    "schemeIos": String,
                    "schemeAndroid": String
                }
            ],
            "isResend" : boolean,
            "resendType" : String,
            "resendTitle" : String,
            "resendContent" : String,
            "resendSendNo" : String
        }
    ]
}
타입 필수 설명
plusFriendId String X 플러스친구 아이디 (최대 30자)
templateCode String O 등록한 발송 템플릿 코드 (최대 20자)
requestDate String X 요청 일시 (yyyy-MM-dd HH:mm)
(입력하지 않을 경우 즉시 발송)
recipientList List O 수신자 리스트 (최대 1,000명)
- recipientNo String O 수신번호 (최대 15자)
- content String O 내용 (최대 1000자)
- buttons List X 버튼 리스트 (최대 5개)
-- ordering Integer X 버튼 순서 (버튼이 있는 경우 필수)
-- type String X 버튼 타입(WL:웹링크, AL:앱링크, DS:배송 조회, BK:봇 키워드, MD:메시지 전달)
-- name String X 버튼 이름 (버튼이 있는 경우 필수, 최대 14자)
-- linkMo String X 모바일 웹 링크 (WL 타입일 경우 필수 필드, 최대 200자)
-- linkPc String X PC 웹 링크 (WL 타입일 경우 선택 필드, 최대 200자)
-- schemeIos String X IOS 앱 링크 (AL 타입일 경우 필수 필드, 최대 200자)
-- schemeAndroid String X Android 앱 링크 (AL 타입일 경우 필수 필드, 최대 200자)
- isResend boolean X 발송 실패 시, 문자 대체발송 여부
Console에서 발송 실패 설정 시, default로 재발송 됩니다.
- resendType String X 대체 발송 타입 (SMS,LMS)
값이 없을 경우, 템플릿 본문 길이에 따라 타입이 구분됩니다.
- resendTitle String X LMS 대체 발송 제목 (최대 20자)
(값이 없을 경우, 플러스친구 아이디로 재발송됩니다.)
- resendContent String X 대체 발송 내용 (최대 1000자)
(값이 없을 경우, 템플릿 내용으로 재발송됩니다.)
- resendSendNo String X 대체 발송 발신번호 (최대 13자)
(SMS 상품에 등록된 발신번호가 아닐 경우, 대체발송이 실패할 수 있습니다.)
  • 플러스친구 아이디 필드를 보내지 않을 경우, 첫 번째 등록한 플러스친구로 발송됩니다.
  • 본문과 버튼에 치환이 완성된 데이터를 넣어주세요.
  • 요청 일시는 호출하는 시점부터 90일 후까지 설정 가능합니다.

[예시]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" https://api-alimtalk.cloud.toast.com/alimtalk/v1.1/appkeys/{appkey}/raw-messages -d '{"plusFriendId":"{플러스친구 아이디}","templateCode":"{템플릿 코드}","requestDate":"2018-10-01 00:00","recipientList":[{"recipientNo":"{수신번호}","content":"{내용}","buttons":[{"ordering":"{버튼 순서}","type":"{버튼 타입}","name":"{버튼 이름}","linkMo":"{모바일 웹 링크}"}]}]}'

응답

{
  "header": {
    "resultCode": Integer,
    "resultMessage": String,
    "isSuccessful": boolean
  },
  "message": {
    "requestId": String
  }
}
타입 설명
header Object 헤더 영역
- resultCode Integer 결과 코드
- resultMessage String 결과 메시지
- isSuccessful Boolean 성공 여부
message Object 본문 영역
- requestId String 요청 아이디

메시지 발송 취소

요청

[URL]

DELETE  /alimtalk/v1.1/appkeys/{appkey}/messages/{requestId}
Content-Type: application/json;charset=UTF-8

[Path parameter]

타입 설명
appkey String 고유의 appkey
requestId String 요청 ID

[Header]

{
  "X-Secret-Key": String
}
타입 필수 설명
X-Secret-Key String O 콘솔에서 생성할 수 있다. [참고]

[Query parameter]

타입 필수 설명
recipientSeq String X 수신자 시퀀스 번호
(입력하지 않으면 요청 ID의 모든 발송 건을 취소)

응답

{
  "header" : {
      "resultCode" :  Integer,
      "resultMessage" :  String,
      "isSuccessful" :  boolean
  }
}
타입 설명
header Object 헤더 영역
- resultCode Integer 결과 코드
- resultMessage String 결과 메시지
- isSuccessful Boolean 성공 여부

[예시]

curl -X DELETE -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" "https://api-alimtalk.cloud.toast.com/alimtalk/v1.1/appkeys/{appkey}/messages/{requestId}?recipientSeq=1,2,3"

메시지 리스트 조회

요청

[URL]

GET  /alimtalk/v1.1/appkeys/{appkey}/messages
Content-Type: application/json;charset=UTF-8

[Path parameter]

타입 설명
appkey String 고유의 appkey

[Header]

{
  "X-Secret-Key": String
}
타입 필수 설명
X-Secret-Key String O 콘솔에서 생성할 수 있다. [참고]

[Query parameter] 1번 or 2번 조건 필수

타입 필수 설명
requestId String 조건 필수 (1번) 요청 아이디
startRequestDate String 조건 필수 (2번) 발송 요청 날짜 시작 값(yyyy-MM-dd HH:mm)
endRequestDate String 조건 필수 (2번) 발송 요청 날짜 끝 값(yyyy-MM-dd HH:mm)
recipientNo String X 수신번호
plusFriendId String X 플러스친구 아이디
templateCode String X 템플릿 코드
messageStatus String X 요청 상태 ( COMPLETED -> 성공, FAILED -> 실패, CANCEL -> 취소 )
resultCode String X 발송 결과 ( MRC01 -> 성공 MRC02 -> 실패 )
pageNum Integer X 페이지 번호(Default : 1)
pageSize Integer X 조회 건수(Default : 15)

응답

{
  "header" : {
      "resultCode" :  Integer,
      "resultMessage" :  String,
      "isSuccessful" :  boolean
  },
  "messageSearchResultResponse" : {
    "messages" : [
    {
      "requestId" :  String,
      "recipientSeq" : Integer,
      "plusFriendId" :  String,
      "templateCode" :  String,
      "recipientNo" :  String,
      "content" :  String,
      "requestDate" :  String,
      "receiveDate" : String,
      "resendStatus" :  String,
      "resendStatusName" :  String,
      "messageStatus" :  String,
      "resultCode" :  String,
      "resultCodeName" : String,
      "buttons" : [
        {
          "ordering" :  Integer,
          "type" :  String,
          "name" :  String,
          "linkMo" :  String,
          "linkPc": String,
          "schemeIos": String,
          "schemeAndroid": String
        }
      ]
    }
    ],
    "totalCount" :  Integer
  }
}
타입 설명
header Object 헤더 영역
- resultCode Integer 결과 코드
- resultMessage String 결과 메시지
- isSuccessful Boolean 성공 여부
messageSearchResultResponse Object 본문 영역
- messages List 메시지 리스트
-- requestId String 요청 아이디
-- recipientSeq Integer 수신자 시퀀스 번호
-- plusFriendId String 플러스친구 아이디
-- templateCode String 템플릿 코드
-- recipientNo String 수신 번호
-- content String 본문
-- requestDate String 요청 일시
-- receiveDate String 수신 일시
-- resendStatus String 재발송 상태 코드
-- resendStatusName String 재발송 상태 코드명
-- messageStatus String 요청 상태 ( COMPLETED -> 성공, FAILED -> 실패, CANCEL -> 취소 )
-- resultCode String 수신 결과 코드
-- resultCodeName String 수신 결과 코드명
-- buttons List 버튼 리스트
--- ordering Integer 버튼 순서
--- type String 버튼 타입(WL:웹링크, AL:앱링크, DS:배송 조회, BK:봇 키워드, MD:메시지 전달)
--- name String 버튼 이름
--- linkMo String 모바일 웹 링크 (WL 타입일 경우 필수 필드)
--- linkPc String PC 웹 링크 (WL 타입일 경우 선택 필드)
--- schemeIos String IOS 앱 링크 (AL 타입일 경우 필수 필드)
--- schemeAndroid String Android 앱 링크 (AL 타입일 경우 필수 필드)
- totalCount Integer 총 개수

[예시]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" "https://api-alimtalk.cloud.toast.com/alimtalk/v1.1/appkeys/{appkey}/messages?startRequestDate=2018-05-01%20:00&endRequestDate=2018-05-30%20:59"

SMS/LMS 재발송 상태

설명
RSC01 재발송 미대상
RSC02 재발송 대상 (발송 결과 실패 시, 재발송이 진행됩니다.)
RSC03 재발송 중
RSC04 재발송 성공
RSC05 재발송 실패

메시지 단건 조회

요청

[URL]

GET  /alimtalk/v1.1/appkeys/{appkey}/message/{requestId}/{recipientSeq}
Content-Type: application/json;charset=UTF-8

[Path parameter]

타입 설명
appkey String 고유의 appkey
requestId String 요청 아이디
recipientSeq Integer 수신자 시퀀스 번호

[Header]

{
  "X-Secret-Key": String
}
타입 필수 설명
X-Secret-Key String O 콘솔에서 생성할 수 있다. [참고]

[예시]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" "https://api-alimtalk.cloud.toast.com/alimtalk/v1.1/appkeys/{appkey}/message/{requestId}/{recipientSeq}"

응답

{
  "header" : {
      "resultCode" :  Integer,
      "resultMessage" :  String,
      "isSuccessful" :  boolean
  },
  "message" : {
      "requestId" :  String,
      "recipientSeq" : Integer,
      "plusFriendId" :  String,
      "templateCode" :  String,
      "recipientNo" :  String,
      "content" :  String,
      "requestDate" :  String,
      "receiveDate" : String,
      "resendStatus" :  String,
      "resendStatusName" :  String,
      "messageStatus" :  String,
      "resultCode" :  String,
      "resultCodeName" : String,
      "buttons" : [
        {
          "ordering" :  Integer,
          "type" :  String,
          "name" :  String,
          "linkMo" :  String,
          "linkPc": String,
          "schemeIos": String,
          "schemeAndroid": String
        }
      ]
  }
}
타입 설명
header Object 헤더 영역
- resultCode Integer 결과 코드
- resultMessage String 결과 메시지
- isSuccessful Boolean 성공 여부
message Object 메시지
- requestId String 요청 아이디
- recipientSeq Integer 수신자 시퀀스 번호
- plusFriendId String 플러스친구 아이디
- templateCode String 템플릿 코드
- recipientNo String 수신 번호
- content String 본문
- requestDate String 요청 일시
- receiveDate String 수신 일시
- resendStatus String 재발송 상태 코드
- resendStatusName String 재발송 상태 코드명
- messageStatus String 요청 상태 ( COMPLETED -> 성공, FAILED -> 실패, CANCEL -> 취소 )
- resultCode String 수신 결과 코드
- resultCodeName String 수신 결과 코드명
- buttons List 버튼 리스트
-- ordering Integer 버튼 순서
-- type String 버튼 타입(WL:웹링크, AL:앱링크, DS:배송 조회, BK:봇 키워드, MD:메시지 전달)
-- name String 버튼 이름
-- linkMo String 모바일 웹 링크 (WL 타입일 경우 필수 필드)
-- linkPc String PC 웹 링크 (WL 타입일 경우 선택 필드)
-- schemeIos String IOS 앱 링크 (AL 타입일 경우 필수 필드)
-- schemeAndroid String Android 앱 링크 (AL 타입일 경우 필수 필드)

플러스친구

플러스친구 카테고리 조회

요청

[URL]

GET  /alimtalk/v1.1/appkeys/{appkey}/plus-friends/categories
Content-Type: application/json;charset=UTF-8

[Path parameter]

타입 설명
appkey String 고유의 appkey

[Header]

{
  "X-Secret-Key": String
}
타입 필수 설명
X-Secret-Key String O 콘솔에서 생성할 수 있다. [참고]

응답

{
  "header" : {
      "resultCode" :  Integer,
      "resultMessage" :  String,
      "isSuccessful" :  boolean
  },
  "categories" : [
  {
      "parentCode" : String,
      "depth" : Integer,
      "code" : String,
      "name" : String,
      "subCategories" : [
        {
        "parentCode" : String,
        "depth" : Integer,
        "code" : String,
        "name" : String,
        "subCategories" : [
          {
            "parentCode" : String,
            "depth" : Integer,
            "code" : String,
            "name" : String
          }
          ]
        }
      ]
    }
  ]
}
타입 설명
header Object 헤더 영역
- resultCode Integer 결과 코드
- resultMessage String 결과 메시지
- isSuccessful Boolean 성공 여부
categories Object 카테고리
- parentCode String 부모 코드
- depth Integer 카테고리 깊이
- code String 카테고리 코드
- name String 카테고리 이름
- subCategories Object 서브 카테고리
-- parentCode String 부모 코드
-- depth Integer 카테고리 깊이
-- code String 카테고리 코드
-- name String 카테고리 이름
-- subCategories Object 서브 카테고리
--- parentCode String 부모 코드
--- depth Integer 카테고리 깊이
--- code String 카테고리 코드
--- name String 카테고리 이름

플러스친구 사업자등록증 업로드

요청

[URL]

POST  /alimtalk/v1.1/appkeys/{appkey}/business-licenses
Content-Type: application/json;charset=UTF-8

[Path parameter]

타입 설명
appkey String 고유의 appkey

[Header]

{
  "X-Secret-Key": String
}
타입 필수 설명
X-Secret-Key String O 콘솔에서 생성할 수 있다. [참고]

[Request Body]

{
  "fileName" : String,
  "fileBody" : "{byte[] -> Base64 인코딩한 값}"
}
타입 필수 설명
fileName String O 파일 이름
fileBody Byte[] O 파일 byte[]를 Base64로 인코딩한 값.(최대 500KB)
또는 byte 배열 값

응답

{
  "header" : {
    "resultCode" :  Integer,
    "resultMessage" :  String,
    "isSuccessful" :  boolean
  },
  "attachFile" : {
    "fileSeq" : Integer
  }
}
타입 설명
header Object 헤더 영역
- resultCode Integer 결과 코드
- resultMessage String 결과 메시지
- isSuccessful Boolean 성공 여부
attachFile Object 첨부파일
- fileSeq Integer 파일 시퀀스

플러스친구 등록

요청

[URL]

POST  /alimtalk/v1.1/appkeys/{appkey}/plus-friends
Content-Type: application/json;charset=UTF-8

[Path parameter]

타입 설명
appkey String 고유의 appkey

[Header]

{
  "X-Secret-Key": String
}
타입 필수 설명
X-Secret-Key String O 콘솔에서 생성할 수 있다. [참고]

[Request Body]

{
  "plusFriendId" : String,
  "phoneNo" : String,
  "licenseNo" : String,
  "categoryCode" : String,
  "fileSeq" : Integer
}
타입 필수 설명
plusFriendId String O 플러스친구 아이디 (최대 30자)
phoneNo String O 관리자 핸드폰 번호 (최대 15자)
licenseNo String O 사업자등록 번호 (최대 10자)
categoryCode String O 카테고리 코드(11자)
카테고리 조회 API의 응답 참고
ex) 00100010001 건강(001) - 병원(0001) - 종합병원(0001)
fileSeq Integer O 파일 시퀀스

응답

{
  "header" : {
    "resultCode" :  Integer,
    "resultMessage" :  String,
    "isSuccessful" :  boolean
  }
}
타입 설명
header Object 헤더 영역
- resultCode Integer 결과 코드
- resultMessage String 결과 메시지
- isSuccessful Boolean 성공 여부

플러스친구 토큰 인증

요청

[URL]

POST  /alimtalk/v1.1/appkeys/{appkey}/plus-friends/{plusFriendId}/tokens
Content-Type: application/json;charset=UTF-8

[Path parameter]

타입 설명
appkey String 고유의 appkey
plusFriendId String 플러스친구 아이디

[Header]

{
  "X-Secret-Key": String
}
타입 필수 설명
X-Secret-Key String O 콘솔에서 생성할 수 있다. [참고]

[Request Body]

{
  "token" : "Integer"
}
타입 필수 설명
token Integer O 인증 토큰 (플러스친구 등록 API 호출 후, 카카오톡 앱으로 받은 인증 토큰)

응답

{
  "header" : {
    "resultCode" :  Integer,
    "resultMessage" :  String,
    "isSuccessful" :  boolean
  }
}
타입 설명
header Object 헤더 영역
- resultCode Integer 결과 코드
- resultMessage String 결과 메시지
- isSuccessful Boolean 성공 여부

플러스친구 리스트 조회

요청

[URL]

GET  /alimtalk/v1.1/appkeys/{appkey}/plus-friends
Content-Type: application/json;charset=UTF-8

[Path parameter]

타입 설명
appkey String 고유의 appkey

[Header]

{
  "X-Secret-Key": String
}
타입 필수 설명
X-Secret-Key String O 콘솔에서 생성할 수 있다. [참고]

[Query parameter] 1번 or 2번 조건 필수

타입 필수 설명
plusFriendId String X 플러스친구 아이디
status String X 플러스친구 상태 코드
(YSC02: 토큰 인증 대기중, YSC03: 정상 등록)
isSearchKakaoStatus boolean X 카카오 상태 조회 여부(false일 경우, 카카오 상태 관련 필드 (kakaoStatus, kakaoProfileStatus 등) null값)
default값 : true

응답

{
  "header" : {
      "resultCode" :  Integer,
      "resultMessage" :  String,
      "isSuccessful" :  boolean
  },
  "plusFriends" : [
    {
      "plusFriendId" : String,
      "plusFriendType" : String,
      "senderKey" : String,
      "categoryCode" : String,
      "alimtalkDailyMaxCount" : Integer,
      "friendtalkDailyMaxCount" : Integer,
      "alimtalkSentCount" : Integer,
      "friendtalkSentCount" : Integer,
      "status" : String,
      "statusName" : String,
      "kakaoStatus" : String,
      "kakaoStatusName" : String,
      "kakaoProfileStatus" : String,
      "kakaoProfileStatusName" : String,
      "resendYn" : String,
      "smsSendNo" : Integer,
      "createDate" : String
    }
  ],
  "totalCount" : Integer
  }
}
타입 설명
header Object 헤더 영역
- resultCode Integer 결과 코드
- resultMessage String 결과 메시지
- isSuccessful Boolean 성공 여부
plusFriends Object 플러스친구
- plusFriendId String 플러스친구 아이디
- plusFriendType String 플러스친구 타입(NORMAL, GROUP)
- senderKey String 발신키
- categoryCode String 카테고리 코드
- alimtalkDailyMaxCount Integer 알림톡 일별 최대 발송 건수
(값이 0일 경우 건수 제한없음)
- friendtalkDailyMaxCount Integer 친구톡 일별 최대 발송 건수
(값이 0일 경우 건수 제한없음)
- alimtalkSentCount Integer 알림톡 일별 발송 건수
(값이 0일 경우 건수 제한없음)
- friendtalkSentCount Integer 친구톡 일별 발송 건수
(값이 0일 경우 건수 제한없음)
- status String TOAST 플러스친구 상태 코드
(YSC02: 등록 대기중, YSC03: 정상 등록)
- statusName String TOAST 플러스친구 상태명 (등록 대기중, 정상 등록)
- kakaoStatus String 카카오 플러스친구 상태 코드
(A: 정상, S: 차단, D:삭제)
status가 YSC02일 경우, kakaoStatus null 값을 가집니다.
- kakaoStatusName String 카카오 플러스친구 상태명 (정상, 차단, 삭제)
status가 YSC02일 경우, kakaoStatusName null 값을 가집니다.
- kakaoProfileStatus String 카카오 플러스친구 프로필 상태 코드
(A: 활성화, B:차단, C: 비활성화, D:삭제 E:삭제 처리 중)
status가 YSC02일 경우, kakaoProfileStatus null 값을 가집니다.
- kakaoProfileStatusName String 카카오 플러스친구 프로필 상태명 (활성화, 비활성화, 차단, 삭제 처리 중, 삭제)
status가 YSC02일 경우, kakaoProfileStatusName null 값을 가집니다.
- resendYn String 발송 실패 설정(재발송) 여부
- smsSendNo String 재발송 시, tc-sms 발신 번호
- createDate String 등록 일자
totalCount Integer 총 개수

템플릿

템플릿 등록

요청

[URL]

POST  /alimtalk/v1.1/appkeys/{appkey}/plus-friends/{plusFriendId}/templates
Content-Type: application/json;charset=UTF-8

[Path parameter]

타입 설명
appkey String 고유의 appkey
plusFriendId String 플러스친구 아이디

[Header]

{
  "X-Secret-Key": String
}
타입 필수 설명
X-Secret-Key String O 콘솔에서 생성할 수 있다. [참고]

[Request Body]

{
  "templateCode" : String,
  "templateName" : String,
  "templateContent" : String,
  "buttons" : [
    {
      "ordering" : Integer,
      "type" : String,
      "name" : String,
      "linkMo" : String,
      "linkPc" : String,
      "schemeIos" : String,
      "schemeAndroid" : String
    }
  ]
}
타입 필수 설명
templateCode String O 템플릿 코드 (최대 20자)
templateName String O 템플릿명 (최대 20자)
templateContent String O 템플릿 본문 (최대 1000자)
buttons List X 버튼 리스트 (최대 5개)
-ordering Integer X 버튼 순서(1~5)
-type String X 버튼 타입(WL:웹링크, AL:앱링크, DS:배송 조회, BK:봇 키워드, MD:메시지 전달)
-name String X 버튼 이름 (버튼이 있는 경우 필수, 최대 14자)
-linkMo String X 모바일 웹 링크 (WL 타입일 경우 필수 필드, 최대 200자)
-linkPc String X PC 웹 링크 (WL 타입일 경우 선택 필드, 최대 200자)
-schemeIos String X IOS 앱 링크 (AL 타입일 경우 필수 필드, 최대 200자)
-schemeAndroid String X Android 앱 링크 (AL 타입일 경우 필수 필드, 최대 200자)

응답

{
  "header" : {
    "resultCode" :  Integer,
    "resultMessage" :  String,
    "isSuccessful" :  boolean
  }
}
타입 설명
header Object 헤더 영역
- resultCode Integer 결과 코드
- resultMessage String 결과 메시지
- isSuccessful Boolean 성공 여부

템플릿 수정

요청

[URL]

PUT  /alimtalk/v1.1/appkeys/{appkey}/plus-friends/{plusFriendId}/templates/{templateCode}
Content-Type: application/json;charset=UTF-8

[Path parameter]

타입 설명
appkey String 고유의 appkey
plusFriendId String 플러스친구 아이디
templateCode String 템플릿 코드

[Header]

{
  "X-Secret-Key": String
}
타입 필수 설명
X-Secret-Key String O 콘솔에서 생성할 수 있다. [참고]

[Request Body]

{
  "templateName" : String,
  "templateContent" : String,
  "buttons" : [
    {
      "ordering" : Integer,
      "type" : String,
      "name" : String,
      "linkMo" : String,
      "linkPc" : String,
      "schemeIos" : String,
      "schemeAndroid" : String
    }
  ]
}
타입 필수 설명
templateName String O 템플릿명 (최대 20자)
templateContent String O 템플릿 본문 (최대 1000자)
buttons List X 버튼 리스트 (최대 5개)
-ordering Integer X 버튼 순서(1~5)
-type String X 버튼 타입(WL:웹링크, AL:앱링크, DS:배송 조회, BK:봇 키워드, MD:메시지 전달)
-name String X 버튼 이름 (버튼이 있는 경우 필수, 최대 14자)
-linkMo String X 모바일 웹 링크 (WL 타입일 경우 필수 필드, 최대 200자)
-linkPc String X PC 웹 링크 (WL 타입일 경우 선택 필드, 최대 200자)
-schemeIos String X IOS 앱 링크 (AL 타입일 경우 필수 필드, 최대 200자)
-schemeAndroid String X Android 앱 링크 (AL 타입일 경우 필수 필드, 최대 200자)

응답

{
  "header" : {
    "resultCode" :  Integer,
    "resultMessage" :  String,
    "isSuccessful" :  boolean
  }
}
타입 설명
header Object 헤더 영역
- resultCode Integer 결과 코드
- resultMessage String 결과 메시지
- isSuccessful Boolean 성공 여부

템플릿 삭제

요청

[URL]

DELETE  /alimtalk/v1.1/appkeys/{appkey}/plus-friends/{plusFriendId}/templates/{templateCode}
Content-Type: application/json;charset=UTF-8

[Path parameter]

타입 설명
appkey String 고유의 appkey
plusFriendId String 플러스친구 아이디
templateCode String 템플릿 코드

[Header]

{
  "X-Secret-Key": String
}

응답

{
  "header" : {
    "resultCode" :  Integer,
    "resultMessage" :  String,
    "isSuccessful" :  boolean
  }
}
타입 설명
header Object 헤더 영역
- resultCode Integer 결과 코드
- resultMessage String 결과 메시지
- isSuccessful Boolean 성공 여부

템플릿 문의하기

요청

[URL]

PUT  /alimtalk/v1.1/appkeys/{appkey}/plus-friends/{plusFriendId}/templates/{templateCode}/comments
Content-Type: application/json;charset=UTF-8

[Path parameter]

타입 설명
appkey String 고유의 appkey
plusFriendId String 플러스친구 아이디
templateCode String 템플릿 코드

[Header]

{
  "X-Secret-Key": String
}
타입 필수 설명
X-Secret-Key String O 콘솔에서 생성할 수 있다. [참고]

[Request Body]

{
  "comment" : String
}
타입 필수 설명
comment String O 문의 내용

응답

{
  "header" : {
    "resultCode" :  Integer,
    "resultMessage" :  String,
    "isSuccessful" :  boolean
  }
}
타입 설명
header Object 헤더 영역
- resultCode Integer 결과 코드
- resultMessage String 결과 메시지
- isSuccessful Boolean 성공 여부

템플릿 리스트 조회

요청

[URL]

GET  /alimtalk/v1.1/appkeys/{appkey}/templates
Content-Type: application/json;charset=UTF-8

[Path parameter]

타입 설명
appkey String 고유의 appkey

[Header]

{
  "X-Secret-Key": String
}
타입 필수 설명
X-Secret-Key String O 콘솔에서 생성할 수 있다. [참고]

[Query parameter]

타입 필수 설명
plusFriendId String X 플러스친구 아이디
templateCode String X 템플릿 코드
templateName String X 템플릿 이름
templateStatus String X 템플릿 상태 코드
pageNum Integer X 페이지 번호(Default : 1)
pageSize Integer X 조회 건수(Default : 15)
템플릿 상태 코드 설명
TSC01 요청
TSC02 검수중
TSC03 승인
TSC04 반려

[예시]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" "https://api-alimtalk.cloud.toast.com/alimtalk/v1.1/appkeys/{appkey}/templates?plusFriendId={플러스친구 아이디}&templateStatus={템플릿 상태 코드}"

응답


{
  "header" : {
      "resultCode" :  Integer,
      "resultMessage" :  String,
      "isSuccessful" :  boolean
  },
  "templateListResponse": {
      "templates": [
          {
              "plusFriendId": String,
              "plusFriendType": String,
              "templateCode": String,
              "templateName": String,
              "templateContent": String,
              "buttons": [
                {
                    "ordering":Integer,
                    "type": String,
                    "name": String,
                    "linkMo": String,
                    "linkPc": String,
                    "schemeIos": String,
                    "schemeAndroid": String
                }
                ],
                "comments": [
                  {
                      "id": Integer,
                      "content": String,
                      "userName": String,
                      "createdAt": String,
                      "status": String
                    }  
                ],
                "status": String,
                "statusName": String,
                "createDate": String
            }
        ],
        "totalCount": Integer
    }
}
타입 설명
header Object 헤더 영역
- resultCode Integer 결과 코드
- resultMessage String 결과 메시지
- isSuccessful Boolean 성공 여부
templateListResponse Object 본문 영역
- templates List 템플릿 리스트
-- plusFriendId String 플러스친구 아이디
-- plusFriendType String 플러스친구 타입(NORMAL, GROUP)
-- templateCode String 템플릿 코드
-- templateName String 템플릿명
-- templateContent String 템플릿 본문
-- buttons List 버튼 리스트
--- ordering Integer 버튼 순서(1~5)
--- type String 버튼 타입(WL:웹링크, AL:앱링크, DS:배송 조회, BK:봇 키워드, MD:메시지 전달)
--- name String 버튼 이름
--- linkMo String 모바일 웹 링크 (WL 타입일 경우 필수 필드)
--- linkPc String PC 웹 링크 (WL 타입일 경우 선택 필드)
--- schemeIos String IOS 앱 링크 (AL 타입일 경우 필수 필드)
--- schemeAndroid String Android 앱 링크 (AL 타입일 경우 필수 필드)
-- comments List 검수 결과
--- id Integer 문의 아이디
--- content String 문의 내용
---userName String 작성자
---createAt String 등록 날짜
---status String 댓글 상태(INQ: 문의, APR: 승인, REJ: 반려, REP: 답변)
-- status String 템플릿 상태
-- statusName String 템플릿 상태명
-- createDate String 생성일자
- totalCount Integer 총 개수