친구톡
친구톡은 정보/광고성 메시지를 카카오톡 메시지 발송하는 것으로, 알림톡과는 달리 카카오톡 친구로 추가한 사용자에게만 발송할 수 있습니다. 친구톡은 전화번호 정보로 발송되며, 등록된 전화번호로 모두 메시지가 발송되는 것이 아닌 서비스 정책상 카카오톡 채널을 추가한 사용자 대상으로만 광고성 메시지 발송됩니다.
안내
- 친구톡 발송 API를 호출하기 전, OAuth 2.0 인증 API를 선제적으로 호출해야 합니다.
- API 기능별 예제는 Sample Code 문서를 참고하시기 바랍니다.
- 알림톡/친구톡 발송 시 버튼/이미지/강조 표기 등을 사용할 경우, 반드시 메시지 타입별 가이드를 준수해야 합니다.
주의
스테이징 서버는 카카오 운영 서버와 연동되어 있어 실제 메시지가 발송되므로, 메시지 오발송에 주의하시기 바랍니다.
친구톡 발송
친구톡 발송과 이미지 업로드를 위한 API는 다음과 같습니다.
Request
Request Syntax
코드예제친구톡 발송 Request Syntax
curl -X POST "https://{base_url}/v2/send/kakao" \
-H "accept: */*" \
-H "authorization: Bearer {oauthToken}" \
-H "Content-Type: application/json" \
-d '{
"message_type": "FT",
"sender_key": "{senderKey}",
"cid": "202210181600001",
"template_code": "TEMPLATE_001",
"phone_number": "01012341234",
"sender_no": "021112222",
"message": "알림톡 메시지",
"fall_back_yn": false
}'
메서드 | 요청 URL |
---|---|
POST | https://{base_url}/v2/send/kakao |
파라미터 | 유형 | 필수 여부 | 대분류 | 구분 | 설명 |
---|---|---|---|---|---|
base_url | String | 필수 |
운영 | 일반 | bizmsg-web.kakaoenterprise.com |
금융권 | bizmsg-bank.kakaoenterprise.com |
||||
증권 | bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | bizmsg-gov.kakaoenterprise.com |
||||
스테이징 | 일반 | stg-user.bizmsg.kakaoenterprise.com |
|||
금융권 | stg-bizmsg-bank.kakaoenterprise.com |
||||
증권 | stg-bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | stg-bizmsg-gov.kakaoenterprise.com |
Request Header
표친구톡 발송 Request Header파라미터 | 유형 | 필수 여부 | 설명 |
---|---|---|---|
accept | String | 필수 |
*/* 로 고정 |
authorization | String | 필수 |
Bearer {oauthToken} - {oauthToken} : OAuth 2.0 인증 API로 발급받은 액세스 토큰 |
Content-Type | String | 필수 |
application/json 으로 고정 |
Request Elements
표친구톡 발송 Request Elements프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
message_type | String | 필수 |
메시지 타입 - text(2) |
FT : 친구톡 |
|||
sender_key | String | 필수 |
발신 프로필 키 - text(40) |
cid | String | 필수 |
고객사 정의 Key ID |
template_code | String | 필수 |
실제 발송할 메시지 유형으로 등록된 템플릿의 코드 - text(30) |
phone_number | String | 필수 |
수신자 전화번호 - 국가코드( 82 ) 포함- text(16) |
sender_no | String | 필수 |
고객사 발신 전화번호 - text(16) |
message | String | 필수 |
수신자에게 전달할 친구톡 메시지 - text(1000) |
client_id | String | 선택 |
고객사 ID - 계약 시 발급받는 정보 |
user_key | String | 선택 |
카카오톡 채널 봇을 이용해 받은 카카오톡 채널 사용자 식별키 - text(30) |
price | Integer | 선택 |
message(수신자에게 전달될 메시지) 내 포함된 가격/금액/결제금액 |
currency_type | String | 선택 |
message(수신자에게 전달될 메시지) 내 포함된 가격/금액/결제금액의 통화단위 - KRW, USD, EUR 등 국제 통화 코드 사용 |
title | String | 선택 |
템플릿 내용 중 강조 표기할 핵심 정보 - text(50) |
header | String | 선택 |
메시지 상단에 표기할 제목 - text(16) |
ad_flag | String | 선택 |
광고성 메시지 필수 표기 사항을 노출 - text(1) |
Y (기본값): 노출 |
|||
N : 미노출 |
|||
timeout | Integer | 선택 |
Polling 방식 전송 시 성공 여부를 결정하기 위한 시간 |
Array | 선택 |
버튼 목록 정보 | |
chat_event | String | 선택 |
Bot 전환 시 연결할 Bot 이벤트명 |
chat_extra | String | 선택 |
상담톡/Bot 전환 시 전달할 메타정보 |
name | String | 필수 |
버튼 제목 |
scheme_android | String | 선택 |
Mobile Android 환경에서 버튼 클릭 시 실행할 application custom scheme |
scheme_ios | String | 선택 |
Mobile iOS 환경에서 버튼 클릭 시 실행할 application custom scheme |
type | String | 필수 |
버튼 타입 |
url_mobile | String | 선택 |
Mobile 환경에서 버튼 클릭 시 이동할 URL |
url_pc | String | 선택 |
PC 환경에서 버튼 클릭 시 이동할 URL |
Array | 선택 |
바로가기 목록 정보 | |
chat_event | String | 선택 |
Bot 전환 시 연결할 Bot 이벤트명 |
chat_extra | String | 선택 |
상담톡/Bot 전환 시 전달할 메타정보 |
name | String | 필수 |
버튼 제목 |
scheme_android | String | 선택 |
Mobile Android 환경에서 버튼 클릭 시 실행할 application custom scheme |
scheme_ios | String | 선택 |
Mobile iOS 환경에서 버튼 클릭 시 실행할 application custom scheme |
type | String | 필수 |
버튼 타입 |
url_mobile | String | 선택 |
Mobile 환경에서 버튼 클릭 시 이동할 URL |
url_pc | String | 선택 |
PC 환경에서 버튼 클릭 시 이동할 URL |
biz_no | String | 선택 |
최초 발신자 식별 코드 (재판사용) |
fall_back_yn | Boolean | 필수 |
대체 메시지 전송 여부 |
true : 대체 메시지를 전송 |
|||
false (기본값): 대체 메시지를 전송하지 않음 |
|||
fall_back_message_type | String | 선택 |
대체 메시지 발송 시, 메시지 유형 - text(2) |
SM : SMS로 대체 발송 |
|||
LM : LMS로 대체 발송 |
|||
fall_back_title | String | 선택 |
대체 발송 메시지 제목 |
fall_back_message | String | 선택 |
대체 발송 메시지 본문 - text(2000) |
Image | 선택 |
노출할 이미지 정보 | |
img_link | String | 선택 |
이미지 클릭 시 이동할 URL을 설정하지 않았을 때 사용할 카카오톡 내 이미지 뷰어 링크 |
img_url | String | 필수 |
노출할 이미지 |
Object | 선택 |
아이템 리스트와 아이템 요약 정보 | |
Array | 필수 |
아이템 리스트 | |
Object | 선택 |
아이템 요약 정보 | |
Object | 선택 |
아이템 하이라이트 | |
title | String | 필수 |
타이틀 - 이미지가 있는 경우 최대 21자 - text(30) |
description | String | 필수 |
부가정보 - 이미지가 있는 경우 최대 13자 - text(19) |
tax_cd1 | String | 선택 |
정산 코드 1 - 고객사가 정산을 위해 정의하여 사용하는 변수 - text(50) |
tax_cd2 | String | 선택 |
정산 코드 2 - 고객사가 정산을 위해 정의하여 사용하는 변수 - text(50) |
Response
Response Syntax
코드예제친구톡 발송 Response Syntax
{
"code": "200",
"uid": "",
"cid": "",
"result": {
"detail_code": "NRM0000",
"detail_message": "성공"
}
}
Response Elements
표친구톡 발송 Response Elements프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
code | String | 필수 |
메시지 발송 결과 코드 |
100 : 발송 진행 중(처리 중) |
|||
200 : 성공 |
|||
400 : 권한 오류 |
|||
410 : 입력값이 유효하지 않음 |
|||
420 : 파일/이미지 관련 오류 |
|||
500 : 내부 시스템 오류 |
|||
510 : 발송 실패 |
|||
520 : 실패되었으나 재발송 가능 |
|||
uid | String | 선택 |
메시지 Key ID |
cid | String | 선택 |
고객사 정의 Key ID |
Object | 선택 |
세부 결과 정보(참고용) | |
detail_code | String | 선택 |
세부 결과 코드(참고용) |
detail_message | String | 선택 |
세부 결과 메시지(참고용) |
친구톡 일반 이미지 업로드
다음은 친구톡 발송 전 이미지를 업로드 하기 위한 API 기능에 대한 설명입니다.
Request
Request Syntax
코드예제친구톡 일반 이미지 업로드 Request Syntax
curl -X POST "http://{base_url}/v2/upload/ft/image" \
-H "accept: */*" \
-H "authorization: Bearer {oauthToken}" \
-H "Content-Type: multipart/form-data" \
-F "image=@FT_IMAGE.png;type=image/png"
메서드 | 요청 URL |
---|---|
POST | http://{base_url}/v2/upload/ft/image |
파라미터 | 유형 | 필수 여부 | 대분류 | 구분 | 설명 |
---|---|---|---|---|---|
base_url | String | 필수 |
운영 | 일반 | bizmsg-web.kakaoenterprise.com |
금융권 | bizmsg-bank.kakaoenterprise.com |
||||
증권 | bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | bizmsg-gov.kakaoenterprise.com |
||||
스테이징 | 일반 | stg-user.bizmsg.kakaoenterprise.com |
|||
금융권 | stg-bizmsg-bank.kakaoenterprise.com |
||||
증권 | stg-bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | stg-bizmsg-gov.kakaoenterprise.com |
Request Header
표친구톡 일반 이미지 업로드 Request Header파라미터 | 유형 | 필수 여부 | 설명 |
---|---|---|---|
accept | String | 필수 |
*/* 로 고정 |
authorization | String | 필수 |
Bearer {oauthToken} - {oauthToken} : OAuth 2.0 인증 API로 발급받은 액세스 토큰 |
Content-Type | String | 필수 |
multipart/form-data 로 고정 |
Request Elements
표친구톡 일반 이미지 업로드 Request Elements프로퍼티 | 유형 | 필수 여부 | 설명 |
---|---|---|---|
image | File | 필수 |
이미지 업로드 요청 |
이미지 상세
친구톡 발송 시 사용될 이미지의 상세 사양은 다음과 같습니다.
표이미지 상세 사양구분 | 설명 |
---|---|
권장 사이즈 | 720px*720px |
제한 사이즈 | 다음의 경우 업로드 불가 - 가로 500px 미만인 경우 - 가로:세로 비율이 2:1 미만 혹은 3:4 초과인 경우 |
파일 형식 | jpg , png |
파일 크기 | 최대 500KB |
Response
Response Syntax
코드예제친구톡 일반 이미지 업로드 Response Syntax
{
"code": "200",
"image": "https://mud-kage.kakao.com/dn/vrLEd/btq6LeEmTgd/bQSvTliqYH3DPxk2PpwQ70",
"result": {
"detail_code": "NRM0000",
"detail_message": "성공"
}
}
Reponse Elements
표친구톡 일반 이미지 업로드 Response Elements프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
code | String | 필수 |
결과 코드 |
200 (OK): 성공, 업로드 이미지 정보 응답 |
|||
201 (Created): 성공적으로 요청되었으며 서버가 새 리소스를 작성 |
|||
401 (Unauthorized): 권한 없음 |
|||
402 (Forbidden): 서버가 요청을 거부함 |
|||
404 (Not Found): 서버가 요청한 페이지(Resource)를 찾을 수 없음 |
|||
image | String | 선택 |
업로드된 이미지 URL |
Object | 선택 |
세부 결과 정보(참고용) | |
detail_code | String | 선택 |
세부 결과 코드(참고용) |
detail_message | String | 선택 |
세부 결과 메시지(참고용) |
안내
API 기능별 코드는 Sample Code 문서를 참고하시기 바랍니다.
친구톡 와이드 이미지 업로드
다음은 친구톡 발송 전 와이드 이미지를 업로드 하기 위한 API 기능에 대한 설명입니다.
Request
Request Syntax
코드예제친구톡 와이드 이미지 업로드 Request Syntax
curl -X POST "http://{base_url}/v2/upload/ft/wide/image" \
-H "accept: */*" \
-H "authorization: Bearer {oauthToken}" \
-H "Content-Type: multipart/form-data" \
-F "image=@FT_IMAGE.png;type=image/png"
메서드 | 요청 URL |
---|---|
POST | http://{base_url}/v2/upload/ft/wide/image |
파라미터 | 유형 | 필수 여부 | 대분류 | 구분 | 설명 |
---|---|---|---|---|---|
base_url | String | 필수 |
운영 | 일반 | bizmsg-web.kakaoenterprise.com |
금융권 | bizmsg-bank.kakaoenterprise.com |
||||
증권 | bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | bizmsg-gov.kakaoenterprise.com |
||||
스테이징 | 일반 | stg-user.bizmsg.kakaoenterprise.com |
|||
금융권 | stg-bizmsg-bank.kakaoenterprise.com |
||||
증권 | stg-bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | stg-bizmsg-gov.kakaoenterprise.com |
Request Header
표친구톡 와이드 이미지 업로드 Request Header파라미터 | 유형 | 필수 여부 | 설명 |
---|---|---|---|
accept | String | 필수 |
*/* 로 고정 |
authorization | String | 필수 |
Bearer {oauthToken} - {oauthToken} : OAuth 2.0 인증 API로 발급받은 액세스 토큰 |
Content-Type | String | 필수 |
multipart/form-data 로 고정 |
Request Elements
표친구톡 와이드 이미지 업로드 Request Elements프로퍼티 | 유형 | 필수 여부 | 설명 |
---|---|---|---|
image | File | 필수 |
업로드할 와이드 이미지로, 다음의 사양을 충족해야 함 - 권장 사이즈: 800px*600px - 파일 형식: jpg , png , 파일 크기: 최대 2MB |
Response
Response Syntax
코드예제친구톡 와이드 이미지 업로드 Response Syntax
{
"code": "200",
"image": "https://mud-kage.kakao.com/dn/vrLEd/btq6LeEmTgd/bQSvTliqYH3DPxk2PpwQ70",
"result": {
"detail_code": "NRM0000",
"detail_message": "성공"
}
}
Response Elements
표친구톡 와이드 이미지 업로드 Reponse Elements프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
code | String | 필수 |
메시지 발송 결과 코드 |
100 : 발송 진행 중(처리 중) |
|||
200 : 성공 |
|||
400 : 권한 오류 |
|||
410 : 입력값이 유효하지 않음 |
|||
420 : 파일/이미지 관련 오류 |
|||
500 : 내부 시스템 오류 |
|||
510 : 발송 실패 |
|||
520 : 실패되었으나 재발송 가능 |
|||
image | String | 선택 |
업로드된 이미지 URL |
Object | 선택 |
세부 결과 정보 (참고용) | |
detail_code | String | 선택 |
세부 결과 코드 (참고용) |
detail_message | String | 선택 |
세부 결과 메시지 (참고용) |
안내
API 기능별 코드는 Sample Code 문서를 참고하시기 바랍니다.
친구톡 발송 정보 리스트 조회
친구톡 발송 결과의 상태 리스트를 상세하게 조회할 수 있는 API 기능에 대한 설명입니다.
안내
GET과 POST는 Query를 사용하는지 Body를 사용하는지의 차이입니다. (GET은 Deprecated 예정입니다.)
Request
Request Syntax
코드예제친구톡 발송 정보 리스트 조회 Request Syntax
curl -X 'POST' \
'https://{base_url}/v2/info/ft/search/detail/{uid}' \
-H 'accept: */*' \
-H 'Authorization: Bearer {oauthToken}' \
-H 'Content-Type: application/json' \
-d '{
"start_date": "2022-10-18",
"end_date": "2022-10-18",
"size": 1000
}'
메서드 | 요청 URL |
---|---|
POST | https://{base_url}/v2/info/ft/search/detail/{uid} |
파라미터 | 유형 | 필수 여부 | 대분류 | 구분 | 설명 |
---|---|---|---|---|---|
base_url | String | 필수 |
운영 | 일반 | bizmsg-web.kakaoenterprise.com |
금융권 | bizmsg-bank.kakaoenterprise.com |
||||
증권 | bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | bizmsg-gov.kakaoenterprise.com |
||||
스테이징 | 일반 | stg-user.bizmsg.kakaoenterprise.com |
|||
금융권 | stg-bizmsg-bank.kakaoenterprise.com |
||||
증권 | stg-bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | stg-bizmsg-gov.kakaoenterprise.com |
||||
uid | String | 필수 |
메시지 Key ID - ex. 21018173501346cxU7zEswSYSsTmS |
Request Header
표친구톡 발송 정보 리스트 조회 Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
accept | String | 필수 |
*/* 로 고정 |
Authorization | String | 필수 |
Bearer {oauthToken} - {oauthToken} : OAuth 2.0 인증 API로 발급받은 액세스 토큰 |
Content-Type | String | 필수 |
application/json 로 고정 |
Request Elements
표친구톡 발송 정보 리스트 조회 Request Elements파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
start_date | String | 선택 |
검색 시작일 - 형식: yyyy-mm-dd (date)- 시작일 입력 시 종료일도 필수 입력, 입력값이 없을 경우 당일 데이터를 검색 |
end_date | String | 선택 |
검색 종료일 - 형식: yyyy-mm-dd (date)- 종료일 입력 시 시작일도 필수 입력, 입력값이 없을 경우 당일 데이터를 검색 |
client_id | String | 선택 |
발송 고객사 ID |
size | Integer | 선택 |
페이지 당 리스트 수 - 최댓값: 1000 - int32 |
last_uid | String | 선택 |
조회한 페이지 리스트의 마지막 메시지 Key ID - 다음 페이지 조회 시 필수 |
etc1 | String | 선택 |
고객사 정의 값 1 - text(50) |
etc2 | String | 선택 |
고객사 정의 값 2 - text(50) |
status_code | String | 선택 |
메시지 상태 코드 - 상세 정보는 API 메시지 상태 코드 참고 |
Response
Response Syntax
코드예제친구톡 발송 정보 리스트 조회 Response Syntax
{
"status": "200",
"code": "200",
"message": "성공",
"count": 1,
"next": true,
"last_uid": "21018173501346cxU7zEswSYSsTmS",
"results": [
{
"uid": "21018173501346cxU7zEswSYSsTmS",
"reg_date": "2022-12-05T05:08:07.713Z",
"status_code": "API_200",
"error_message": "",
"kko_status_code": "0000",
"sms_status_code": "",
"etc1": "",
"etc2": "",
"etc3": "",
"etc4": "",
"etc5": "",
"etc6": "",
"etc7": "",
"etc8": "",
"etc9": "",
"etc10": "",
"tax_cd1": "",
"tax_cd2": "",
"cid": "202212050508070001"
}
]
}
Response Elements
표친구톡 발송 정보 리스트 조회 Response Elements프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
status | String | 필수 |
메시지 발송 결과 코드 |
100 : 발송 진행 중(처리 중) |
|||
200 : 성공 |
|||
400 : 권한 오류 |
|||
410 : 입력값이 유효하지 않음 |
|||
420 : 파일/이미지 관련 오류 |
|||
500 : 내부 시스템 오류 |
|||
510 : 발송 실패 |
|||
520 : 실패되었으나 재발송 가능 |
|||
code | String | 선택 |
응답 상태 코드 |
count | Integer | 선택 |
결과 정보 조회 시 리스트 수 -int64 |
next | Boolean | 선택 |
페이지 조회 시 다음 페이지 여부 |
last_uid | String | 선택 |
조회한 페이지 리스트의 마지막 메시지 Key ID |
Object | 선택 |
메시지 상태 상세 코드 | |
detail_code | String | 선택 |
상세 코드 |
detail_message | String | 선택 |
상세 메시지 |
Array | 선택 |
메시지 결과 조회 리스트 | |
uid | String | 선택 |
메시지의 Key ID |
cid | String | 선택 |
고객사 정의 Key ID |
reg_date | String | 선택 |
메시지 등록일 |
status_code | String | 선택 |
메시지 상태 코드 - 상세 정보는 API 메시지 상태 코드 참고 |
kko_status_code | String | 선택 |
카카오톡에서 전송되는 처리 결과 코드 |
sms_status_code | String | 선택 |
SMS 처리 결과 코드 |
error_message | String | 선택 |
에러 메시지(오류 시 존재하는 값) |
tax_cd1 | String | 선택 |
정산 코드1 - 고객사가 정산을 위해 정의하여 사용할 수 있는 변수 - text(50) |
tax_cd2 | String | 선택 |
정산 코드1 - 고객사가 정산을 위해 정의하여 사용할수 있는 변수 - text(50) |
etc1 | String | 선택 |
고객사 정의 Value1 - 고객사가 정의하여 사용하는 변수 - text(50) |
etc2 | String | 선택 |
고객사 정의 Value 2 - 고객사가 정의하여 사용하는 변수 - text(50) |
etc3 | String | 선택 |
고객사 정의 Value 3 - 고객사가 정의하여 사용하는 변수 - text(50) |
etc4 | String | 선택 |
고객사 정의 Value 4 - 고객사가 정의하여 사용하는 변수 - text(50) |
etc5 | String | 선택 |
고객사 정의 Value 5 - 고객사가 정의하여 사용하는 변수 - text(50) |
etc6 | String | 선택 |
고객사 정의 Value 6 - 고객사가 정의하여 사용하는 변수 - text(50) |
etc7 | String | 선택 |
고객사 정의 Value 7 - 고객사가 정의하여 사용하는 변수 - text(50) |
etc8 | String | 선택 |
고객사 정의 Value 8 - 고객사가 정의하여 사용하는 변수 - text(50) |
etc9 | String | 선택 |
고객사 정의 Value 9 - 고객사가 정의하여 사용하는 변수 - text(50) |
etc10 | String | 선택 |
고객사 정의 Value 10 - 고객사가 정의하여 사용하는 변수 - text(50) |
친구톡 발송 상세 정보 조회
친구톡 발송 결과를 상세하게 조회할 수 있는 API 기능에 대한 설명입니다.
Request
Request Syntax
코드예제친구톡 발송 상세 정보 조회 Request Syntax
curl -X 'GET' \
'https://{base_url}/v2/info/ft/search/detail/{uid}' \
-H 'accept: */*' \
-H 'Authorization: Bearer {oauthToken}'
메서드 | 요청 URL |
---|---|
GET | https://{base_url}/v2/info/ft/search/detail/{uid} |
파라미터 | 유형 | 필수 여부 | 대분류 | 구분 | 설명 |
---|---|---|---|---|---|
base_url | String | 필수 |
운영 | 일반 | bizmsg-web.kakaoenterprise.com |
금융권 | bizmsg-bank.kakaoenterprise.com |
||||
증권 | bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | bizmsg-gov.kakaoenterprise.com |
||||
스테이징 | 일반 | stg-user.bizmsg.kakaoenterprise.com |
|||
금융권 | stg-bizmsg-bank.kakaoenterprise.com |
||||
증권 | stg-bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | stg-bizmsg-gov.kakaoenterprise.com |
||||
uid | String | 필수 |
메시지 Key ID - ex. 21018173501346cxU7zEswSYSsTmS |
Request Header
표친구톡 발송 상세 정보 조회 Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
accept | String | 필수 |
*/* 로 고정 |
Authorization | String | 필수 |
Bearer {oauthToken} - {oauthToken} : OAuth 2.0 인증 API로 발급받은 액세스 토큰 |
Response
Response Syntax
코드예제친구톡 발송 상세 정보 조회 Response Syntax
{
"code": "200",
"code_detail": {
"detail_code": "NRM00000",
"detail_message": "성공"
},
"result": {
"uid": "221018173501346cxU7zEswSYSsTmS",
"reg_date": "2022-10-18T17:35:01",
"message_type": "FT",
"status_code": "API_200",
"phone_number": "01000000000",
"req_date": "2022-10-18T17:35:01",
"req_sms_yn": "N",
"message": "DMA3lRw9gr/khDXYmAhGcuyHnQ5FOHmJAOuPgYCr8NM=",
"cid": "202210189990001"
}
}
Response Elements
표친구톡 발송 상세 정보 조회 Response Elements프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
code | String | 필수 |
메시지 발송 결과 코드 |
100 : 발송 진행 중(처리 중) |
|||
200 : 성공 |
|||
400 : 권한 오류 |
|||
410 : 입력값이 유효하지 않음 |
|||
420 : 파일/이미지 관련 오류 |
|||
500 : 내부 시스템 오류 |
|||
510 : 발송 실패 |
|||
520 : 실패되었으나 재발송 가능 |
|||
Object | 선택 |
메시지 상태 상세 코드 | |
detail_code | String | 선택 |
상세 코드 |
detail_message | String | 선택 |
상세 메시지 |
Object | 선택 |
단일 메시지의 발송 결과 상세 조회 | |
uid | String | 선택 |
메시지의 Key ID |
reg_date | String | 선택 |
메시지 등록일(date) |
message_type | String | 선택 |
메시지 타입 |
AT : 알림톡 |
|||
AI : 알림톡 이미지 |
|||
FT : 친구톡 |
|||
FI : 친구톡 이미지 |
|||
FW : 친구톡 와이드 이미지 |
|||
SM : SMS |
|||
LM : LMS |
|||
MM : MMS |
|||
ISM : 국제 SMS |
|||
status_code | String | 선택 |
메시지 상태 코드 - 상세 정보는 API 메시지 상태 코드 참고 |
phone_number | String | 선택 |
수신자 전화번호(국가코드(82) 포함) - text(16) |
req_date | String | 선택 |
발송 요청일(결과 존재 시 존재하는 값)(date) |
error_message | String | 선택 |
에러 메시지(오류 시 존재) |
req_sms_yn | String | 선택 |
SMS 발송 요청 여부 |
req_sms_date | String | 선택 |
SMS 발송 요청일(date-time) |
sender_no | String | 선택 |
고객사 발신 전화번호 - text(16) |
sms_type | String | 선택 |
대체발송 시 메시지 타입 - text(2) |
SM : SMS로 대체 발송 |
|||
LM : LMS로 대체 발송 |
|||
MM : MMS로 대체 발송 |
|||
kko_status_code | String | 선택 |
카카오톡에서 전송되는 처리 결과 코드 |
sms_status_code | String | 선택 |
SMS 처리 결과 코드 |
message | String | 선택 |
수신자에게 전달될 Kakao 메시지 - text(1000) |
sms_message | String | 선택 |
전달할 SMS 메시지 - text(400) |
title | String | 선택 |
LMS, MMS 전송 시 TITLE - text(60) |
cid | String | 선택 |
고객사 정의 Key ID |
kko_title | String | 선택 |
템플릿 내용 중 강조 표기할 핵심 정보 - text(50) |
image_type | Boolean | 선택 |
와이드 버블 사용 여부 - text(1) |
Y : 와이드 버블을 사용 |
|||
N (기본값): 와이드 버블을 사용 안 함 |
|||
nat_cd | String | 선택 |
국제 발송 시 국가 코드 |
content_group_id | String | 선택 |
[MMS] 전송할 파일 그룹 ID contentGroupId (MMS 전송 시 필수) |
header | String | 선택 |
메시지 상단에 표기할 제목 |