Kakao

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

Changed on

브랜드 메시지 템플릿 목록을 조회합니다. 템플릿 타입과 상태로 필터링하고 커서 기반 페이지 구성을 지원합니다.

get/v2/messages/kakao/send-profiles/{sendProfileId}/brand-message-templates

Request

  • Base URL
    https://api.sendon.io
  • URL
    https://api.sendon.io/v2/messages/kakao/send-profiles/{sendProfileId}/brand-message-templates
  • Auth
    HTTP basic

Path parameters

sendProfileIdstring required
Example:@bizmsg_official

목록을 조회할 카카오 채널(발신 프로필) ID입니다.

Query parameters

cursorstring
Example:tpl_bm_123456

다음 페이지를 불러오기 위한 커서입니다.

limitnumber nullable
Example:20

조회할 데이터의 개수를 지정합니다. 기본값은 20입니다.

status'PENDING' | 'APPROVED' | 'REJECTED'
Example:APPROVED

조회할 템플릿 상태를 지정합니다.

messageType'BMT' | 'BMI' | 'BMW' | 'BMWL' | 'BMCF'
Example:BMT

조회할 메시지 타입을 지정합니다.

Response

목록 조회 결과입니다. 오류가 발생해도 HTTP 200으로 응답하므로, 실패 시 본문의 code와 errorCode를 확인하세요.

codenumber required

HTTP 상태 코드입니다. 200이면 성공, 400대는 클라이언트 오류, 500대는 서버 오류를 나타냅니다.

messagestring required

API 호출 결과에 대한 사람이 읽을 수 있는 메시지입니다. 성공 시 "OK", 실패 시 구체적인 오류 사유가 포함됩니다.

Example response

{
  "code": 200,
  "message": "OK",
  "data": {
    "list": [
      {
        "templateId": "tpl_bm_123456",
        "templateCode": "BM_TEMPLATE_20240515001",
        "templateName": "신규 회원 가입 환영 메시지",
        "messageType": "BMT",
        "status": "PENDING",
        "rejectionReason": {
          "code": "INVALID_CONTENT",
          "message": "메시지 내용에 금지어가 포함되어 있습니다.",
          "suggestion": "금지어를 제거하고 다시 제출해 주세요."
        },
        "fallback": {
          "senderNumber": "01012345678",
          "message": "#{고객명}님, 브랜드메시지가 발송되지 못하여 대체문자로 발송됩니다.",
          "title": "대체문자 안내",
          "images": [
            "https://mud-kage.kakao.com/dn/bgUWpm/btsgfyhWuWn/L9SHkckn2VXHOayfGa9ok1/img_l.jpg"
          ],
          "groupId": "004a6217-f06c-40f6-8f39-bf35b3f76111"
        },
        "createdAt": "2024-05-15T09:30:00Z",
        "updatedAt": "2024-05-16T10:20:00Z",
        "approvedAt": "2024-05-16T10:20:00Z"
      }
    ],
    "totalCount": 1
  }
}

Changes

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      api operation id getBrandMessageTemplates removed and replaced with BrandMessageTemplateController_getBrandMessageTemplates

    • info

      the endpoint scheme security basic was added to the API

    • info

      added to the response property allOf list for the response status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response's property default value 200 was removed for the status

    • info

      the response's property default value 성공 was removed for the status