상담톡
상담톡은 카카오톡 채널을 통해 고객과 1:1 상담 메시지를 송수신하고, 상담 세션과 운영 설정을 함께 관리할 수 있는 카카오 비즈메시지 채널입니다.
상담하기
Plain 메시지 발송
상담톡 Plain 메시지를 발송합니다. msgType에 따라 TEXT, IMAGE, VIDEO, AUDIO, FILE을 발송할 수 있습니다.
Body Parameters
{}JSONuserKey
필수String사용자 키입니다.
senderKey
필수String발신프로필 키입니다.
msgType
필수String메시지 타입입니다.
message
필수String사용자에게 전달할 메시지입니다. 최대 1,000자입니다.
attachment
Object첨부 메시지 객체입니다. IMAGE, VIDEO, AUDIO, FILE 타입에서 사용합니다.
ref
String참조 필드입니다. 최대 200자이며 전송 요청 결과 Webhook에서 함께 반환됩니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X POST "https://mars.ibapi.kr/api/comm/v1/cstalk/plain" \ -H "Authorization: {ApiKey}" \ -H "Content-Type: application/json" \ -d '{ "userKey":"{userKey}", "senderKey":"{senderKey}", "msgType":"TEXT", "message":"상담 안내 메시지입니다.", "ref":"client-ref-001"}'응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success", "msgKey":"20260424104234546POM101182450000", "ref":"client-ref-001" }}Rich 메시지 발송
상담톡 Rich 메시지를 발송합니다. TEXT, IMAGE, WIDE, ITEM_LIST, WIDE_ITEM_LIST, CAROUSEL_FEED, PERSONAL 타입을 지원합니다.
Body Parameters
{}JSONuserKey
필수String사용자 키입니다.
senderKey
필수String발신프로필 키입니다.
msgType
필수String메시지 풍선 타입입니다.
message
String사용자에게 전달할 메시지입니다.
description
String사용자에게 전달할 부가 메시지입니다.
header
String헤더입니다.
attachment
Object메시지 첨부 정보입니다.
carousel
Object캐러셀 정보입니다. CAROUSEL_FEED 타입에서 필수입니다.
autoAnswer
String시스템 자동 응답 메시지입니다.
lock
Boolean보안 메시지 여부입니다.
certExpiry
Integer본인인증 유효 시간(분)입니다. msgType이 KAKAO_CERT일 때 필수입니다.
ref
String참조 필드입니다. 최대 200자이며 전송 요청 결과 Webhook에서 함께 반환됩니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X POST "https://mars.ibapi.kr/api/comm/v1/cstalk/rich" \ -H "Authorization: {ApiKey}" \ -H "Content-Type: application/json" \ -d '{ "userKey":"{userKey}", "senderKey":"{senderKey}", "msgType":"TEXT", "message":"상담 안내 메시지입니다.", "attachment": { "buttons": [{ "type":"WL", "name":"바로가기", "urlMobile":"https://m.example.com", "urlPc":"https://www.example.com" }] }, "ref":"client-ref-001"}'응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success", "msgKey":"20260424104234546POM101182450000", "ref":"client-ref-001" }}상담 종료
현재 열려 있는 상담 세션을 종료합니다.
Body Parameters
{}JSONuserKey
필수String사용자 키입니다.
senderKey
필수String발신프로필 키입니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X POST "https://mars.ibapi.kr/api/comm/v1/cstalk/end" \ -H "Authorization: {ApiKey}" \ -H "Content-Type: application/json" \ -d '{ "userKey":"{userKey}", "senderKey":"{senderKey}"}'응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"header-value-X-Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success", "data": { "msgKey":"20260424104234546POM101182450000" }, "ref":"client-ref-001" }}상담 종료 및 봇 전환
상담 세션을 종료한 뒤 봇 이벤트 말블록을 실행합니다.
Body Parameters
{}JSONuserKey
필수String사용자 키입니다.
senderKey
필수String발신프로필 키입니다.
botEvent
String실행할 봇 이벤트명입니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X POST "https://mars.ibapi.kr/api/comm/v1/cstalk/endWithBot" \ -H "Authorization: {ApiKey}" \ -H "Content-Type: application/json" \ -d '{ "userKey":"{userKey}", "senderKey":"{senderKey}", "botEvent":"상담종료"}'응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"header-value-X-Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success", "data": { "msgKey":"20260424104234546POM101182450000" }, "ref":"client-ref-001" }}사용자 수신 차단
특정 사용자의 상담톡 수신을 차단합니다.
Body Parameters
{}JSONcstalk
필수Object상담톡 요청 객체입니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/cstalk/profile/user/block" \ -H "Authorization: {ApiKey}" \ -H "Content-Type: application/json" \ -d '{ "cstalk": { "senderKey":"{senderKey}", "userKey":"{userKey}" }}'응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success" }}사용자 수신 차단 해제
차단된 사용자의 상담톡 수신 차단을 해제합니다.
Body Parameters
{}JSONcstalk
필수Object상담톡 요청 객체입니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/cstalk/profile/user/unblock" \ -H "Authorization: {ApiKey}" \ -H "Content-Type: application/json" \ -d '{ "cstalk": { "senderKey":"{senderKey}", "userKey":"{userKey}" }}'응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success" }}세션 조회
사용자 키 기준으로 현재 상담 세션 정보를 조회합니다.
Query Parameters
QUERYuserKey
필수String사용자 키입니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/cstalk/session?userKey=userKeySample" \ -H "Authorization: {ApiKey}"응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"header-value-X-Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success", "data": { "session": { "sessionId": 1, "senderKey":"{senderKey}", "startedType":"UM", "startedAt":"2025-09-24T11:22:08.557", "expiredType":"AE", "expiredAt":"2025-10-25T10:00:00" } } }}카카오톡 인증 상태 조회
인증 트랜잭션 ID로 고객의 카카오톡 인증(전자서명) 진행 상태를 조회합니다.
Query Parameters
QUERYcertTxId
필수String인증 트랜잭션 ID입니다. 카카오가 인증 요청 시 발급합니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/cstalk/cert/status?certTxId=certTxIdSample" \ -H "Authorization: {ApiKey}"응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"header-value-X-Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success", "data": { "cert": { "txId":"{certTxId}", "sessionId": 1, "signStatus":"COMPLETED", "createdAt":"2026-09-10T10:00:00", "viewedAt":"2026-09-10T10:00:30", "completedAt":"2026-09-10T10:01:12", "expiredAt":"2026-09-10T10:10:00" } } }}상담메시지 수신하기 (Webhook)
사용자 메시지 수신
사용자 메시지 수신 Webhook입니다. 등록한 고객 Webhook URL로 사용자가 전송한 메시지 데이터를 전달합니다.
Body Parameters
{}JSONmsgKey
필수String메시지 키입니다.
userKey
필수String상담톡 사용자 키입니다.
senderKey
필수String메시지를 수신한 발신프로필 키입니다.
serviceType
필수String서비스 타입입니다.
msgType
필수String메시지 타입입니다.
requestType
String요청 타입입니다.
sendTime
필수String전송 일시입니다. ISO 8601 형식으로 전달됩니다.
reportTime
필수String리포트 일시입니다. ISO 8601 형식으로 전달됩니다.
kakaoTime
String상담톡 서버에서 메시지를 전달한 일시입니다. 실제 사용자가 입력한 시각은 아닙니다.
sessionId
String상담 세션 ID입니다.
content
String하위 호환을 위해 유지되는 본문 필드입니다.
extra
String카카오가 전달한 부가 정보입니다.
contents
Object Array사용자가 전송한 메시지 데이터 배열입니다. 2026년 1월 이후 content 필드는 제공되지 않으므로 contents를 사용합니다.
attachment
String사용자 메시지가 4,000자를 초과하는 경우 전체 메시지를 txt 파일 URL로 추가 전달하는 영역입니다.
Returns
code
StringWebhook 처리 결과 코드입니다.
result
StringWebhook 처리 결과 메시지입니다.
요청 예시
curl -X POST "{고객 Webhook URL}/cstalk/message" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "msgKey":"20260424104234546POM101182450000", "userKey":"{userKey}", "senderKey":"{senderKey}", "serviceType":"CSTALK", "msgType":"TEXT", "requestType":"message", "sendTime":"2026-04-24T10:42:34.546+09:00", "reportTime":"2026-04-24T10:42:35.120+09:00", "kakaoTime":"2026-04-24T10:42:35.000+09:00", "contents": [{ "comment":"상담 문의 내용입니다." }]}'응답 예시
{ "code":"A000", "result":"Success"}사용자 메타 정보 수신
사용자가 상담 연결을 요청한 시점의 메타 정보를 등록한 고객 Webhook URL로 전달합니다.
Body Parameters
{}JSONmsgKey
필수String메시지 키입니다.
userKey
필수String특정 카카오톡 사용자를 구분하는 키입니다. 카카오톡 채널별로 유효하며 대소문자를 구분합니다.
senderKey
필수String메시지를 수신한 발신프로필 키입니다.
serviceType
필수String서비스 타입입니다.
msgType
필수String메시지 타입입니다.
requestType
필수String요청 타입입니다.
sendTime
필수String전송 일시입니다. ISO 8601 형식으로 전달됩니다.
reportTime
필수String리포트 일시입니다. ISO 8601 형식으로 전달됩니다.
kakaoTime
String상담톡 서버에서 메시지를 전달한 일시입니다. 실제 사용자가 입력한 시각은 아닙니다.
appUserId
Number카카오톡 앱 사용자 ID입니다.
sessionId
String상담 세션 아이디입니다. 상담 세션이 생성된 상태에서 상담원이 메시지를 발송할 수 있습니다.
reference
Object고객사에서 설정한 현재 메타 정보입니다.
lastReference
Object현재 메타 정보가 없는 경우 전달되는 가장 마지막 메타 정보입니다.
Returns
code
StringWebhook 처리 결과 코드입니다.
result
StringWebhook 처리 결과 메시지입니다.
요청 예시
curl -X POST "{고객 Webhook URL}/cstalk/reference" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "msgKey":"20260424104234546POM101182450000", "userKey":"{userKey}", "senderKey":"{senderKey}", "serviceType":"CSTALK", "msgType":"REFERENCE", "requestType":"reference", "sendTime":"2026-04-24T10:42:34.546+09:00", "reportTime":"2026-04-24T10:42:35.120+09:00", "kakaoTime":"2026-04-24T10:42:35.000+09:00", "sessionId":"{sessionId}", "reference": { "extra":"orderNo=1234" }, "lastReference": { "extra":"orderNo=1233", "bot":"false", "bot_event":"상담시작", "created_at":"2026-04-23T09:30:00.000+09:00" }}'응답 예시
{ "code":"A000", "result":"Success"}세션 종료 수신
상담 세션이 종료되었을 때 등록한 고객 Webhook URL로 세션 종료 정보를 전달합니다.
Body Parameters
{}JSONmsgKey
필수String메시지 키입니다.
userKey
필수String상담톡 사용자 키입니다.
senderKey
필수String메시지를 수신한 발신프로필 키입니다.
serviceType
필수String서비스 타입입니다.
msgType
필수String메시지 타입입니다.
requestType
필수String요청 타입입니다.
sendTime
필수String전송 일시입니다. ISO 8601 형식으로 전달됩니다.
reportTime
필수String리포트 일시입니다. ISO 8601 형식으로 전달됩니다.
kakaoTime
String상담톡 서버에서 메시지를 전달한 일시입니다. 실제 사용자가 입력한 시각은 아닙니다.
sessionId
String종료된 상담 세션 아이디입니다.
Returns
code
StringWebhook 처리 결과 코드입니다.
result
StringWebhook 처리 결과 메시지입니다.
요청 예시
curl -X POST "{고객 Webhook URL}/cstalk/expired_session" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "msgKey":"20260424104234546POM101182450000", "userKey":"{userKey}", "senderKey":"{senderKey}", "serviceType":"CSTALK", "msgType":"SESSION", "requestType":"expired_session", "sendTime":"2026-04-24T10:42:34.546+09:00", "reportTime":"2026-04-24T10:42:35.120+09:00", "kakaoTime":"2026-04-24T10:42:35.000+09:00", "sessionId":"{sessionId}"}'응답 예시
{ "code":"A000", "result":"Success"}읽음 정보 수신
사용자 읽음 정보를 등록한 고객 Webhook URL로 전달합니다.
Body Parameters
{}JSONmsgKey
필수String메시지 키입니다.
userKey
필수String상담톡 사용자 키입니다.
senderKey
필수String메시지를 수신한 발신프로필 키입니다.
serviceType
필수String서비스 타입입니다.
msgType
필수String메시지 타입입니다.
requestType
필수String요청 타입입니다.
sendTime
필수String전송 일시입니다. ISO 8601 형식으로 전달됩니다.
reportTime
필수String리포트 일시입니다. ISO 8601 형식으로 전달됩니다.
kakaoTime
String상담톡 서버에서 메시지를 전달한 일시입니다. 실제 사용자가 입력한 시각은 아닙니다.
Returns
code
StringWebhook 처리 결과 코드입니다.
result
StringWebhook 처리 결과 메시지입니다.
요청 예시
curl -X POST "{고객 Webhook URL}/cstalk/seen_info" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "msgKey":"20260424104234546POM101182450000", "userKey":"{userKey}", "senderKey":"{senderKey}", "serviceType":"CSTALK", "msgType":"SEEN", "requestType":"seen_info", "sendTime":"2026-04-24T10:42:34.546+09:00", "reportTime":"2026-04-24T10:42:35.120+09:00", "kakaoTime":"2026-04-24T10:42:35.000+09:00"}'응답 예시
{ "code":"A000", "result":"Success"}개인정보 수신
사용자 개인정보 수집 동의 후 전달되는 개인정보를 등록한 고객 Webhook URL로 전달합니다.
Body Parameters
{}JSONmsgKey
필수String메시지 키입니다.
userKey
필수String상담톡 사용자 키입니다.
senderKey
필수String메시지를 수신한 발신프로필 키입니다.
serviceType
필수String서비스 타입입니다.
msgType
필수String메시지 타입입니다.
requestType
필수String요청 타입입니다.
sendTime
필수String전송 일시입니다. ISO 8601 형식으로 전달됩니다.
reportTime
필수String리포트 일시입니다. ISO 8601 형식으로 전달됩니다.
kakaoTime
String상담톡 서버에서 메시지를 전달한 일시입니다. 실제 사용자가 입력한 시각은 아닙니다.
sessionId
String상담 세션 아이디입니다.
personalInfo
Object사용자가 동의한 개인정보입니다.
Returns
code
StringWebhook 처리 결과 코드입니다.
result
StringWebhook 처리 결과 메시지입니다.
요청 예시
curl -X POST "{고객 Webhook URL}/cstalk/personal_info" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "msgKey":"20260424104234546POM101182450000", "userKey":"{userKey}", "senderKey":"{senderKey}", "serviceType":"CSTALK", "msgType":"PERSONAL", "requestType":"personal_info", "sendTime":"2026-04-24T10:42:34.546+09:00", "reportTime":"2026-04-24T10:42:35.120+09:00", "kakaoTime":"2026-04-24T10:42:35.000+09:00", "sessionId":"{sessionId}", "personalInfo": { "phone_number":"0100000000", "nickname":"홍길동" }}'응답 예시
{ "code":"A000", "result":"Success"}본인인증 결과 수신
본인인증 결과 수신 Webhook입니다. KAKAO_CERT 말풍선으로 요청한 카카오톡 본인인증(전자서명)이 완료되면 등록된 Webhook URL로 결과가 전달됩니다.
Body Parameters
{}JSONmsgKey
필수String메시지 키입니다.
userKey
필수String사용자 키입니다.
senderKey
필수String발신프로필 키입니다.
serviceType
필수String서비스 타입입니다.
msgType
필수String메시지 타입입니다.
requestType
필수String요청 타입입니다. cert_result로 전달됩니다.
sendTime
필수String수신 일시입니다. (ISO 8601, yyyy-MM-dd'T'HH:mm:ss.SSS).
reportTime
필수String리포트 일시입니다. (ISO 8601, yyyy-MM-dd'T'HH:mm:ss.SSS).
kakaoTime
String카카오 서버 수신 일시입니다.
sessionId
String상담 세션 ID입니다.
certTxId
필수String인증 트랜잭션 ID입니다. 인증 상태 조회 API의 certTxId와 같은 값입니다.
certResult
필수String암호화된 본인인증 결과입니다. 복호화하면 이름·전화번호·생년월일·성별·내외국인·CI가 들어 있습니다.
Returns
code
StringWebhook 처리 결과 코드입니다.
result
StringWebhook 처리 결과 메시지입니다.
요청 예시
curl -X POST "{고객 Webhook URL}/cstalk/cert_result" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "msgKey":"20260424104234546POM101182450000", "userKey":"{userKey}", "senderKey":"{senderKey}", "serviceType":"CSTALK", "msgType":"KAKAO_CERT", "requestType":"cert_result", "sendTime":"2026-04-24T10:42:34.546+09:00", "reportTime":"2026-04-24T10:42:35.120+09:00", "kakaoTime":"2026-04-24T10:42:35.000+09:00", "sessionId":"{sessionId}", "certTxId":"{certTxId}", "certResult":"amI1a0dQTVVRSm1YTk9BNW9tYWpXdz09" }'응답 예시
{ "code":"A000", "result":"Success"}발송 결과 수신
상담톡 메시지 전송 요청 결과를 등록한 고객 Webhook URL로 전달합니다.
Body Parameters
{}JSONmsgKey
필수String메시지 키입니다.
userKey
필수String상담톡 사용자 키입니다.
senderKey
필수String메시지를 수신한 발신프로필 키입니다.
serviceType
필수String서비스 타입입니다.
msgType
String메시지 타입입니다.
requestType
필수String요청 타입입니다. write, end, endwithbot 중 하나입니다.
sendTime
필수String전송 일시입니다. ISO 8601 형식으로 전달됩니다.
reportTime
필수String리포트 일시입니다. ISO 8601 형식으로 전달됩니다.
reportCode
String발송 결과 코드입니다. 카카오 응답 코드를 비즈고 코드로 변환한 값입니다.
reportText
String리포트 메시지입니다.
kakaoResCreatedAt
String카카오 응답 생성 일시입니다. (ISO 8601).
ref
String요청 시 전달한 참조 필드입니다.
Returns
code
StringWebhook 처리 결과 코드입니다.
result
StringWebhook 처리 결과 메시지입니다.
요청 예시
curl -X POST "{고객 Webhook URL}/cstalk/result" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "msgKey":"20260424104234546POM101182450000", "userKey":"{userKey}", "senderKey":"{senderKey}", "serviceType":"CSTALK", "msgType":"TEXT", "requestType":"write", "sendTime":"2026-04-24T10:42:34.546+09:00", "reportTime":"2026-04-24T10:42:35.120+09:00", "reportCode":"A000", "reportText":"Success", "ref":"client-ref-001"}'응답 예시
{ "code":"A000", "result":"Success"}파일 업로드
이미지 업로드
상담톡 이미지 파일을 업로드합니다. jpg, png, gif 형식을 지원하며 최대 5MB까지 등록할 수 있습니다.
Body Parameters
FORM-DATAfile
필수Binary업로드할 이미지 파일입니다.
fileKey
String업로드 파일을 식별하는 키입니다. 생략하면 서버가 자동으로 생성합니다.
imageName
String업로드 파일의 이름입니다. 생략하면 확장자를 제외한 파일명을 사용합니다.
senderKey
필수String카카오 비즈메시지 발신프로필 키입니다.
imageType
String이미지 타입입니다. Rich 메시지 이미지 업로드 시 rich를 입력합니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X POST "https://mars.ibapi.kr/api/comm/v1/file/cstalk/image" \ -H "Authorization: {ApiKey}" \ -H "Content-Type: multipart/form-data" \ -F "file=@sample.jpg" \ -F "senderKey={senderKey}" \ -F "imageType=rich"응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"header-value-X-Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success", "data": { "imgUrl":"https://mud-kage.kakao.com/.../cstalk_image.jpg" } }}파일 업로드
상담톡 FILE·AUDIO·VIDEO 타입 첨부 파일을 업로드합니다.
Body Parameters
FORM-DATAfile
필수Binary업로드할 파일 바이너리입니다.
fileKey
String업로드 파일을 식별하는 키입니다. 생략하면 서버가 자동으로 생성합니다.
imageName
String업로드 파일의 이름입니다. 생략하면 확장자를 제외한 파일명을 사용합니다.
senderKey
필수String카카오 비즈메시지 발신프로필 키입니다.
fileType
String파일 타입입니다. file: 일반 파일, audio: 오디오 파일, video: 비디오 파일입니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X POST "https://mars.ibapi.kr/api/comm/v1/file/cstalk" \ -H "Authorization: {ApiKey}" \ -H "Content-Type: multipart/form-data" \ -F "file=@sample.pdf" \ -F "senderKey={senderKey}" \ -F "fileType=file"응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"header-value-X-Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success", "data": { "fileUrl":"https://mud-kage.kakao.com/.../cstalk_file.pdf", "fileName":"sample.pdf", "size":"102400" } }}채널 관리하기
상담톡 등록
발신프로필을 상담톡에 등록합니다. 상담톡 권한 부여, 발신프로필 등록, 계정 연결이 차례로 진행되며, 각 단계의 결과를 data.steps로 돌려줍니다. 중간 단계가 실패하면 실패한 단계까지 담기므로 어느 단계에서 멈췄는지 확인할 수 있습니다.
상담톡 수정
API 키로 등록한 상담톡의 웹훅 URL, 상담톡·채팅 활성화 여부 등을 수정합니다. 대상 발신프로필 키는 경로로 지정하며 바꿀 수 없습니다. envType은 등록한 환경과 같아야 합니다.
상담톡 이용 활성화
상담톡 이용을 활성화합니다.
Body Parameters
{}JSONcstalk
필수Object상담톡 요청 객체입니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/cstalk/sender/activate" \ -H "Authorization: {ApiKey}" \ -H "Content-Type: application/json" \ -d '{ "cstalk": { "senderKey":"{senderKey}", "committalCompany":"비즈고" }}'응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success" }}상담톡 이용 비활성화
상담톡 이용을 비활성화합니다.
Body Parameters
{}JSONcstalk
필수Object상담톡 요청 객체입니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/cstalk/sender/deactivate" \ -H "Authorization: {ApiKey}" \ -H "Content-Type: application/json" \ -d '{ "cstalk": { "senderKey":"{senderKey}", "committalCompany":"비즈고" }}'응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success" }}채팅 기능 활성화
카카오톡 채널의 채팅 기능을 활성화합니다.
Body Parameters
{}JSONcstalk
필수Object상담톡 요청 객체입니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/cstalk/sender/chat/activate" \ -H "Authorization: {ApiKey}" \ -H "Content-Type: application/json" \ -d '{ "cstalk": { "senderKey":"{senderKey}" }}'응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success" }}채팅 기능 비활성화
카카오톡 채널의 채팅 기능을 비활성화합니다.
Body Parameters
{}JSONcstalk
필수Object상담톡 요청 객체입니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/cstalk/sender/chat/deactivate" \ -H "Authorization: {ApiKey}" \ -H "Content-Type: application/json" \ -d '{ "cstalk": { "senderKey":"{senderKey}" }}'응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success" }}상담시간 조회
상담 운영 시간을 조회합니다.
Query Parameters
QUERYsenderKey
필수String카카오 비즈메시지 발신프로필 키입니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/cstalk/consult/time?senderKey={senderKey}" \ -H "Authorization: {ApiKey}"응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"header-value-X-Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success", "data": { "cstalk": { "weekTimeTable": [{ "day":"mon", "startAt":"0900", "endAt":"1800" }] } } }}상담시간 저장
카카오톡 채널의 상담시간을 저장합니다. 한 번 시간이 등록되면 수정만 가능하며, 상담톡 이용 여부를 해지하면 상담 시간은 삭제됩니다. 카카오톡 채널 홈에 상담시간이 노출되며, 설정된 상담 시간을 확인하려면 채팅 기능이 활성화된 상태여야 합니다.
Body Parameters
{}JSONcstalk
필수Object상담톡 요청 객체입니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/cstalk/consult/time" \ -H "Authorization: {ApiKey}" \ -H "Content-Type: application/json" \ -d '{ "cstalk": { "senderKey":"{senderKey}", "weekTimeTable": [{ "day":"mon", "startAt":"0900", "endAt":"1800" }] }}'응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success" }}시스템 메시지 조회
시스템 메시지 목록을 조회합니다.
Query Parameters
QUERYsenderKey
필수String카카오 비즈메시지 발신프로필 키입니다.
id
String시스템 메시지 ID입니다. 특정 메시지만 조회할 때 입력합니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/cstalk/system/message?senderKey={senderKey}" \ -H "Authorization: {ApiKey}"응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"header-value-X-Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success", "data": { "systemMessages": [{ "id":"7678", "name":"상담 시작 안내", "status":"A", "createdAt":"2025-08-18 16:40:00", "modifiedAt":"2025-08-18 16:40:00", "inspectStatus":"REG", "inspectRequestAt":"2025-08-27 13:16:59", "inspectedAt":"", "messages": [{ "messageType":"ST", "content":"상담을 시작합니다.", "buttons": [{ "ordering": 1, "type":"WL", "name":"바로가기", "urlMobile":"https://m.example.com", "urlPc":"https://www.example.com" }] }], "comments": [{ "id":"101", "content":"검수 요청이 등록되었습니다.", "userName":"비즈고", "createdAt":"2025-08-27 13:17:02", "status":"INQ" }] }] } }}시스템 메시지 등록
시스템 메시지를 등록합니다.
Body Parameters
{}JSONcstalk
필수Object상담톡 요청 객체입니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/cstalk/system/message" \ -H "Authorization: {ApiKey}" \ -H "Content-Type: application/json" \ -d '{ "cstalk": { "senderKey":"{senderKey}", "name":"상담 시작 안내", "messages": [{ "messageType":"ST", "content":"상담을 시작합니다.", "buttons": [{ "ordering": 1, "type":"WL", "name":"바로가기", "urlMobile":"https://m.example.com", "urlPc":"https://www.example.com" }] }] }}'응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"header-value-X-Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success", "data": { "systemMessage": { "id":"7678" } } }}시스템 메시지 삭제
시스템 메시지를 삭제합니다.
Path Parameters
PATHsenderKey
필수String발신프로필 키입니다.
id
필수String삭제할 시스템 메시지 ID입니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X DELETE "https://mars.ibapi.kr/api/comm/v1/center/cstalk/system/message/senderKey/%40bizgo/id/sysMsgId" \ -H "Authorization: {ApiKey}"응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success" }}시스템 메시지 검수 요청
시스템 메시지 검수를 요청합니다.
Body Parameters
{}JSONcstalk
필수Object상담톡 요청 객체입니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/cstalk/system/message/approval/request" \ -H "Authorization: {ApiKey}" \ -H "Content-Type: application/json" \ -d '{ "cstalk": { "senderKey":"{senderKey}" }}'응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success" }}시스템 메시지 검수 취소
시스템 메시지 검수 요청을 취소합니다.
Body Parameters
{}JSONcstalk
필수Object상담톡 요청 객체입니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/cstalk/system/message/approval/cancel" \ -H "Authorization: {ApiKey}" \ -H "Content-Type: application/json" \ -d '{ "cstalk": { "senderKey":"{senderKey}" }}'응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success" }}상담 메시지 삭제
이미 발송된 상담톡 메시지를 삭제합니다. 삭제한 메시지는 복구할 수 없습니다.
이미 발송된 상담톡 메시지를 삭제합니다. 삭제한 메시지는 복구할 수 없습니다.
Body Parameters
{}JSONcstalk
필수Object상담톡 요청 객체입니다.
Returns
common
Object공통 응답 영역입니다.
data
Object상품 응답 영역입니다.
요청 예시
curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/cstalk/chat/delete" \ -H "Authorization: {ApiKey}" \ -H "Content-Type: application/json" \ -d '{ "cstalk": { "senderKey":"{senderKey}", "userKey":"{userKey}", "msgKey":"{msgKey}" }}'응답 예시
{ "common": { "authCode":"A000", "authResult":"Success", "infobankTrId":"Infobank-Tracking-Id" }, "data": { "code":"A000", "result":"Success" }}상담 연결하기
PC/Mobile 페이지에서 상담 연결 버튼을 통해 상담을 요청할 수 있습니다.
PC에서 상담 연결 버튼을 통해 메타 정보를 전달하는 경우 요청 페이지는 새창 또는 팝업 형태로 호출해야 하며, 팝업의 최소 권장 사이즈는 1024 x 800입니다.
상담 연결 버튼 클릭 시 파트너사 페이지를 거쳐 카카오 로그인 페이지로 이동하는 경우, 파트너사 페이지 내에 아래 스크립트를 포함하면 권장 사이즈로 팝업창이 노출됩니다.
<script src="https://bizmessage.kakao.com/chat/includeScript"></script>
봇과 상담톡을 동시에 이용하는 프로필은 bot 파라미터를 이용해 봇 또는 상담톡으로 연결 방식을 제어할 수 있습니다.
버튼 연결 (POST)
카카오 상담 연결 URL을 POST 방식으로 직접 호출합니다. Content-Type은 application/x-www-form-urlencoded를 사용합니다.
Body Parameters
FORM-URLENCODEDuuid
필수String(40)발신프로필키입니다. 카카오톡 채널 @아이디가 아니므로 주의해 주세요.
extra
String(1000)상담톡 또는 봇 전환 시 사용자에게 전달할 메타 데이터입니다.
bot
String(5)봇 연결은 true, 상담원 연결은 false(기본값), 유지 중인 세션 연결은 auto를 입력합니다.
event
String(100)사용자가 봇으로 전환될 때 발생할 이벤트명입니다.
app_open_type
String앱 실행 방식입니다. direct 또는 modal을 입력합니다.
Returns
redirect
Redirect카카오톡 상담 연결 화면으로 이동합니다. 별도의 비즈고 API JSON 응답이 아닙니다.
요청 예시
curl -X POST "https://bizmessage.kakao.com/chat/open" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "uuid={uuid}&extra={extra}&bot=false&event={event}&app_open_type=direct"응답 예시
카카오 상담 연결 URL 호출 후 카카오톡 상담 화면으로 이동합니다.비즈고 API JSON 응답이 아니라 카카오 URL 이동/응답으로 처리됩니다.버튼 연결 (GET)
카카오 상담 연결 URL을 GET 방식으로 직접 호출합니다. uuid는 경로에 포함하고 나머지 값은 Query Parameter로 전달합니다.
Query Parameters
QUERYuuid
필수String(40)발신프로필키입니다. Path Parameter로 전달하며, 카카오톡 채널 @아이디가 아니므로 주의해 주세요.
extra
String(50)상담톡 또는 봇 전환 시 사용자에게 전달할 메타 데이터입니다.
bot
String(5)봇 연결은 true, 상담원 연결은 false(기본값), 유지 중인 세션 연결은 auto를 입력합니다.
event
String(100)사용자가 봇으로 전환될 때 발생할 이벤트명입니다.
app_open_type
String앱 실행 방식입니다. direct 또는 modal을 입력합니다.
Returns
redirect
Redirect카카오톡 상담 연결 화면으로 이동합니다. 별도의 비즈고 API JSON 응답이 아닙니다.
요청 예시
curl -X GET "https://bizmessage.kakao.com/chat/open/{uuid}?extra={extra}&bot=false&event={event}&app_open_type=direct"응답 예시
카카오 상담 연결 URL 호출 후 카카오톡 상담 화면으로 이동합니다.비즈고 API JSON 응답이 아니라 카카오 URL 이동/응답으로 처리됩니다.