상담톡

상담톡은 카카오톡 채널을 통해 고객과 1:1 상담 메시지를 송수신하고, 상담 세션과 운영 설정을 함께 관리할 수 있는 카카오 비즈메시지 채널입니다.

파일 업로드

이미지 업로드

POST/api/comm/v1/file/cstalk/image

샌드박스로 테스트하기

상담톡 이미지 파일을 업로드합니다. jpg, png, gif 지원, 최대 5MB, 최소 너비 500px, 비율 2:1~3:4입니다.

Body Parameters

FORM-DATA

file

필수Binary

업로드할 이미지 파일입니다.

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}" \
  -F "sample=value"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

파일 업로드

POST/api/comm/v1/file/cstalk/file

샌드박스로 테스트하기

상담톡 FILE·AUDIO·VIDEO 타입 첨부 파일을 업로드합니다.

Body Parameters

FORM-DATA

file

필수Binary

업로드할 파일입니다.

senderKey

필수String

카카오 비즈메시지 발신프로필 키입니다.

fileType

String

파일 타입입니다. 일반 파일은 'file', 오디오는 'audio', 동영상은 'video'를 입력합니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/file/cstalk/file" \
  -H "Authorization: {ApiKey}" \
  -F "sample=value"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

채널 관리하기

상담톡 이용 활성화

POST/api/comm/v1/center/cstalk/sender/activate

샌드박스로 테스트하기

상담톡 이용을 활성화합니다.

Body Parameters

{}JSON

cstalk

필수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 '{
  "sample": "value"
}'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

상담톡 이용 비활성화

POST/api/comm/v1/center/cstalk/sender/deactivate

샌드박스로 테스트하기

상담톡 이용을 비활성화합니다.

Body Parameters

{}JSON

cstalk

필수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 '{
  "sample": "value"
}'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

채팅 기능 활성화

POST/api/comm/v1/center/cstalk/sender/chat/activate

샌드박스로 테스트하기

채팅 기능을 활성화합니다.

Body Parameters

{}JSON

cstalk

필수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 '{
  "sample": "value"
}'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

채팅 기능 비활성화

POST/api/comm/v1/center/cstalk/sender/chat/deactivate

샌드박스로 테스트하기

채팅 기능을 비활성화합니다.

Body Parameters

{}JSON

cstalk

필수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 '{
  "sample": "value"
}'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

상담시간 조회

GET/api/comm/v1/center/cstalk/consult/time

샌드박스로 테스트하기

상담 운영 시간을 조회합니다.

Query Parameters

QUERY

senderKey

필수String

발신프로필 키입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

cstalk

Object

상담톡 데이터 영역입니다.

weekTimeTable

Object Array

요일별 상담시간 목록입니다.

요청 예시

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/cstalk/consult/time?senderKey=%40bizgo" \
  -H "Authorization: {ApiKey}"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

상담시간 저장

POST/api/comm/v1/center/cstalk/consult/time

샌드박스로 테스트하기

상담 운영 시간을 저장합니다.

Body Parameters

{}JSON

cstalk

필수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 '{
  "sample": "value"
}'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

시스템 메시지 조회

GET/api/comm/v1/center/cstalk/system/message

샌드박스로 테스트하기

시스템 메시지 목록을 조회합니다.

Query Parameters

QUERY

senderKey

필수String

발신프로필 키입니다.

String

시스템 메시지 ID입니다. 특정 메시지만 조회할 때 입력합니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

systemMessages

Object Array

시스템 메시지 목록입니다.

요청 예시

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/cstalk/system/message?senderKey=%40bizgo&page=1&size=20" \
  -H "Authorization: {ApiKey}"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

시스템 메시지 등록

POST/api/comm/v1/center/cstalk/system/message

샌드박스로 테스트하기

시스템 메시지를 등록합니다.

Body Parameters

{}JSON

cstalk

필수Object

상담톡 요청 객체입니다.

systemMessages

필수Object Array

시스템 메시지 배열입니다.

buttons

필수Object Array

버튼 배열입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

systemMessage

Object

생성된 시스템 메시지 정보입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/cstalk/system/message" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
  "sample": "value"
}'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

시스템 메시지 삭제

DELETE/api/comm/v1/center/cstalk/system/message/senderKey/{senderKey}/id/{id}

샌드박스로 테스트하기

시스템 메시지를 삭제합니다.

Path Parameters

PATH

senderKey

필수String

발신프로필 키입니다.

필수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"
  }
}

시스템 메시지 검수 요청

POST/api/comm/v1/center/cstalk/system/message/approval/request

샌드박스로 테스트하기

시스템 메시지 검수를 요청합니다.

Body Parameters

{}JSON

cstalk

필수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 '{
  "sample": "value"
}'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

시스템 메시지 검수 취소

POST/api/comm/v1/center/cstalk/system/message/approval/cancel

샌드박스로 테스트하기

시스템 메시지 검수 요청을 취소합니다.

Body Parameters

{}JSON

cstalk

필수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 '{
  "sample": "value"
}'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

상담 연결하기

버튼 연결 (POST)

POSThttps://bizmessage.kakao.com/chat/open

샌드박스로 테스트하기

POST 방식 상담 연결 버튼 규격입니다. Content-Type은 application/x-www-form-urlencoded를 사용합니다.

Body Parameters

FORM-DATA

uuid

필수String

카카오톡 채널 ID(@아이디)입니다.

extra

String(1000)

상담 연결 시 전달할 메타 데이터입니다.

bot

String

연결 모드입니다. 봇 연결 시 'true', 상담톡 연결 시 'false'(기본값), 세션 유지 시 'auto'를 입력합니다.

event

String(100)

봇 이벤트명입니다.

app_open_type

String

앱 실행 방식입니다. 'direct' 또는 'modal'을 입력합니다.

Returns

code

String

Webhook 처리 결과 코드입니다.

result

String

Webhook 처리 결과 메시지입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/chat/open" \
  -H "Authorization: {ApiKey}" \
  -F "sample=value"

응답 예시

{
  "code": "A000",
  "result": "Success"
}

버튼 연결 (GET)

GEThttps://bizmessage.kakao.com/chat/open/{uuid}

샌드박스로 테스트하기

GET 방식 상담 연결 버튼 규격입니다. uuid는 Path Parameter로 전달합니다.

Query Parameters

QUERY

uuid

필수String

카카오톡 채널 ID(@아이디)입니다. Path Parameter로 전달합니다.

extra

String(50)

상담 연결 시 전달할 메타 데이터입니다.

bot

String

연결 모드입니다. 봇 연결 시 'true', 상담톡 연결 시 'false'(기본값), 세션 유지 시 'auto'를 입력합니다.

event

String(100)

봇 이벤트명입니다.

app_open_type

String

앱 실행 방식입니다. 'direct' 또는 'modal'을 입력합니다.

Returns

code

String

Webhook 처리 결과 코드입니다.

result

String

Webhook 처리 결과 메시지입니다.

요청 예시

curl -X GET "https://mars.ibapi.kr/chat/open/%40bizgo?extra=orderNo%3D1234&bot=false" \
  -H "Authorization: {ApiKey}"

응답 예시

{
  "code": "A000",
  "result": "Success"
}

상담메시지 수신하기 (Webhook)

사용자 메시지 수신

POST{고객 Webhook URL}/cstalk/message

사용자 메시지 수신 Webhook입니다. 사용자가 전송한 메시지 내용이 등록된 Webhook URL로 전달됩니다.

Body Parameters

{}JSON

msgKey

필수String

메시지 키입니다.

userKey

필수String

사용자 키입니다.

senderKey

필수String

메시지를 수신한 발신프로필 키입니다.

serviceType

필수String

서비스 타입입니다.

msgType

필수String

메시지 타입입니다.

requestType

String

요청 타입입니다.

sendTime

필수String

전송 일시입니다. (ISO 8601, yyyy-MM-dd'T'HH:mm:ss.SS).

reportTime

필수String

리포트 일시입니다. (ISO 8601, yyyy-MM-dd'T'HH:mm:ss.SSS).

kakaoTime

String

카카오 서버 수신 일시입니다. (ISO 8601).

contents

Object Array

사용자가 전송한 메시지 데이터입니다.

attachment

Object

메시지가 4,000자를 초과하는 경우 추가 데이터입니다.

Returns

code

String

Webhook 처리 결과 코드입니다.

result

String

Webhook 처리 결과 메시지입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/cstalk/message" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
  "sample": "value"
}'

응답 예시

{
  "code": "A000",
  "result": "Success"
}

사용자 메타정보 수신

POST{고객 Webhook URL}/cstalk/reference

사용자 메타정보 수신 Webhook입니다. 상담 연결 시 전달된 extra 등 참조 데이터가 수신됩니다.

Body Parameters

{}JSON

msgKey

필수String

메시지 키입니다.

userKey

필수String

사용자 키입니다.

senderKey

필수String

메시지를 수신한 발신프로필 키입니다.

serviceType

필수String

서비스 타입입니다.

msgType

필수String

메시지 타입입니다.

requestType

필수String

요청 타입입니다.

sendTime

필수String

전송 일시입니다. (ISO 8601).

reportTime

필수String

리포트 일시입니다. (ISO 8601).

kakaoTime

String

카카오 서버 수신 일시입니다.

sessionId

String

상담 세션 ID입니다.

reference

Object

상담 연결 시 전달된 메타 데이터입니다.

extra

String

버튼 클릭 시 전달된 메타 데이터입니다.

lastReference

Object

현재 참조 데이터가 없을 때의 직전 메타 데이터입니다.

extra

String

이전 버튼 전달 메타 데이터입니다.

bot

String

상담 시작 방식입니다.

bot_event

String

봇 블록 이벤트 값입니다.

created_at

String

마지막 메타 데이터 생성 일시입니다.

Returns

code

String

Webhook 처리 결과 코드입니다.

result

String

Webhook 처리 결과 메시지입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/cstalk/reference" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
  "sample": "value"
}'

응답 예시

{
  "code": "A000",
  "result": "Success"
}

세션 종료 수신

POST{고객 Webhook URL}/cstalk/expired_session

세션 종료 수신 Webhook입니다. 상담 세션이 만료되면 등록된 Webhook URL로 알림이 전달됩니다.

Body Parameters

{}JSON

userKey

필수String

사용자 키입니다.

senderKey

필수String

메시지를 수신한 발신프로필 키입니다.

serviceType

필수String

서비스 타입입니다.

msgType

필수String

메시지 타입입니다.

requestType

필수String

요청 타입입니다.

sendTime

필수String

전송 일시입니다. (ISO 8601, yyyy-MM-dd'T'HH:mm:ss.SS).

reportTime

필수String

리포트 일시입니다. (ISO 8601, yyyy-MM-dd'T'HH:mm:ss.SSS).

kakaoTime

String

카카오 서버 수신 일시입니다.

sessionId

String

상담 세션 ID입니다.

Returns

code

String

Webhook 처리 결과 코드입니다.

result

String

Webhook 처리 결과 메시지입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/cstalk/expired_session" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
  "sample": "value"
}'

응답 예시

{
  "code": "A000",
  "result": "Success"
}

읽음 정보 수신

POST{고객 Webhook URL}/cstalk/seen_info

읽음 정보 수신 Webhook입니다. 사용자가 메시지를 읽으면 등록된 Webhook URL로 알림이 전달됩니다.

Body Parameters

{}JSON

userKey

필수String

사용자 키입니다.

senderKey

필수String

메시지를 수신한 발신프로필 키입니다.

serviceType

필수String

서비스 타입입니다.

msgType

필수String

메시지 타입입니다.

requestType

필수String

요청 타입입니다.

sendTime

필수String

전송 일시입니다. (ISO 8601, yyyy-MM-dd'T'HH:mm:ss.SS).

reportTime

필수String

리포트 일시입니다. (ISO 8601, yyyy-MM-dd'T'HH:mm:ss.SSS).

kakaoTime

String

카카오 서버 수신 일시입니다.

sessionId

String

상담 세션 ID입니다.

Returns

code

String

Webhook 처리 결과 코드입니다.

result

String

Webhook 처리 결과 메시지입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/cstalk/seen_info" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
  "sample": "value"
}'

응답 예시

{
  "code": "A000",
  "result": "Success"
}

개인정보 수신

POST{고객 Webhook URL}/cstalk/personal_info

사용자 개인정보 수신 Webhook입니다. 사용자가 개인정보 수집에 동의하면 등록된 Webhook URL로 개인정보가 전달됩니다.

Body Parameters

{}JSON

userKey

필수String

사용자 키입니다.

senderKey

필수String

메시지를 수신한 발신프로필 키입니다.

serviceType

필수String

서비스 타입입니다.

msgType

필수String

메시지 타입입니다.

requestType

필수String

요청 타입입니다.

sendTime

필수String

전송 일시입니다. (ISO 8601, yyyy-MM-dd'T'HH:mm:ss.SS).

reportTime

필수String

리포트 일시입니다. (ISO 8601, yyyy-MM-dd'T'HH:mm:ss.SSS).

kakaoTime

String

카카오 서버 수신 일시입니다.

sessionId

String

상담 세션 ID입니다.

personalInfo

Object

사용자 개인정보입니다.

phone_number

String

카카오 계정 전화번호입니다.

nickname

String

카카오 프로필 닉네임입니다.

Returns

code

String

Webhook 처리 결과 코드입니다.

result

String

Webhook 처리 결과 메시지입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/cstalk/personal_info" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
  "sample": "value"
}'

응답 예시

{
  "code": "A000",
  "result": "Success"
}

발송 결과 수신

POST{고객 Webhook URL}/cstalk/result

발송 결과 수신 Webhook입니다. 상담톡 메시지 발송 결과가 등록된 Webhook URL로 전달됩니다.

Body Parameters

{}JSON

msgKey

필수String

메시지 키입니다.

userKey

필수String

사용자 키입니다.

senderKey

필수String

메시지를 수신한 발신프로필 키입니다.

serviceType

필수String

서비스 타입입니다.

msgType

String

메시지 타입입니다.

requestType

필수String

요청 타입입니다. write, end, endwithbot 중 하나입니다.

sendTime

필수String

전송 일시입니다. (ISO 8601, yyyy-MM-dd'T'HH:mm:ss.SS).

reportTime

필수String

리포트 일시입니다. (ISO 8601, yyyy-MM-dd'T'HH:mm:ss.SSS).

reportCode

String

발송 결과 코드입니다.

reportText

String

발송 결과 메시지입니다.

ref

String

요청 참조 필드입니다.

Returns

code

String

Webhook 처리 결과 코드입니다.

result

String

Webhook 처리 결과 메시지입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/cstalk/result" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
  "sample": "value"
}'

응답 예시

{
  "code": "A000",
  "result": "Success"
}

상담하기

Plain 메시지 발송

POST/api/comm/v1/cstalk/plain

샌드박스로 테스트하기

상담톡 Plain 메시지를 발송합니다. msgType에 따라 TEXT·IMAGE·VIDEO·AUDIO·FILE을 지원합니다.

Body Parameters

{}JSON

userKey

필수String

사용자 키입니다.

senderKey

필수String

발신프로필 키입니다.

msgType

필수String

메시지 타입입니다. TEXT, IMAGE, VIDEO, AUDIO, FILE 중 하나입니다.

message

필수String

메시지 본문입니다. 최대 1,000자입니다.

attachment

Object

첨부 객체입니다. IMAGE·VIDEO·AUDIO·FILE 타입에서 사용합니다.

image

Object

이미지 첨부 정보입니다. IMAGE 타입에서 사용합니다.

imgUrl

필수String

이미지 URL입니다. 이미지 업로드 API로 등록한 URL을 사용합니다.

imgLink

String

이미지 클릭 시 이동할 URL입니다.

file

Object

파일 첨부 정보입니다. FILE 타입에서 사용합니다.

fileUrl

필수String

파일 URL입니다. 파일 업로드 API로 등록한 URL을 사용합니다.

fileName

String

파일 이름입니다. FILE 타입 시 필수입니다.

fileSize

String(1000)

파일 크기입니다. FILE 타입 시 필수입니다.

ref

String(200)

요청 참조 필드입니다. 발송 결과 수신 시 함께 반환됩니다.

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 '{
  "sample": "value"
}'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

Rich 메시지 발송

POST/api/comm/v1/cstalk/rich

샌드박스로 테스트하기

카드·버튼·목록·캐러셀 기반 Rich 메시지를 발송합니다. msgType에 따라 TEXT·IMAGE·WIDE·ITEM_LIST·WIDE_ITEM_LIST·CAROUSEL_FEED·PERSONAL을 지원합니다.

Body Parameters

{}JSON

userKey

필수String

사용자 키입니다.

senderKey

필수String

발신프로필 키입니다.

msgType

필수String

메시지 풍선 타입입니다. TEXT, IMAGE, WIDE, ITEM_LIST, WIDE_ITEM_LIST, CAROUSEL_FEED, PERSONAL 중 하나입니다.

message

String

메시지 본문입니다. TEXT·IMAGE 최대 1,000자, WIDE 최대 76자, ITEM_LIST 최대 700자입니다.

description

String

보조 메시지입니다.

header

String

헤더 텍스트입니다.

attachment

Object

메시지 첨부 정보입니다.

image

Object

이미지 정보입니다. IMAGE·WIDE 타입에서 사용합니다.

imgUrl

필수String

이미지 URL입니다. 이미지 업로드 API로 등록한 URL을 사용합니다.

imgLink

String(1000)

이미지 클릭 시 이동할 URL입니다.

buttons

Object Array

버튼 배열입니다. TEXT·IMAGE·ITEM_LIST 최대 5개, WIDE·WIDE_ITEM_LIST·CAROUSEL_FEED 최대 2개입니다.

type

필수String

버튼 타입입니다. WL(웹링크), AL(앱링크), BK(봇키워드), MD(메시지전달), BT(봇전환), BF(비즈폼), AC(채널추가) 중 하나입니다.

name

필수String(28)

버튼명입니다.

urlPc

String

PC 환경 URL입니다. WL 타입에서 사용합니다.

urlMobile

String

모바일 환경 URL입니다. WL 타입에서 사용합니다.

schemeIos

String

iOS 커스텀 스킴입니다. AL 타입에서 사용합니다.

schemeAndroid

String

Android 커스텀 스킴입니다. AL 타입에서 사용합니다.

urlTarget

String

링크 타겟입니다. 외부 브라우저 열기 시 'out'을 입력합니다.

extra

String

봇·상담 메타 데이터입니다.

chatEvent

String

연결 봇 이벤트명입니다.

bizFormKey

String

비즈폼 키입니다. BF 타입에서 사용합니다.

quickReplies

Object Array

퀵리플라이 배열입니다. 최대 10개입니다.

type

필수String

퀵리플라이 타입입니다. WL, AL, BK, BT, BF 중 하나입니다.

name

필수String(14)

퀵리플라이명입니다.

urlPc

String

PC 환경 URL입니다.

urlMobile

String

모바일 환경 URL입니다.

schemeIos

String

iOS 커스텀 스킴입니다.

schemeAndroid

String

Android 커스텀 스킴입니다.

urlTarget

String

링크 타겟입니다.

extra

String

봇·상담 메타 데이터입니다.

chatEvent

String

연결 봇 이벤트명입니다.

coupon

Object

쿠폰 정보입니다.

title

필수String

쿠폰명입니다.

description

필수String

쿠폰 상세 설명입니다. WIDE 타입 최대 18자, 그 외 최대 12자입니다.

urlPc

String

PC 환경 URL입니다.

urlMobile

String

모바일 환경 URL입니다.

schemeIos

String

iOS 커스텀 스킴입니다.

schemeAndroid

String

Android 커스텀 스킴입니다.

itemList

Object

아이템 목록 정보입니다. ITEM_LIST 타입에서 사용합니다.

highlight

필수Object

하이라이트 영역 정보입니다.

title

필수String

하이라이트 타이틀입니다.

description

String

하이라이트 설명입니다.

imgUrl

String

하이라이트 이미지 URL입니다.

list

필수Object Array

아이템 목록입니다. 최소 2개, 최대 10개입니다.

title

필수String(6)

아이템 타이틀입니다.

description

필수String(23)

아이템 설명입니다.

summary

Object

요약 정보입니다.

title

String(6)

요약 타이틀입니다.

description

String(14)

요약 설명입니다.

wideItemList

Object Array

와이드 아이템 목록입니다. WIDE_ITEM_LIST 타입에서 사용합니다. 최소 3개, 최대 4개입니다.

title

필수String

아이템 타이틀입니다.

imgUrl

필수String

아이템 이미지 URL입니다.

urlMobile

String

모바일 환경 URL입니다.

urlPc

String

PC 환경 URL입니다.

schemeIos

String

iOS 커스텀 스킴입니다.

schemeAndroid

String

Android 커스텀 스킴입니다.

carousel

Object

캐러셀 정보입니다. CAROUSEL_FEED 타입에서 사용합니다.

list

필수Object Array

캐러셀 아이템 목록입니다. 최소 2개, 최대 6개입니다.

header

필수String(20)

캐러셀 아이템 헤더입니다.

message

필수String(180)

캐러셀 아이템 메시지입니다.

attachment

Object

캐러셀 아이템 첨부 정보입니다. (image, buttons 포함).

tail

Object

'더보기' 버튼 정보입니다.

urlMobile

필수String

모바일 환경 URL입니다.

urlPc

String

PC 환경 URL입니다.

schemeIos

String

iOS 커스텀 스킴입니다.

schemeAndroid

String

Android 커스텀 스킴입니다.

autoAnswer

String

시스템 자동 응답 코드입니다. S1~S5 중 하나입니다.

lock

Boolean

보안 메시지 여부입니다.

ref

String(200)

요청 참조 필드입니다. 발송 결과 수신 시 함께 반환됩니다.

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 '{
  "sample": "value"
}'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

상담 종료

POST/api/comm/v1/cstalk/end

샌드박스로 테스트하기

현재 사용자 상담 세션을 종료합니다.

Body Parameters

{}JSON

userKey

필수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 '{
  "sample": "value"
}'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

상담 종료 및 봇 전환

POST/api/comm/v1/cstalk/endWithBot

샌드박스로 테스트하기

상담 종료 후 챗봇 이벤트를 실행합니다.

Body Parameters

{}JSON

userKey

필수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 '{
  "sample": "value"
}'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

사용자 수신 차단

POST/api/comm/v1/center/cstalk/profile/user/block

샌드박스로 테스트하기

특정 사용자의 상담톡 수신을 차단합니다.

Body Parameters

{}JSON

cstalk

필수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 '{
  "sample": "value"
}'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

사용자 수신 차단 해제

POST/api/comm/v1/center/cstalk/profile/user/unblock

샌드박스로 테스트하기

차단된 사용자의 수신 차단을 해제합니다.

Body Parameters

{}JSON

cstalk

필수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 '{
  "sample": "value"
}'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

세션 조회

GET/api/comm/v1/center/cstalk/session

샌드박스로 테스트하기

사용자 키 기준으로 현재 상담 세션 정보를 조회합니다.

Query Parameters

QUERY

userKey

필수String

사용자 키입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

session

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": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}