비즈니스폼 연동 관리

이 문서는 비즈니스폼 연동 관리 API 사용 방법을 안내합니다.

연동된 비즈니스폼 목록 조회

기본 정보

메서드	URL	인증 방식
GET	https://apis.moment.kakao.com/openapi/v4/talkBizForms/linkages	비즈니스 토큰

권한	사전 설정	비즈니스 인증	비즈니스 동의항목
필요: 사용 권한 신청	비즈 앱 전환 비즈니스 리다이렉트 URI 등록 비즈니스 동의항목	필요	필요

광고계정에 연동된 비즈니스폼 목록을 조회합니다. 내 카카오계정이 생성한 비즈니스폼의 상세 정보는 모먼트 내 카카오톡 비즈니스폼 설정에서 확인할 수 있습니다.

비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청합니다. 성공 시 사용자에게 사용 권한이 있는 비즈니스폼 목록을 받습니다. 실패 시 에러 코드에서 원인을 확인합니다.

요청

헤더

이름	설명	필수
Authorization	Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} 인증 방식, 비즈니스 토큰으로 인증 요청	O
adAccountId	adAccountId: ${AD_ACCOUNT_ID} 광고계정 ID	O

응답

본문

이름	타입	설명
-	BusinessForm[]	비즈니스폼 목록

예제

요청

curl -X GET "https://apis.moment.kakao.com/openapi/v4/talkBizForms/linkages" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}"

응답

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "id": 1,
        "adAccountId": 1234,
        "bizFormId": 1111,
        "title": "첫번째_비즈니스폼",
        "flowType": "SURVEY",
        "linkedDate": "2020-01-01 00:00:00",
        "beginDate": "2020-02-01 00:00",
        "endDate": "2020-03-01 00:00"
    }
]

연동 가능한 비즈니스폼 목록 조회

기본 정보

메서드	URL	인증 방식
GET	https://apis.moment.kakao.com/openapi/v4/talkBizForms/linkables	비즈니스 토큰

권한	사전 설정	비즈니스 인증	비즈니스 동의항목
필요: 사용 권한 신청	비즈 앱 전환 비즈니스 리다이렉트 URI 등록 비즈니스 동의항목	필요	필요

연동 가능한 비즈니스폼 목록을 조회할 수 있습니다.

비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청하며, 성공 시 비즈니스폼들의 목록을 받습니다. 실패 시 에러 코드에서 원인을 확인합니다.

요청

헤더

이름	설명	필수
Authorization	Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} 인증 방식, 비즈니스 토큰으로 인증 요청	O
adAccountId	adAccountId: ${AD_ACCOUNT_ID} 광고계정 ID	O

응답

본문

이름	타입	설명
-	LinkablesBusinessForm[]	연동 가능한 비즈니스폼 목록

LinkablesBusinessForm

이름	타입	설명
bizFormId	Long	비즈니스폼 번호 비즈니스폼 권한 추가시 해당 값을 bizFormId로 요청
title	String	비즈니스폼 이름
flowType	String	비즈니스폼 유형, 아래 중 하나 APPLY(바로응모형) SURVEY(설문조사형) RESERV(신청예약형)
beginDate	String	집행기간 시작시간 yyyy-MM-dd'T'HH:mm:ss 형식
endDate	String	집행기간 종료시간 yyyy-MM-dd'T'HH:mm:ss 형식

예제

요청

curl -X GET "https://apis.moment.kakao.com/openapi/v4/talkBizForms/linkables" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}"

응답

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "bizFormId": 5678,
        "adAccountId": 1234,
        "title": "첫번째_비즈니스폼",
        "flowType": "APPLY",
        "beginDate": "2020-02-01 00:00",
        "endDate": "2020-03-01 00:00"
    }
]

비즈니스폼 연동

기본 정보

메서드	URL	인증 방식
POST	https://apis.moment.kakao.com/openapi/v4/talkBizForms	비즈니스 토큰

권한	사전 설정	비즈니스 인증	비즈니스 동의항목
필요: 사용 권한 신청	비즈 앱 전환 비즈니스 리다이렉트 URI 등록 비즈니스 동의항목	필요	필요

광고계정에 비즈니스폼을 연동합니다.

비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 POST로 요청하며, 대상 비즈니스폼 번호를 필수 파라미터로 전달해야 합니다. 성공 시 광고 계정의 비즈니스폼 목록을 받습니다. 실패 시 에러 코드에서 원인을 확인합니다.

요청

헤더

이름	설명	필수
Authorization	Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} 인증 방식, 비즈니스 토큰으로 인증 요청	O
adAccountId	adAccountId: ${AD_ACCOUNT_ID} 광고계정 ID	O

본문

이름	타입	설명	필수
bizFormId	Long	비즈니스폼 번호	O

응답

본문

이름	타입	설명
id	Long	비즈니스폼 연동된 번호
adAccount	Long	광고계정 번호
bizFormId	Long	비즈니스폼 번호
title	String	비즈니스폼 이름
flowType	String	비즈니스폼 유형, 아래 중 하나 APPLY(바로응모형) SURVEY(설문조사형) RESERV(신청예약형)
beginDate	String	집행기간 시작시간 yyyy-MM-dd'T'HH:mm:ss 형식
endDate	String	집행기간 종료시간 yyyy-MM-dd'T'HH:mm:ss 형식
linkedDate	String	연동일시 yyyy-MM-dd'T'HH:mm:ss 형식

예제

요청

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}
        }'

응답

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
    "id": 1,
    "adAccountId": 1234,
    "bizFormId": 1,
    "title": "첫번째_비즈니스폼",
    "flowType": "APPLY",
    "linkedDate": "2020-01-01 15:00:00",
    "beginDate": "2020-02-01 00:00",
    "endDate": "2020-03-01 00:00"
}

더 보기

카카오모먼트 API 레퍼런스