[API 도메인]

Test

https://stg-api.metaflyer.co.kr

Production

https://api.metaflyer.co.kr

[Header]

Name	Type	Description

Name	Type	Description
apiKey	String	별도 요청

[Content-Type]

application/json;charset=UTF-8

[Common Response]

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

Name	Type	Required	Description

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]

[Response]

{
    "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

Name	Type	Required	Description
items	Array	true
– id	String	true	카테고리 코드
– label	String	true	카테고리 명
– code	String	true	카테고리 코드
– name	String	true	카테고리 명

발신프로필 등록

[URL]

[Request Body]

{
    "category": String,
    "channelId": String,
    "cellphone": String
}

Name	Type	Required	Description

Name	Type	Required	Description
category	String	true	발신프로필 카테고리 코드
channelId	String	true	카카오톡 채널 검색용 ID
cellphone	String	true	관리자 휴대폰 번호

[Response]

Name	Type	Required	Description

Name	Type	Required	Description
item	Object	true	발신 프로필 정보
– changelId	String	true	카카오톡 채널 검색용 ID
– category	String	true	발신프로필 카테고리
– – value	String	true	발신프로필 카테고리 코드
– – label	String	true	발신프로필 카테고리 명
– – refId	String	true	발신프로필 카테고리 코드
– senderKey	String	false	발신키
– cellphone	String	true	관리자 휴대폰 번호
– authStatus	String	true	발신프로필 상태 `토큰인증 대기중` (wait) `토큰인증 성공` (approval)

발신프로필 삭제

[URL]

[Request Body]

Name	Type	Required	Description

Name	Type	Required	Description
senderKey	String	true	발신키

[Response]

발신프로필 토큰인증

[URL]

[Request Body]

Name	Type	Required	Description

Name

Type

Required

Description

channelId

String

true

카카오톡 채널 검색용 ID

token

String

true

인증 토큰

발신프로필 등록 API 호출 후, 관리자 휴대폰 번호의 카카오톡 앱으로 받은 인증 토큰

[Response]

발신프로필 리스트

[URL]

[Request Parameter]

Name	Type	Required	Description

Name	Type	Required	Description
channelId	String	false	카카오톡 채널 검색용 ID
senderKey	String	false	발신키
authStatus	String	false	발신프로필 상태 `토큰인증 대기중` (wait) `토큰인증 성공` (approval)
page	Integer	false	페이지 번호 default : 1
pageSize	Integer	false	페이지 조회 건수 defualt : 10

[Response]

Name	Type	Required	Description

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	발신프로필 상태 `토큰인증 대기중` (wait) `토큰인증 성공` (approval)
– enable	Boolean	false	사용여부 default : true
– created	String	false	등록일자
– changed	String	false	수정일자

Hannah

Kakao 발신프로필 API

발신프로필 카테고리

발신프로필 등록

발신프로필 삭제

발신프로필 토큰인증

발신프로필 리스트