공용 문자 템플릿 목록 조회 API
1. API 개요
인증된 사이트에서 사용할 수 있는 **공용 문자 템플릿 목록을 조회하는 API**입니다.
이 API를 통해 다음 정보를 확인할 수 있습니다.
•
템플릿 ID
•
템플릿 제목
•
템플릿 내용
•
메시지 타입 (SMS / LMS)
•
카테고리 정보
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/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": 2,
"items": [
{
"id": "123",
"title": "상담 완료 안내",
"content": "#{서비스명} 상담이 완료되었습니다. 감사합니다.",
"type": "SMS",
"categoryId": 1,
"categoryName": "상담 완료",
"createdAt": "2024-01-15T10:30:00"
},
{
"id": "124",
"title": "콜백 요청 안내",
"content": "#{서비스명} 콜백 요청이 접수되었습니다.",
"type": "LMS",
"categoryId": 2,
"categoryName": "콜백",
"createdAt": "2024-01-10T09:00:00"
}
]
}
JavaScript
복사
Resonse Field명
이름 | 타입 | 필수 | 기본값 | 설명 |
code | string | O | - | 응답 코드 (예: OK) |
data | Object | O | - | 템플릿 목록 데이터 |
data[] (템플릿 객체)
이름 | 타입 | 필수 | 기본값 | 설명 |
code | string | O | - | 응답 코드 (예: OK) |
timestamp | Long | O | - | 응답 일시 (Unix timestamp) |
message | String | O | - | 응답 메시지 |
total | Integer | O | - | 템플릿 총 개수 |
items | Array | O | - | 문자 템플릿 목록 |
templates[] (템플릿 객체)
이름 | 타입 | 필수 | 기본값 | 설명 |
id | String | O | - | 템플릿 ID |
title | String | X | - | 템플릿 제목 |
content | String | O | - | 템플릿 내용 |
type | String | O | - | 메시지 타입 (SMS, LMS) |
categoryId | Long | X | - | 카테고리 ID |
categoryName | String | X | - | 카테고리 이름 |
createdAt | String | X | - | 생성 일시 (ISO 8601 형식) |
6. 에러 / 예외처리
오류 응답 본문의 “code"와 "message" 속성에서 오류에 대한 더 구체적인 세부 정보를 확인할 수 있습니다.
HTTP 상태명 | Error Code | Message | 설명 |
│ 401 Unauthorized | UNAUTHORIZED | Invalid credentials | API Key 미전송 또는 인증 실패 |
403 Forbidden | FORBIDDEN | 문자 발송 서비스가 신청되지 않았습니다 | 사이트에 문자 발송 서비스 미신청 |
500 Internal Server Error | INTERNAL_SERVER_ERROR | 내부 서버 오류가 발생했습니다. | 예기치 않은 서버 오류 |