NITSOFT

친구톡 발송

post

EndPoint

POST /kakao/friendtalk/{channelId}

Parameters

channelId

*

채널 아이디

Parameters Body

messageType

*

친구톡 유형 (NONE: 기본, IMAGE: 이미지, WIDE: 와이드 이미지, ITEM_LIST: 아이템리스트, CAROUSEL: 캐러셀)

title

*

제목

callback

*

발신번호

destination

수신 대상 정보

phone

*

수신자 전화번호

params

변수 (json key (변수명): value (치환할 값))

variables

고정 변수 (json key (변수명): value (치환할 값))

reserve

예약 여부

sendDate

예약 일시 (reserve 가 1인 경우 필수, “yyyy-MM-dd HH:mm:ss”)

fallback

대체 문자 발송 여부

fallbackMessage

대체 문자 내용

content

내용

header

아이템리스트 제목 (ITEM_LIST 사용 시 필수)

adFlag

광고 표시 여부

attachment

버튼, 이미지, 아이템리스트 정보

button

버튼 정보 배열

name

*

버튼명

type

*

버튼 유형 (WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지 전달, AC: 채널추가)

urlPc

버튼 PC 링크 주소

urlMobile

버튼 모바일 링크 주소

schemeAndroid

버튼 Android Scheme

schemeIos

버튼 IOS Scheme

image

이미지 정보

imgUrl

*

이미지 URL

imgLink

이미지 링크 주소

item

아이템 리스트 정보

list

아이템 리스트 배열

title

*

아이템 제목

imgUrl

*

아이템 이미지 URL

urlPc

아이템 PC 링크 주소

urlMobile

*

아이템 모바일 링크 주소

schemeAndroid

아이템 Android Scheme

schemeIos

아이템 IOS Scheme

coupon

쿠폰 정보

type

*

쿠폰 유형 (AMOUNT: 할인금액, RATE: 할인율, DELIVERY: 배송비, FREE: 무료, UPGRADE: 업그레이드)

description

*

쿠폰 설명

value

쿠폰 유형별 값 (할인금액: 1 ~ 99,999,999 / 할인율: 1 ~ 100 / 무료, 업그레이드 : 7자 이내 문자열)

urlPc

쿠폰 PC 링크 주소

urlMobile

*

쿠폰 모바일 링크 주소

schemeAndroid

쿠폰 Android Scheme

schemeIos

쿠폰 IOS Scheme

carousel

캐러셀 정보

list

캐러셀 리스트 배열

haeder

*

캐러셀 제목

message

*

캐러셀 메세지

attachment

캐러셀 아이템 정보

image

캐러셀 이미지

imgUrl

*

캐러셀 이미지 URL

imgLink

*

캐러셀 이미지 링크 주소

button

캐러셀 버튼 배열

name

*

버튼명

type

*

버튼 유형 (WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지 전달, AC: 채널추가)

urlPc

버튼 PC 링크 주소

urlMobile

버튼 모바일 링크 주소

schemeAndroid

버튼 Android Scheme

schemeIos

버튼 IOS Scheme

tail

캐러셀 더보기 버튼

urlPc

캐러셀 더보기 PC 링크 주소

urlMobile

*

캐러셀 더보기 모바일 링크 주소

schemeAndroid

캐러셀 더보기 Android Scheme

schemeIos

캐러셀 더보기 IOS Scheme

Response

- JSON

statusCode

오류 코드

error

오류 메세지

message

결과 메세지

historyIdx

발송 인덱스 번호

count

총 발송 요청 수량

Example

Request

POST /kakao/friendtalk/{channelId}

RequestBody

{
    "messageType": "NONE",
    "title": "테스트 제목",
    "callback": "01000000000",
    "content": "#{변수1} 테스트입니다.",
    "variables": {
        "변수1": "친구톡"
    },
    "reserve": 1,
    "sendDate": "2024-01-01 00:00:00",
    "fallback": 1,
    "fallbackMessage": "테스트입니다.",
    "adFlag": 1,
    "destination": [
        {
            "phone": "01000000000",
            "params": {
            }
        }
    ],
    "attachment": {
        "button": [
            {
                "name": "버튼1",
                "type": "WL",
                "urlPc": "https://www.nitsoft.co.kr",
                "urlMobile": "https://www.nitsoft.co.kr"
            }
        ]
    },
    "isTest": 1
}

Response

{
"historyIdx": 1742,
"count": 1
}

ErrorResponse

{
    "statusCode": 400,
    "error": "Bad Request",
    "message": [
        "테스트 발송 여부를 입력해주세요. (isTest)"
    ]
}

친구톡 이전 메시지 목록 조회

get

EndPoint

GET /kakao/friendtalk/previous/{channelId}

Parameters

channelId

*

채널 아이디

Parameters Query

search

검색어

save

찜

page

페이지 번호

perPage

페이지 당 결과물 수

Response

- JSON

statusCode

오류 코드

error

오류 메세지

message

결과 메세지

total

총 결과물 수

list

데이터

messageIdx

이전 메시지 고유번호

channelId

채널 아이디

startAt

발송일시

messageType

메시지 유형

title

제목

Content

내용

attachment

버튼, 이미지, 아이템리스트 정보

carousel

캐러셀 정보

header

아이템리스트 제목

adFlag

광고 표시 여부

save

찜

Example

Request

GET /kakao/friendtalk/previous/{channelId}?search={search}&save={save}&page={page}&perPage={perPage}

Response

{
    "total": 23,
    "list": [
        {
            "messageIdx": 171,
            "channelId": "@example",
            "startAt": "2024-08-12T18:07:39.000Z",
            "messageType": "NONE",
            "title": "k",
            "content": "k",
            "attachment": null,
            "carousel": null,
            "header": null,
            "adFlag": 1,
            "save": 0
        },
        {
            "messageIdx": 170,
            "channelId": "@example",
            "startAt": "2024-08-08T19:43:16.000Z",
            "messageType": "NONE",
            "title": "test4",
            "content": "test4#{4}",
            "attachment": null,
            "carousel": null,
            "header": null,
            "adFlag": 1,
            "save": 0
        }
    ]
}

ErrorResponse

{
    "statusCode": 404,
    "error": "Not Found",
    "message": "채널을 찾을 수 없습니다."
}

친구톡 이전 메시지 조회

get

EndPoint

GET /kakao/friendtalk/previous/{channelId}/{messageIdx}

Parameters

channelId

채널 아이디

messageIdx

이전 메시지 고유번호

Response

- JSON

statusCode

오류 코드

error

오류 메세지

message

결과 메세지

messageIdx

이전 메시지 고유번호

channelid

채널 아이디

startAt

발송 일시

messageType

메시지 유형

title

제목

content

내용

attachment

버튼,이미지,아이템리스트 정보

carousel

캐러셀 정보

header

아이템리스트 제목

adFlag

광고 표시 여부

save

찜

Example

Request

GET /kakao/friendtalk/previous/{channelId}/{messageIdx}

Response

{
    "messageIdx": 171,
    "channelId": "@example",
    "startAt": "2024-08-12T18:07:39.000Z",
    "messageType": "NONE",
    "title": "k",
    "content": "k",
    "attachment": null,
    "carousel": null,
    "header": null,
    "adFlag": 1,
    "save": 0
}

ErrorResponse

{
    "statusCode": 404,
    "error": "Not Found",
    "message": "이전 메시지를 찾을 수 없습니다."
}

친구톡 이전 메시지 찜/해제

put

EndPoint

PUT /kakao/friendtalk/previous/{channelId}/{messageIdx}

Parameters

channelId

채널 아이디

messageIdx

이전 메시지 고유번호

Response

- JSON

statusCode

오류 코드

error

오류 메세지

message

결과 메세지

messageIdx

이전 메시지 고유번호

channelid

채널 아이디

startAt

발송 일시

messageType

메시지 유형

title

제목

content

내용

attachment

버튼,이미지,아이템리스트 정보

carousel

캐러셀 정보

header

아이템리스트 제목

adFlag

광고 표시 여부

save

찜

Example

Request

PUT /kakao/friendtalk/previous/{channelId}/{messageIdx}

Response

{
    "messageIdx": 171,
    "channelId": "@example",
    "startAt": "2024-08-12T18:07:39.000Z",
    "messageType": "NONE",
    "title": "k",
    "content": "k",
    "attachment": "null",
    "carousel": "null",
    "header": "null",
    "adFlag": 1,
    "save": 0
}

ErrorResponse

{
    "statusCode": 404,
    "error": "Not Found",
    "message": "이전 메시지를 찾을 수 없습니다."
}

친구톡 이전 메시지 삭제

delete

EndPoint

DELETE /kakao/friendtalk/previous/{channelId}/{messageIdx}

Parameters

channelId

채널 아이디

messageIdx

이전 메시지 고유번호

Response

- JSON

statusCode

오류 코드

error

오류 메세지

message

결과 메세지

messageIdx

이전 메시지 고유번호

channelid

채널 아이디

startAt

발송 일시

messageType

메시지 유형

title

제목

content

내용

attachment

버튼,이미지,아이템리스트 정보

carousel

캐러셀 정보

header

아이템리스트 제목

adFlag

광고 표시 여부

save

찜

Example

Request

DELETE /kakao/friendtalk/previous/{channelId}/{messageIdx}

Response

{
    "messageIdx": 171,
    "channelId": "@example",
    "startAt": "2024-08-12T18:07:39.000Z",
    "messageType": "NONE",
    "title": "k",
    "content": "k",
    "attachment": null,
    "carousel": null,
    "header": null,
    "adFlag": 1,
    "save": 0
}

ErrorResponse

{
    "statusCode": 404,
    "error": "Not Found",
    "message": "이전 메시지를 찾을 수 없습니다."
}