Kakao

템플릿 상세 조회

Changed on

알림톡 템플릿의 상세 정보를 조회합니다. 템플릿 내용, 검수 상태, 버튼 정보, 승인/반려 사유 등을 확인할 수 있습니다.

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

Request

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

Path parameters

sendProfileIdstring required
Example:1234567890

조회할 템플릿이 속한 채널의 ID입니다.

templateIdstring required
Example:1234567890

조회할 템플릿의 ID입니다. 템플릿 목록에서 받은 ID를 사용하세요.

Response

템플릿 상세 조회 요청의 처리 결과입니다. 해당 템플릿의 모든 상세 정보가 포함됩니다.

codenumber required

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

messagestring required

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

Example response

{
  "code": 200,
  "message": "OK",
  "data": {
    "profileId": "profile_12345",
    "id": "template_67890",
    "templateName": "주문 확인 알림 템플릿",
    "status": "APPROVED",
    "templateMessageType": "BA",
    "templateEmphasizeType": "TEXT",
    "templateContent": "안녕하세요 #{고객명}님, 주문이 완료되었습니다.",
    "buttons": [
      {
        "name": "자세히 보기",
        "ordering": 1,
        "urlMobile": "https://example.com/mobile",
        "urlPc": "https://example.com/pc"
      }
    ],
    "fallback": {
      "groupId": "004a6217-f06c-40f6-8f39-bf35b3f76111"
    },
    "templateComments": [
      {
        "commentContent": "템플릿 내용이 명확하지 않아 수정이 필요합니다.",
        "commentCreateAt": "2024-01-15T10:30:00Z",
        "commentSeqno": 1,
        "commentStatus": "ACTIVE",
        "commentUserName": "검수담당자",
        "regBy": "admin@example.com",
        "regDate": "2024-01-15T10:30:00Z",
        "updateBy": "admin@example.com",
        "updateDate": "2024-01-15T11:00:00Z"
      }
    ],
    "templateTitle": "123,456원",
    "templateSubtitle": "승인내역",
    "templateImageName": "template_banner.png",
    "templateImageUrl": "https://example.com/images/template_banner.png",
    "templateExtra": "■ 이용안내\n- 운영시간: 평일 09:00~18:00\n- 고객센터: 1588-1234\n- 홈페이지: https://shop.example.com\n\n※ 주말/공휴일 배송불가",
    "createdAt": "2024-01-01T09:00:00Z",
    "updatedAt": "2024-01-15T10:30:00Z",
    "syncedAt": "2024-01-15T11:00:00Z",
    "lastUsedAt": "2024-01-15T12:00:00Z"
  }
}

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

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      api operation id getTemplate removed and replaced with TemplateController_getTemplate

    • 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