콘텐츠로 이동

인증 결과 메시지

Endpoint

[POST] API URL 정보

https://patch.happytalk.io/api_v1/out_side_auth/sendMsg/format/json/

https://happytalk.io/api_v1/out_side_auth/sendMsg/format/json/

Auth Description

필수 참고 사항

해당 API는 SERVER TO SERVER로 통신하는 API 입니다.
인증 방법 
Header에 Authorization Field에 고유키를 담아서 통신 시도
고유키는 고급 설정 > 인증 관리 > 고객 정보 요청 연동 에서 발급 받을 수 있습니다.

Request (Json)

Field Name Type Required Description
Authorization String Y 발급 받은 JWT(토큰)

Body

Field Name Type Required Description
roomId String Y 인증 후 인증 관련 메세지를 전송하고자 하는 Room ID
userId String N 업체 고객의 고유 값 (미입력시 고객식별번호로 대체됩니다.)
username String N 고객 이름
phone String N 고객 휴대전화 번호 ex) 01012345678
telPhone String N 고객 전화번호 (휴대전화 X) ex) 021111111
email String N 고객 이메일
sex String N 고객 성별
birthType String N 고객 생일 타입
birthday String N 고객 생일 ex) 2022-11-08
contents String N 비고
msg String N 전송하고자 하는 메세지(Default : 아이디 인증이 완료 되었습니다.)
authNum String N 서비스설정 > 고객관리 > 인증관리 페이지의 고객 인증 탭 번호(Default : 1)

Example

REST API Sample 
curl --location --request POST 'https://patch-customer.happytalk.io/api_v1/out_side_auth/sendMsg/format/json/' \
--header 'Authorization: 발급된 JWT(토큰)'
--header 'Content-Type: application/json' \
--data-raw '{
    "roomId" : "상담방 번호",
    "userId" : "test_account",
    "username" : "test_name",
    "phone" : "01012345678",
    "telPhone" : "021111111",
    "email" : "test@email.com",
    "sex" : "M",
    "birthType" : "0",
    "birthday" : "2022-11-08",
    "contents" : "메모내용",
    "msg" : "this is test message",
    "authNum" : "1"
}'

curl --location --request POST 'https://customer.happytalk.io/api_v1/out_side_auth/sendMsg/format/json/' \
--header 'Authorization: 발급된 JWT(토큰)'
--header 'Content-Type: application/json' \
--data-raw '{
    "roomId" : "상담방 번호",
    "userId" : "test_account",
    "username" : "test_name",
    "phone" : "01012345678",
    "telPhone" : "021111111",
    "email" : "test@email.com",
    "sex" : "M",
    "birthType" : "0",
    "birthday" : "2022-11-08",
    "contents" : "메모내용",
    "msg" : "this is test message",
    "authNum" : "1"
}'

Response (Json)

Parameter

Field Name Type Description
code String 성공, 실패여부
resultCode Int 결과코드
results Boolean API 통신 결과
massage String API 통신 결과 message
sendMsg String 발송된 메시지

Example

Success 
{
  "resultCode": 0,
  "message": "success",
  "sendMsg": "아이디 인증이 완료 되었습니다."
}
Failure

Fail Code 정보

Data Dictionary

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

None