콘텐츠로 이동

비즈폼 업로드

Endpoint

[POST] API URL 정보

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

Description

Description
해당 API는 메시지 발신시에 비즈니스 폼을 전송하는 경우 비즈니스 폼을 key를 발급 받기위한 API 입니다.
아직 비즈니스 폼을 생성하지 않았다면 카카오 비즈니스에서 비즈니스 폼을 생성하여 사용해주세요.

Request (Json)

Field Name Type Required Description
Content-type String Y multipart/form-data
HT-Client-Id String Y 고객센터에서 발급 받은 key
HT-Client-Secret String Y 고객센터에서 발급 받은 token

Body

Field Name Type (Length) Required Description Default
senderKey String Y 발신프로필 키
bizFormId Int Y 업로드할 비즈니스폼 아이디

Example

REST API Sample
curl --location --request POST 'https://patch-kakao-api.happytalk.io/v1/bizform/upload' \
--header 'Content-Type: application/json' \
--header 'HT-Client-Id: 고객센터에서 발급받은 client-id' \
--header 'HT-Client-Secret: 고객센터에서 발급받은 client-secret' \
--data-raw '{
      "sender_key" : "발신프로필 키",
      "bizFormId" : 123456
}'
curl --location --request POST 'https://kakao-api.happytalk.io/v1/bizform/upload' \
--header 'Content-Type: application/json' \
--header 'HT-Client-Id: 고객센터에서 발급받은 client-id' \
--header 'HT-Client-Secret: 고객센터에서 발급받은 client-secret' \
--data-raw '{
      "sender_key" : "발신프로필 키",
      "bizFormId" : 123456
}'

Response (Json)

Parameter

Field Name Type Description
code String 결과 코드
bizFormKey String 업로드된 비즈폼 키

Example

Success
{
    "code": "200",
    "bizFormKey": "OY9E***********7aZxZJA=="
}
Failure

Fail Code 정보

Data Dictionary

Data Dictionary

None

None