Appearance
발신프로필 API
[API 도메인]
// Test
[https://stg-api.metaflyer.co.kr](https://stg-api.metaflyer.co.kr)
// Production
[https://api.metaflyer.co.kr](https://api.metaflyer.co.kr)
[Header]
Name | Type | Description |
---|---|---|
apiKey | String | 별도 요청 |
[Content-Type]application/json;charset=UTF-8
[Common Response]
json
{
"time": String,
"result": String,
"resultMessage": String,
"locale": String
}
Name | Type | Required | Description |
---|---|---|---|
time | String | true | Response Time 2022-11-07T07:52:35.949+00:00 |
result | String | true | Response Code |
resultMessage | String | true | Response Message |
locale | String | true | API Locale |
카테고리
[URL]
POST /api/sender/categories.v1.0
[Response]
json
{
"time": String,
"result": String,
"resultMessage": String,
"locale": String,
"totalCount": Integer,
"resultCount": Integer,
"items": [
{
"id": String,
"label": String,
"code": String,
"name": String
}
]
}
Name | Type | Required | Description |
---|---|---|---|
items | Array | true | |
- id | String | true | 카테고리 코드 |
- label | String | true | 카테고리 명 |
- code | String | true | 카테고리 코드 |
- name | String | true | 카테고리 명 |
등록
[URL]
POST /api/sender/create.v1.0
[Request Body]
json
{
"category": String,
"channelId": String,
"cellphone": String
}
Name | Type | Required | Description |
---|---|---|---|
category | String | true | 발신프로필 카테고리 코드 |
channelId | String | true | 카카오톡 채널 검색용 ID |
cellphone | String | true | 관리자 휴대폰 번호 |
[Response]
json
{
"time": String,
"result": String,
"resultMessage": String,
"locale": String,
"item": {
"channelId": String,
"category": {
"value": String,
"label": String,
"refId": String
},
"senderKey": String,
"cellphone": String,
"authStatus": {
"value": String,
"label": String
}
}
}
Name | Type | Required | Description |
---|---|---|---|
item | Object | true | 발신 프로필 정보 |
- channelId | String | true | 카카오톡 채널 검색용 ID |
- category | String | true | 발신프로필 카테고리 |
-- value | String | true | 발신프로필 카테고리 코드 |
-- label | String | true | 발신프로필 카테고리 명 |
-- refId | String | true | 발신프로필 카테고리 코드 |
-senderKey | String | false | 발신키 |
- cellphone | String | true | 관리자 휴대폰 번호 |
- authStatus | String | true | 발신 프로필 상태 - 토큰인증 대기중 (waiting) - 토큰인증 성공 (approval) |
삭제
[URL]
POST /api/sender/delete.v1.0
[Request Body]
json
{
"senderKey": String
}
Name | Type | Required | Description |
---|---|---|---|
senderKey | String | true | 발신키 |
[Response]
json
{
"time": String,
"result": String,
"resultMessage": String,
"locale": String
토큰인증
[URL]
POST /api/sender/auth.v1.0
[Request Body]
json
{
"channelId": String,
"token": String
}
Name | Type | Required | Description |
---|---|---|---|
channelId | String | true | 카카오톡 채널 검색용 ID |
token | String | true | 인증 토큰 - 발신프로필 등록 API 호출 후, 관리자 휴대폰 번호의 카카오톡 앱으로 받은 인증 토큰 |
[Response]
json
{
"time": String,
"result": String,
"resultMessage": String,
"locale": String
}
리스트
[URL]
GET /api/sender/list.v1.0
[Request Parameter]
Name | Type | Required | Description |
---|---|---|---|
channelId | String | false | 카카오톡 채널 검색용 ID |
senderKey | String | false | 발신키 |
authStatus | String | false | 발신프로필 상태 - 토큰인증 대기중 (waiting) - 토큰인증 성공 (approval) |
page | Integer | false | 페이지 번호 - default : 1 |
pageSize | Integer | false | 페이지 조회 건수 - default : 10 |
[Response]
json
{
"time": String,
"result": String,
"resultMessage": String,
"locale": String,
"totalCount": Integer,
"resultCount": Integer,
"pageSize": Integer,
"pageCount": Integer,
"currentPage": Integer,
"items": [
{
"id": String,
"label": String,
"channelId": String,
"category": {
"value": String,
"label": String,
"refId": String
},
"senderKey": String,
"cellphone": String,
"authStatus": {
"value": String,
"label": String
},
"enable": Boolean,
"created": String,
"changed": String
}
]
}
Name | Type | Required | Description |
---|---|---|---|
totalCount | Integer | true | 총 건수 |
resultCount | Integer | true | 현재 조회중 건수 |
pageSize | Integer | true | 페이지 조회 건수 |
pageCount | Integer | true | 총 페이지 수 |
currentPage | Integer | true | 현재 페이지 번호 |
items | Object | false | 발신 프로필 정보 |
- id | String | false | ID |
- label | String | false | 카카오톡 채널 검색용 ID |
- channelId | String | false | 카카오톡 채널 검색용 ID |
- category | Object | false | 발신프로필 카테고리 |
-- value | String | false | 발신프로필 카테고리 코드 |
-- label | String | false | 발신프로필 카테고리 명 |
-- refId | String | false | 발신프로필 카테고리 코드 |
- senderKey | String | false | 발신키 |
- cellphone | String | false | 관리자 휴대폰 번호 |
- authStatus | String | false | 발신 프로필 상태 - 토큰인증 대기중 (waiting) - 토큰인증 성공 (approval) |
- enable | Boolean | false | 사용여부 - default : true |
- created | String | false | 등록일자 |
- changed | String | false | 수정일자 |