사용자 메타 정보 수신

Endpoint

[POST] API URL 정보

개발 및 테스트용 API운영 API

{고객사 수신 도메인}/reference

{고객사 수신 도메인}/reference

Introduce

Introduce

수신 도메인에서 상담 연결 시 전달되는 사용자의 메타 정보와 관련 정보를 전달받는 API입니다.

Request

Header

None

Body

None

Example

REST API Sample

개발 및 테스트용 API운영 API

None

None

Response (Json)

Parameter

Field Name	Type	Description
user_key	Text	메시지를 발신한 사용자 키
sender_key	Text	메시지를 수신한 발신프로필 키
time	Number	메타 정보 전달 상담톡 서버 시각
app_user_id	Number	메시지를 발신한 사용자의 앱 유저 아이디
reference	Json	고객사에서 설정한 메타 정보
last_reference	Json	고객사 설정 메타 정보 없을 시 마지막 메타 정보
session_id	Text	세션 아이디

Example

Success

{
    "user_key": example-user_key,
    "session_id": "29153",
    "sender_key": example-sender_key,
    "app_user_id": null,
    "time": 1720082845460,
    "reference": {
        "extra": "page:goods-1-2",
        "text": "page:goods-1-2",
        "appUserId": null
    }
}

Failure

None

Data Dictionary

Data Dictionary

Request DictionaryResponse Dictionary

None

referencelast_reference

Field Name	Type	Description
extra	Text	버튼을 통해 전달된 메타 정보
text	Text	버튼을 통해 전달된 메타 정보 (삭제 예정)

Field Name	Type	Description
extra	Text	버튼을 통해 전달된 메타 정보
bot	Text	상담을 어떻게 시작했는지 값
bot_event	Text	봇으로 상담 시작 시, 봇 블럭 이벤트 값
created_at	Text	마지막 메타 정보 생성일

Reference

코드 정의