콘텐츠로 이동

고객 정보 수정

Endpoint

[POST] API URL 정보

https://patch-customer.happytalk.io/user/api/set_user_info/format/json

https://customer.happytalk.io/user/api/set_user_info/format/json

Auth Description

인증 방법 
Body에 해피톡 고객센터를 통하여 발급받은 고객사 토큰 값을 삽입하여 API 통신 시도
고객사 토큰은 설정 > 회사 정보 관리 > 상단 시스템 정보 > TOKEN 에서 확인하실 수 있습니다.

Request (Json)

None

Body

Field Name Type (Length) Required Description Default
token String Y 고객사 토큰
uuid String Y 고객 UUID
room_id String Y 상담방 번호
users_id String N 고객 ID (고객 ID 변경시 고객 UUID는 변경되지 않습니다.)
username String N 고객 이름
phone String N 전화번호 ex) 01012345678 ("-"을 붙이지 않은 전화번호 값)
email String N 이메일
sex String N 성별
birthday String N 생일 ex) 2022-11-08
birth_type String N 생일 타입
category_id String N 대분류 ID
division_id String N 중분류 ID
order_number String N 주문번호
product_number String N 상품번호
parcel_number String N 운송장 번호
parameter1 String N parameter1 (최대 20자)
parameter2 String N parameter2 (최대 20자)
parameter3 String N parameter3 (최대 20자)
parameter4 String N parameter4 (최대 20자)
parameter5 String N parameter5 (최대 20자)
parameter6 String N parameter6 (최대 20자)
parameter7 String N parameter7 (최대 20자)
parameter8 String N parameter8 (최대 20자)
parameter9 String N parameter9 (최대 20자)
parameter10 String N parameter10 (최대 20자)
user_parameter String N 사용자 변수 (최대 200자)

UUID 추가설명

  • 고객 ID(users_id)를 커스텀하여 사용하는 경우
    ● 고객 ID(users_id)가 아닌 고객식별번호(uuid)로 데이터를 받아야 함.

parameter1~10 사용시 유의사항

20자이상 입력시 20자 이후에는 값이 누락됩니다.

Example

REST API Sample 
curl --location --request POST 'https://patch-customer.happytalk.io/user/api/set_user_info/format/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token" : "고객사 토큰",
    "uuid" : "1000225100_sazob20220921062938",
    "room_id" : "상담방 번호",
    "users_id" : "test_account",
    "username" : "test",
    "phone" : "01011111111",
    "email" : "happytalk@happytalk.io",
    "sex" : "M",
    "birthday" : "2021-09-23",
    "birth_type" : "0",
    "category_id" : "75319",
    "division_id" : "75320",
    "order_number" : "12345678910",
    "product_number" : "13245678912",
    "parcel_number" : "12345678910111213",
    "parameter1" : "parameter1",
    "user_parameter" : "user_parameter"
}'

curl --location --request POST 'https://customer.happytalk.io/user/api/set_user_info/format/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token" : "고객사 토큰",
    "uuid" : "1000225100_sazob20220921062938",
    "room_id" : "상담방 번호",
    "users_id" : "test_account",
    "username" : "test",
    "phone" : "01011111111",
    "email" : "happytalk@happytalk.io",
    "sex" : "남",
    "birthday" : "2021-09-23",
    "birth_type" : "0",
    "category_id" : "75319",
    "division_id" : "75320",
    "order_number" : "12345678910",
    "product_number" : "13245678912",
    "parcel_number" : "12345678910111213",
    "parameter1" : "parameter1",
    "user_parameter" : "user_parameter"
}'

Response (Json)

Parameter

Field Name Type Description
result String success : 성공 , fail : 실패
code Int 결과 코드
message String 오류 사유

Example

Success 
{
    "result": "success"
}
Failure

Fail Code 정보

Data Dictionary

Data Dictionary
Type Description
M 남
F 여
Type Description
0 양력
1 음력

None