POST 방식 상담 연결

Endpoint

[POST] API URL 정보

개발 및 테스트용 API운영 API

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

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

Introduce

Introduce

POST 방식으로 상담 연결 방법을 안내하는 문서입니다.

Request (Form-data)

Header

Field Name	Type	Required	Description
Content-type	Text	Y	application/x-www-form-urlencoded

Body (Form-urlencoded)

Field Name	Type	Required	Description
uuid	Text	Y	카카오톡 채널 (@로 연결되는 아이디)
extra	Text(50)	N	상담시 전달하고 싶은 메타 정보
bot	Text	N	봇 연결 여부 (false: 상담톡 연결, true: 봇 연결, auto: 세션 유지)
event	Text(100)	N	봇으로 상담 연결 시 실행될 봇 말블럭 이벤트명
app_open_type	Text	N	모바일 앱스킴 실행 방식 (direct, modal)

Description

Parameter 주의사항

- extra는 최대 글자수를 준수해야 하며, 개인정보를 포함하지 않아야 합니다.
    - extra의 최대 글자수를 초과하는 경우 허용 길이까지만 사용해서 호출됩니다.
    - extra에는 개인정보를 포함하지 않아야 합니다. 불가피하게 개인정보가 포함되어야 할 경우, 암호화를 적용해야 합니다.
- app_open_type은 모바일 브라우저에서 커스텀 앱 스킴 실행 방식을 제어하기 위해 사용되는 값입니다.
    - direct: 클라이언트 상관 없이 카카오톡 실행 시도
    - modal: 클라이언트 상관 없이 모달 팝업을 띄워 유저 제스처 유도

Example

REST API Sample

개발 및 테스트용 API운영 API

curl -L -X POST 'https://bizmessage.kakao.com/chat/open/@example-uuid' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'extra=Hello%20World'

curl -L -X POST 'https://bizmessage.kakao.com/chat/open/@example-uuid' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'extra=Hello%20World'

Response

Parameter

None

Example

Success

None

Failure

None

Data Dictionary

Data Dictionary

Request DictionaryResponse Dictionary

None

None

Reference

코드 정의