새로운 문서를 작성 중입니다.새 문서로 이동
ClawOps Docs
API Reference

브랜드 메시지 템플릿 목록 조회

GET
/v1/accounts/{accountId}/kakao/brand-templates

연결된 카카오 채널에서 사용할 수 있는 브랜드 메시지 템플릿을 조회합니다.

channelId는 카카오 채널 목록 API의 data[].id가 반환한 ClawOps 채널 리소스 ID입니다. 응답의 data[].id를 브랜드 메시지 발송 요청의 Brand.TemplateId로, data[].channelId를 Brand.ChannelId로 사용하세요.

⭐ 알림톡과 달리 검수가 없습니다 — 목록에 있는 템플릿은 전부 바로 발송할 수 있습니다 (알림톡의 status·sendable 에 해당하는 칸이 없는 이유입니다).

variables의 모든 항목을 발송 요청의 Brand.Variables에 채워야 합니다.

Authorization

BearerAuth
AuthorizationBearer <token>

API Key를 Bearer 토큰으로 전달

In: header

Path Parameters

accountId*string

계정 ID

Query Parameters

channelId*string

채널 목록 API가 반환한 ClawOps 채널 리소스 ID.

page?integer

페이지 번호(0-based)

Default0
Range0 <= value
pageSize?integer

페이지당 항목 수

Default20
Range1 <= value <= 100
page_size?integerDeprecated

pageSize 별칭.

Range1 <= value <= 100
limit?integerDeprecated

pageSize 별칭.

Range1 <= value <= 100

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/accounts/AC1a2b3c4d/kakao/brand-templates?channelId=clx9kak0001&page=0&pageSize=20&page_size=50&limit=100"
{
  "data": [
    {
      "id": "clx9bms0001",
      "channelId": "clx9kak0001",
      "name": "9월 신상품 안내",
      "chatBubbleType": "TEXT",
      "content": "#{고객명}님, 9월 신상품이 도착했습니다.",
      "header": "신상품 안내",
      "variables": [
        "#{고객명}"
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "page": 0,
    "pageSize": 0,
    "total": 0
  }
}
{
  "error": "string",
  "code": "recipient_blocked",
  "ip": "52.79.213.41",
  "blockers": [
    {
      "number": "07012340002",
      "code": "number_not_carrier_issued",
      "message": "이용증명원은 한국AI통신이 개통한 070·대표번호만 발급됩니다."
    }
  ]
}
{
  "error": "string",
  "code": "recipient_blocked",
  "ip": "52.79.213.41",
  "blockers": [
    {
      "number": "07012340002",
      "code": "number_not_carrier_issued",
      "message": "이용증명원은 한국AI통신이 개통한 070·대표번호만 발급됩니다."
    }
  ]
}
{
  "error": "string",
  "code": "recipient_blocked",
  "ip": "52.79.213.41",
  "blockers": [
    {
      "number": "07012340002",
      "code": "number_not_carrier_issued",
      "message": "이용증명원은 한국AI통신이 개통한 070·대표번호만 발급됩니다."
    }
  ]
}
{
  "error": "string",
  "code": "recipient_blocked",
  "ip": "52.79.213.41",
  "blockers": [
    {
      "number": "07012340002",
      "code": "number_not_carrier_issued",
      "message": "이용증명원은 한국AI통신이 개통한 070·대표번호만 발급됩니다."
    }
  ]
}