Skip to content
On this page

발신프로필 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]

NameTypeDescription
apiKeyString별도 요청

[Content-Type]
application/json;charset=UTF-8

[Common Response]

json
{
    "time": String,
    "result": String,
    "resultMessage": String,
    "locale": String
}
NameTypeRequiredDescription
timeStringtrueResponse Time 2022-11-07T07:52:35.949+00:00
resultStringtrueResponse Code
resultMessageStringtrueResponse Message
localeStringtrueAPI 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
        }
    ]
}
NameTypeRequiredDescription
itemsArraytrue
- idStringtrue카테고리 코드
- labelStringtrue카테고리 명
- codeStringtrue카테고리 코드
- nameStringtrue카테고리 명

등록

[URL]
POST /api/sender/create.v1.0

[Request Body]

json
{
    "category": String,
    "channelId": String,
    "cellphone": String
}
NameTypeRequiredDescription
categoryStringtrue발신프로필 카테고리 코드
channelIdStringtrue카카오톡 채널 검색용 ID
cellphoneStringtrue관리자 휴대폰 번호

[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
        }
    }
}
NameTypeRequiredDescription
itemObjecttrue발신 프로필 정보
- channelIdStringtrue카카오톡 채널 검색용 ID
- categoryStringtrue발신프로필 카테고리
-- valueStringtrue발신프로필 카테고리 코드
-- labelStringtrue발신프로필 카테고리 명
-- refIdStringtrue발신프로필 카테고리 코드
-senderKeyStringfalse발신키
- cellphoneStringtrue관리자 휴대폰 번호
- authStatusStringtrue발신 프로필 상태
- 토큰인증 대기중 (waiting)
- 토큰인증 성공 (approval)

삭제

[URL]
POST /api/sender/delete.v1.0

[Request Body]

json
{
    "senderKey": String
}
NameTypeRequiredDescription
senderKeyStringtrue발신키

[Response]

json
{
    "time": String,
    "result": String,
    "resultMessage": String,
    "locale": String

토큰인증

[URL]
POST /api/sender/auth.v1.0

[Request Body]

json
{
    "channelId": String,
    "token": String
}
NameTypeRequiredDescription
channelIdStringtrue카카오톡 채널 검색용 ID
tokenStringtrue인증 토큰
- 발신프로필 등록 API 호출 후, 관리자 휴대폰 번호의 카카오톡 앱으로 받은 인증 토큰

[Response]

json
{
    "time": String,
    "result": String,
    "resultMessage": String,
    "locale": String
}

리스트

[URL]
GET /api/sender/list.v1.0

[Request Parameter]

NameTypeRequiredDescription
channelIdStringfalse카카오톡 채널 검색용 ID
senderKeyStringfalse발신키
authStatusStringfalse발신프로필 상태
- 토큰인증 대기중 (waiting)
- 토큰인증 성공 (approval)
pageIntegerfalse페이지 번호
- default : 1
pageSizeIntegerfalse페이지 조회 건수
- 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
        }
    ]
}
NameTypeRequiredDescription
totalCountIntegertrue총 건수
resultCountIntegertrue현재 조회중 건수
pageSizeIntegertrue페이지 조회 건수
pageCountIntegertrue총 페이지 수
currentPageIntegertrue현재 페이지 번호
itemsObjectfalse발신 프로필 정보
- idStringfalseID
- labelStringfalse카카오톡 채널 검색용 ID
- channelIdStringfalse카카오톡 채널 검색용 ID
- categoryObjectfalse발신프로필 카테고리
-- valueStringfalse발신프로필 카테고리 코드
-- labelStringfalse발신프로필 카테고리 명
-- refIdStringfalse발신프로필 카테고리 코드
- senderKeyStringfalse발신키
- cellphoneStringfalse관리자 휴대폰 번호
- authStatusStringfalse발신 프로필 상태
- 토큰인증 대기중 (waiting)
- 토큰인증 성공 (approval)
- enableBooleanfalse사용여부
- default : true
- createdStringfalse등록일자
- changedStringfalse수정일자