페이지 이동경로
  • 문서>
  • 카카오모먼트>
  • 비즈니스폼 연동 관리

카카오모먼트

비즈니스폼 연동 관리

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

연동된 비즈니스폼 목록 보기

기본 정보

GET /openapi/v4/talkBizForms/linkages HTTP/1.1
Host: apis.moment.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}

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

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

Request

Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer ${ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O

Response

Name Type Description
- BusinessForm[] 비즈니스폼 목록

Sample

Request
curl -X GET "https://apis.moment.kakao.com/openapi/v4/talkBizForms/linkages" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: ${adAccountId}"
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "id": 1,
        "adAccountId": 1234,
        "bizFormId": 1111,
        "dspAccountEmail": "email@kakao.com",
        "title": "첫번째_비즈니스폼",
        "flowType": "SURVEY",
        "linkedDate": "2020-01-01 00:00:00",
        "beginDate": "2020-02-01 00:00",
        "endDate": "2020-03-01 00:00"
    }
]

연동 가능한 비즈니스폼 목록 보기

기본 정보

GET /openapi/v4/talkBizForms/linkables HTTP/1.1
Host: apis.moment.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}

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

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

Request

Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer ${ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O

Response

Name Type Description
- LinkablesBusinessForm[] 연동 가능한 비즈니스폼 목록
LinkablesBusinessForm
Name Type Description
bizFormId Long 비즈니스폼 번호
비즈니스폼 권한 추가시 해당 값을 bizFormId로 요청
title String 비즈니스폼 이름
flowType String 유형
SURVEY (설문형),
APPLY (바로응모형) 중 하나
beginDate String 집행기간 시작시간
yyyy-MM-dd'T'HH:mm:ss 형식
endDate String 집행기간 종료시간
yyyy-MM-dd'T'HH:mm:ss 형식

Sample

Request
curl -X GET "https://apis.moment.kakao.com/openapi/v4/talkBizForms/linkables" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: ${adAccountId}"
Response
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"
    }
]

비즈니스폼 연동하기

기본 정보

POST /openapi/v4/talkBizForms HTTP/1.1
Host: apis.moment.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}

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

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

Request

Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer ${ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
bizFormId Long 비즈니스폼 번호 O

Response

Name Type Description
id Long 비즈니스폼 연동된 번호
adAccount Long 광고계정 번호
bizFormId Long 비즈니스폼 번호
dspAccountEmail String 연동한 계정 이메일
title String 비즈니스폼 이름
flowType String 유형
SURVEY (설문형),
APPLY (바로응모형) 중 하나
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 형식

Sample

Request
curl -X POST "https://apis.moment.kakao.com/openapi/v4/talkBizForms" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}"
    -H "adAccountId: ${adAccountId}"
    -d '{
            "id": 1234
        }'
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
    "id": 1,
    "adAccountId": 1234,
    "bizFormId": 1,
    "dspAccountEmail": "email@kakao.com",
    "title": "첫번째_비즈니스폼",
    "flowType": "APPLY",
    "linkedDate": "2020-01-01 15:00:00",
    "beginDate": "2020-02-01 00:00",
    "endDate": "2020-03-01 00:00"
}

더보기