발신번호 및 템플릿 조회
API 목록
GET
/v1/openapi/member/senderNumber
문자 발신번호 목록 조회 API
GET
/v1/openapi/kakao/channel
카카오톡 발신채널 ID 목록 조회 API
GET
/v1/openapi/kakao/channel/template/{chnId}
알림톡/친구톡 템플릿 목록 조회 API
GET
/v1/openapi/kakao/channel/template/{chnId}/{templateId}
알림톡/친구톡 템플릿 버튼 목록 조회 API
GET
/v1/openapi/kakao/channel/template/{templateId}/files
알림톡/친구톡 템플릿 파일 조회 API
1. 문자 발신번호 목록 조회
GET https://api.megabird.co.kr:8080/v1/openapi/member/senderNumber
Headers
Authorization*
String
발급받은 API Key
Content-Type*
String
application/json
{
"code": "0000",
"result": [
{
"mbId": "c1ee66xxxxxxxxxxxxxxxxxxxxxxxxxxx",
"phnum": "01012341234",
"spnDvsCd": "SDA",
"spnDvsCdNm": "승인발신번호",
"regDtt": "2022-12-27T13:16:22"
},
{
"mbId": "c1ee66xxxxxxxxxxxxxxxxxxxxxxxxxxx",
"phnum": "01056785678",
"spnDvsCd": "SDJ",
"spnDvsCdNm": "가입발신번호",
"regDtt": "2022-09-21T10:04:45"
}
]
}2. 카카오톡 발신채널 ID 목록 조회
등록한 카카오톡 발신채널 ID 목록을 조회한다.
GET https://api.megabird.co.kr:8080/v1/openapi/kakao/channel
Headers
Content-Type*
String
multipart/form-data
Authorization*
String
발급받은 API Key
{
"code": "0000",
"result": [
{
"mbId": "c1ee66xxxxxxxxxxxxxxxxxxxxxxxxxxx",
"chnId": "@메가버드",
"chnStsCd": "SRG",
"chnStsCdNm": "등록완료",
"stsDtt": "2022-09-22T09:58:06",
"regDtt": "2022-09-22T09:58:06"
}
]
}3. 알림톡 / 친구톡 템플릿 목록 조회
메가버드 화면에서 등록한 검수가 완료된 알림톡 템플릿 및 친구톡 템플릿 목록을 조회한다. 알림톡 템플릿 등록 화면 경로 : 메가버드 > 템플릿 관리 > 알림톡 템플릿
GET https://api.megabird.co.kr:8080/v1/openapi/kakao/channel/template/{chnId}
Headers
Authorization*
String
발급받은 API Key
Content-Type*
String
application/json
Path Parameter
chnId*
String
Y
카카오 발신채널 ID
Query Parameters
offset
Integer
페이지별 행 건수 default : 10
page
Integer
페이지번호 default : 0
keyword
String
검색어
searchType
String
검색구분
[''] 전체, [템플릿제목] title, [템플릿코드] code
msgDvsCd*
String
Y
TKA or TKF
TKA : Alimtalk
TKF : Friendtalk
Request Example
Resposne Example
{
"code": "0000",
"result": {
"totalCount": 2,
"result": [
{
"tmplId": "TKA0000005",
"mbId": "c1ee66xxxxxxxxxxxxxxxxxxxxxxxxxxx",
"tmplTtl": "이벤트 알림",
"tmplCotn": "★★★\n안녕하세요. #{NAME}님! \n[메가버드] 이벤트 알림톡입니다. \n감사합니다.",
"msgDvsCd": "TKA",
"msgDvsCdNm": "알림톡",
"txtmsgDvsCd": null,
"txtmsgDvsCdNm": null,
"adIncluYn": null,
"svcNm": null,
"exmStsCd": "TMR",
"exmStsCdNm": "반려",
"regDtt": "2022-10-12T14:22:12",
"modDtt": "2022-10-12T14:22:12"
},
{
"tmplId": "TKA000001",
"mbId": "c1ee66xxxxxxxxxxxxxxxxxxxxxxxxxxx",
"tmplTtl": "회원가입 완료",
"tmplCotn": "[메가버드] 회원가입 안내 \n#{이름}님, 메가버드에 가입해 주셔서 감사합니다. \n이제 메가버드에서 다양한 형태의 메시징 서비스를 쉽고 편리하게 이용하실 수 있습니다.",
"msgDvsCd": "TKA",
"msgDvsCdNm": "알림톡",
"txtmsgDvsCd": null,
"txtmsgDvsCdNm": null,
"adIncluYn": null,
"svcNm": null,
"exmStsCd": "TMC",
"exmStsCdNm": "등록완료",
"regDtt": "2022-09-22T09:59:15",
"modDtt": "2022-09-22T09:59:15"
}
]
}
}4. 알림톡/친구톡 템플릿 버튼 목록 조회
등록한 알림톡/친구톡 템플릿의 버튼 목록을 조회한다.
GET https://api.megabird.co.kr:8080/v1/openapi/kakao/channel/template/{chnId}/{templateId}
Headers
Authorization*
String
발급받은 API Key
Content-Type*
String
application/json
Path Parameters
chnId*
String
Y
카카오 발신채널 ID
templateId*
String
Y
카카오 템플릿 ID
Response Example
{
"code": "0000",
"result": [
{
"tmplId": "TKA0000020",
"btnKndCd": "BTW", // 버튼종류코드 - 웹링크: BTW, 앱링크: BTA, 버튼텍스트: BTT, 봇키워드: BTK, 배송조회: BTD
"btnNm": "테스트1",
"lk1Url": "https://megabird.com",
"lk2Url": "https://megabird.com",
"sortNum": 1
},
{
"tmplId": "TKA0000020",
"btnKndCd": "BTW",
"btnNm": "테스트2",
"lk1Url": "https://megabird.com",
"lk2Url": "https://megabird.com",
"sortNum": 2
}
]
}5. 알림톡/친구톡 템플릿 파일 조회
등록한 알림톡/친구톡 템플릿의 파일을 조회한다.
GET https://api.megabird.co.kr:8080/v1/openapi/kakao/channel/template/{templateId}/files
Headers
Authorization*
String
발급받은 API Key
Content-Type*
String
application/json
Path Parameters
templateId*
String
Y
카카오 템플릿 ID
Response Example
{
"success": true,
"code": "200",
"message": "성공",
"data": [
{
"tmplId": "TKAXXXXXXX",
"flId": "aaaabbbb20a445f3892e3e4cxxxxzzzz",
"sortNum": 1,
"flNm": "메가버드.jpg",
"flPath": "/2024/05/aaaabbbb20a445f3892e3e4cxxxxzzzz.jpg",
"flVol": 35123,
"regDtt": "2024-05-21T14:51:44",
"regrId": "b7f258399e2d4ab3aafd2bcdfcfb4fe1"
}
],
"timestamp": "2024-05-27T16:26:26.466201"
}Last updated