알림톡 템플릿 목록 조회 API
1. API 개요
인증된 사이트에서 사용할 수 있는 **알림톡 템플릿 목록을 조회하는 API**입니다.
이 API를 통해 다음 정보를 확인할 수 있습니다.
•
알림톡 템플릿 ID
•
템플릿 코드 및 이름
•
메시지 유형
•
템플릿 내용
•
버튼 정보
•
웹링크 정보
2. 사전 조건 / 권한
•
콜브릿지 계정 필수
•
API Access Token 발급 필요
3. API 정보
Method / Endpoint
Header
이름 | 타입 | 필수 | 기본값 | 설명 |
Authorization | string | O | Bearer {ACCESS_TOKEN} 형식으로 전달 |
4. Request
이 API는 요청 파라미터가 없습니다.
Request Example
cURL
curl -X GET "https://bnd.happytalk.io/api/openapi/messages/alimtalk-templates" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
JavaScript
복사
5. Response
Response 정보
•
Status Code: 200 OK
•
Content-Type: application/json
Response Body Example
json
{
"code": "OK",
"timestamp": 1735437506,
"message": "알림톡 템플릿 목록 조회 성공",
"total": 1,
"items": [
{
"id": "1",
"code": "COUNSEL_END_001",
"name": "상담 완료 안내",
"messageType": "BA",
"emphasizeType": "NONE",
"content": "#{고객명}님, 상담이 완료되었습니다.",
"buttons": [
{
"type": "WL",
"name": "바로가기",
"url_pc": "https://example.com",
"url_mobile": "https://example.com"
}
],
"weblink": "https://example.com/site-link"
}
]
}
JavaScript
복사
Resonse Field명
이름 | 타입 | 필수 | 기본값 | 설명 |
code | string | O | - | 응답 코드 (예: OK) |
timestamp | Long | O | - | 응답 일시 (Unix timestamp) |
message | String | O | - | 응답 메시지 |
total | Integer | O | - | 템플릿 총 개수 |
items | Array | O | - | 알림톡 템플릿 목록 |
items[] (템플릿 객체)
이름 | 타입 | 필수 | 기본값 | 설명 |
id | String | O | - | 템플릿 ID |
code | String | O | - | 템플릿 코드 |
name | String | O | - | 템플릿 이름 |
messageType | String | O | - | 메시지 유형 (BA: 기본형, EX: 부가정보형, AD: 광고추가형, MI: 복합형) |
emphasizeType | String | O | - | 강조 유형 (NONE: 없음, TEXT: 강조표기형) |
content | String | O | - | 템플릿 내용 |
buttons | Array | O | - | 버튼 정보 |
weblink | String | O | - | 웹링크 URL |
buttons[]
이름 | 타입 | 필수 | 기본값 | 설명 |
type | String | O | - | 버튼 타입 (WL: 웹링크 등) |
name | String | O | - | 버튼 이름 |
url_pc | String | X | - | PC용 URL |
url_mobile | String | X | - | 모바일용 URL |
6. 에러 / 예외처리
오류 응답 본문의 “code"와 "message" 속성에서 오류에 대한 더 구체적인 세부 정보를 확인할 수 있습니다.
HTTP 상태명 | Error Code | Message | 설명 |
401 Unauthorized | UNAUTHORIZED | Invalid credentials | API Key 미전송 또는 인증 실패 |
403 Forbidden | FORBIDDEN | 알림톡 프로필이 설정되지 않았습니다 | 사이트에 알림톡 프로필 미설정 |
500 Internal Server Error | INTERNAL_SERVER_ERROR | 내부 서버 오류가 발생했습니다. | 예기치 않은 서버 오류 |