비즈니스폼 업로드

Endpoint

[POST] API URL 정보

개발 및 테스트용 API운영 API

https://patch-kakao-api.happytalk.io/kakaoWebhook/v1/bzmc/bizform/upload

https://kakao-api.happytalk.io/kakaoWebhook/v1/bzmc/bizform/upload

Introduce

Introduce

사전 구성한 비즈니스폼을 상담톡 메시지에서 사용하기 위해 키를 발급받는 API입니다.

Request (Json)

Header

Field Name	Type	Required	Description
Content-type	Text	Y	application/json
HT-Client-Id	Text	Y	고객센터에서 발급 받은 key
HT-Client-Secret	Text	Y	고객센터에서 발급 받은 token

Body

Field Name	Type (Length)	Required	Description
bizFormId	Number	Y	업로드할 비즈니스폼 ID
senderKey	Text(40)	Y	발신프로필 키

Example

REST API Sample

개발 및 테스트용 API운영 API

curl -L -X POST 'https://patch-kakao-api.happytalk.io/kakaoWebhook/v1/bzmc/bizform/upload' \
-H 'Content-Type: application/json' \
-H 'HT-Client-Id: example-id' \
-H 'HT-Client-Secret: example-secret' \
-d '{"bizFormId":bizFormId,"senderKey":"example-senderKey"}'

curl -L -X POST 'https://kakao-api.happytalk.io/kakaoWebhook/v1/bzmc/bizform/upload' \
-H 'Content-Type: application/json' \
-H 'HT-Client-Id: example-id' \
-H 'HT-Client-Secret: example-secret' \
-d '{"bizFormId":bizFormId,"senderKey":"example-senderKey"}'

Response (Json)

Parameter

Field Name	Type	Description
code	Text	응답 코드
bizFormKey	Text	업로드된 비즈니스폼 키
message	Text	오류 메시지 (오류시 존재하는 값)

Example

Success

{
    "code": "200",
    "bizFormKey": "HqJeauP...ugR2h+8ug=="
}

Failure

{
    "code": "509",
    "message": "비즈니스폼 상태 정보가 유효하지 않습니다."
}

Data Dictionary

Data Dictionary

Request DictionaryResponse Dictionary

None

None

Reference

코드 정의