본문 바로가기메인 메뉴 바로가기사이드 메뉴 바로가기

kakao developers

Related sites
  • Docs
  • Kakao Moment
  • Business Form linkage management

사이드 메뉴

Docs Home

Getting started

Kakao Developers

Login

Communication

Map

Navigation

Advertisement

Search

More

Kakao Moment

Business Form linkage management

This document describes how to use the Business Form linkage management APIs.

View list of linked Business Forms

Basic information
MethodURLAuthorization
GEThttps://apis.moment.kakao.com/openapi/v4/talkBizForms/linkages
RequirementsSee also

Returns the list of Business Forms linked to the ad account.

You can check the detailed information of the Business Form created with your Kakao Account in the Kakao Talk Business Form settings in Kakao Moment.

Request

Header
NameDescriptionRequired
AuthorizationAuthorization: Bearer ${BUSINESS_ACCESS_TOKEN}
Business token as a type of user authentication.		O
adAccountIdadAccountId: ${AD_ACCOUNT_ID}
Ad account's ID.		O

Response

Body
NameTypeDescription
-BusinessForm[]List of Business Forms.

Sample

Request
curl -X GET "https://apis.moment.kakao.com/openapi/v4/talkBizForms/linkages" \

  -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \

  -H "adAccountId: ${AD_ACCOUNT_ID}"
Response
// HTTP/1.1 200 OK

// Content-Type: application/json;charset=UTF-8

[

  {

    "id": 1,

    "adAccountId": 1234,

    "bizFormId": 1111,

    "title": "first_talk_business_form",

    "flowType": "SURVEY",

    "linkedDate": "2020-01-01 00:00:00",

    "beginDate": "2020-02-01 00:00",

    "endDate": "2020-03-01 00:00"

  }

]

View list of linkable Business Forms

Basic information
MethodURLAuthorization
GEThttps://apis.moment.kakao.com/openapi/v4/talkBizForms/linkables
RequirementsSee also

Returns the list of Business Forms that can be linked.

Request

Header
NameDescriptionRequired
AuthorizationAuthorization: Bearer ${BUSINESS_ACCESS_TOKEN}
Business token as a type of user authentication.		O
adAccountIdadAccountId: ${AD_ACCOUNT_ID}
Ad account's ID.		O

Response

Body
NameTypeDescription
-LinkablesBusinessForm[]List of Business Forms.
LinkablesBusinessForm
NameTypeDescription
bizFormIdLongBusiness Form's ID.
Pass bizFormId when requesting the Link Business Form API.
titleStringBusiness Form's name.
flowTypeEnumBusiness Form type.
  • APPLY: Instant apply form
  • SURVEY: Survey form
  • RESERV: Reservation form
beginDateStringStart time of delivery period in yyyy-MM-dd'T'HH:mm:ss format.
endDateStringEnd time of delivery period in yyyy-MM-dd'T'HH:mm:ss format.

Sample

Request
curl -X GET "https://apis.moment.kakao.com/openapi/v4/talkBizForms/linkables" \

  -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \

  -H "adAccountId: ${AD_ACCOUNT_ID}"
Response
// HTTP/1.1 200 OK

// Content-Type: application/json;charset=UTF-8

[

  {

    "bizFormId": 5678,

    "adAccountId": 1234,

    "title": "first_talk_business_form",

    "flowType": "APPLY",

    "beginDate": "2020-02-01 00:00",

    "endDate": "2020-03-01 00:00"

  }

]

Link business form

Basic information
MethodURLAuthorization
POSThttps://apis.moment.kakao.com/openapi/v4/talkBizForms
RequirementsSee also

Enables you to link a specific Business Form to an ad account.

Request

Header
NameDescriptionRequired
AuthorizationAuthorization: Bearer ${BUSINESS_ACCESS_TOKEN}
Business token as a type of user authentication.		O
adAccountIdadAccountId: ${AD_ACCOUNT_ID}
Ad account's ID.		O
Body
NameTypeDescriptionRequired
bizFormIdLongBusiness Form's ID.O

Response

Body
NameTypeDescription
idLongBusiness Form's linkage ID.
adAccountLongAd account's ID.
bizFormIdLongBusiness Form's ID.
titleStringBusiness Form's title.
flowTypeEnumBusiness Form type.
  • APPLY: Instant apply form
  • SURVEY: Survey form
  • RESERV: Reservation form
beginDateStringStart time of delivery period in yyyy-MM-dd'T'HH:mm:ss format.
endDateStringEnd time of delivery period in yyyy-MM-dd'T'HH:mm:ss format.
linkedDateStringLinkage time in yyyy-MM-dd'T'HH:mm:ss format.

Sample

Request
curl -X POST "https://apis.moment.kakao.com/openapi/v4/talkBizForms" \

  -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}"

-H "adAccountId: ${AD_ACCOUNT_ID}"

-d '{

            "bizFormId": ${BIZ_FORM_ID}

        }'
Response
// HTTP/1.1 200 OK

// Content-Type: application/json;charset=UTF-8

{

  "id": 1,

  "adAccountId": 1234,

  "bizFormId": 1,

  "title": "first_talk_business_form",

  "flowType": "APPLY",

  "linkedDate": "2020-01-01 15:00:00",

  "beginDate": "2020-02-01 00:00",

  "endDate": "2020-03-01 00:00"

}

See more

Was this helpful?

    Kakao Moment > Business Form linkage management - Kakao Developers | Docs