비즈메시지 테스트 선행조건 v1.00

1. 테스트 선결조건

테스트 카카오톡 채널은 비즈니스 인증이 완료된 채널을 개발서버에 직접 등록하여 발송 가능합니다.

- 좌측메뉴 [발신프로필] > [발신프로필등록] 을 통하여 프로필을 등록

테스트 템플릿은 로그인 하신 비즈엠 사이트(개발)에서 직접 등록하여 '직접 승인' 후 발송 가능합니다.

- 좌측메뉴 [템플릿] > [템플릿 등록]에서 원하시는 테스트용 템플릿을 등록

- 테스트를 위한 템플릿 강제 승인처리(운영에선 카카오측에 검수요청을 통하여 승인)

▪ 직접 승인은 개발서버에서만 사용가능(API를 통하여 승인처리 [2.2.1 템플릿 승인] 참조)

테스트 수신자는 일회성 인증을 받은 사용자만 가능합니다.

- [2.3 일회성 사용자 인증] 참조

테스트 수신자는 테스트를 위한 카카오톡 채널을 추가해야 합니다.

- 앞서 등록한 카카오톡 채널을 카카오톡에서 '채널추가' 해야 테스트 알림톡 수신 가능

테스트 발송 시 메시지 내 텍스트 영역에 자동으로 [테스트발송] 말머리를 포함하여 발송하므로,
메시지 총 글자수가 1000자 이상일 경우 텍스트가 잘릴 수 있습니다.
최대 글자수에서 약 10글자 내외 여유를 두고 작성하시어 테스트 부탁드립니다.

2. 선행작업용 API 모음

2.1 API 서버 Host

- [개발서버] : https://dev-alimtalk-api.bizmsg.kr:1443

2.2 템플릿 승인/반려/휴면(개발전용)

2.2.1 템플릿 승인(개발전용)

검수 요청된 템플릿을 승인 처리합니다.
템플릿 승인은 개발 서버에 등록한 템플릿으로만 가능합니다.
승인된 템플릿은 일회성 사용자 인증을 마친 휴대폰번호로 테스트 발송할 수 있습니다.

- 승인과정 : 템플릿 등록 > 검수 요청 > 템플릿 승인 요청 > 승인

[Request]

path : /v2/partner/test/template/approve
method : POST
header

키	타입	필수	설명
userid	text(20)	Y	사용자 계정명(비즈엠)

parameter

키	타입	필수	설명
senderKey	text	Y	발신 프로필 키
templateCode	text	Y	템플릿 코드
senderKeyType	text	Y	발신프로필타입(G:그룹, S:기본(default)
comment	text	Y	댓글

Example

        curl -X POST 'https://dev-alimtalk-api.bizmsg.kr:1443/v2/partner/test/template/approve' \
        -d 'senderKey=발신프로필키&templateCode=템플릿코드' \
        -H 'userId:사용자계정명'

[Response]

응답 바디는 JSON 객체로 아래 값을 참고 해주세요.

키	필수	설명
code	text	성공/실패 여부(success: 성공, fail: 실패)
data	text	없음
message	text	처리결과 오류 메시지

Result

    // 성공
    {
        "code": "success",
        "data": "",
        "message": ""
    }

    // 실패
    {
        "code": "fail",
        "data": "",
        "message": ""
    }

2.2.2 템플릿 반려(개발서버전용)

검수 요청된 템플릿을 반려 처리합니다.
템플릿 반려는 개발 서버에 등록한 템플릿으로만 가능합니다.

[Request]

path : /v2/partner/test/template/reject
method : POST
header

키	타입	필수	설명
userid	text(20)	Y	사용자 계정명 (비즈엠)

parameter

키	타입	필수	설명
senderKey	text	Y	발신 프로필 키
templateCode	text	Y	템플릿 코드
senderKeyType	text	N	발신프로필타입(G:그룹, S:기본(default)
comment	text	N	댓글

Example

    $ curl -X POST 'https://dev-alimtalk-api.bizmsg.kr:1443/v2/partner/test/template/reject' -H "userid:{userid}"
    -d "senderKey={발신프로필키}&templateCode={템플릿코드}"

[Response]

응답 바디는 JSON 객체로 아래 값을 참고 해주세요.

키	필수	설명
code	text	성공/실패 여부(success: 성공, fail: 실패)
data	object
message	text	처리결과 오류 메시지

Result

    // 성공
    {
        "code": "success",
        "data": "",
        "message": ""
    }

    // 실패
    {
        "code": "fail",
        "data": "",
        "message": ""
    }

2.2.3 템플릿 휴면(개발서버전용)

템플릿을 휴면 처리합니다.
템플릿 휴면처리는 개발 서버에 등록한 템플릿으로만 가능합니다.

[Request]

path : /v2/partner/test/template/dormant
method : POST
header

키	타입	필수	설명
userid	text(20)	Y	사용자 계정명 (비즈엠)

parameter

키	타입	필수	설명
senderKey	text	Y	발신 프로필 키
templateCode	text	Y	템플릿 코드
senderKeyType	text	N	발신프로필타입(G:그룹, S:기본(default)

Example

    $ curl -X POST 'https://dev-alimtalk-api.bizmsg.kr:1443/v2/partner/test/template/dormant' -H "userid:{userid}"
    -d "senderKey={발신프로필키}&templateCode={템플릿코드}"

[Response]

응답 바디는 JSON 객체로 아래 값을 참고 해주세요.

키	필수	설명
code	text	성공/실패 여부(success: 성공, fail: 실패)
data	object
message	text	처리결과 오류 메시지

Result

    // 성공
    {
        "code": "success",
        "data": "",
        "message": ""
    }

    // 실패
    {
        "code": "fail",
        "data": "",
        "message": ""
    }

2.3 일회성 사용자 인증

2.3.1 일회성 사용자 인증 토큰 요청

일회성 사용자 인증 승인을 위해 필요한 토큰을 요청합니다.
카카오톡 메시지를 통해 인증번호를 확인하실 수 있습니다.

[Request]

path : /v2/partner/test/user/token
method : GET
URL Query String Parameter

키	타입	필수	설명
phoneNumber	text	Y	발송 테스트 이용할 휴대폰번호 ( 해당 번호로 토큰번호 전송 )

Example

- Query String Parameter 방식으로 요청

    $ curl -X POST 'https://dev-alimtalk-api.bizmsg.kr:1443/v2/partner/test/user/token?phoneNumber=01012341234'

[Response]

응답 바디는 JSON 객체로 아래 값을 참고 해주세요.

키	-	필수	설명
code		text	성공/실패 여부(success: 성공, fail: 실패)
data		object
	expiredAt	text	토큰 만료 시간 (yyyy-MM-dd HH:mm:ss, KST기준)
message		text	처리결과 오류 메시지

Result

    // 성공
    {
        "code": "success",
        "data": {
                    "expiredAt": “2021-01-01 09:00:00
                },
        "message": ""
    }

    // 실패
    {
        "code": "fail",
        "data": "",
        "message": "카카오톡 유저가 아닙니다."
    }

2.3.2 일회성 사용자 인증 승인

카카오톡 메시지로 전달받은 토큰 번호는 token 값에 넣고 일회성 사용자 인증 승인을 요청합니다.
인증된 사용자는 그날 하루 동안(23:59:59까지) 테스트 발송을 할 수 있습니다.

[Request]

path : /v2/partner/test/user/certify
method : POST
URL Query String Parameter

키	타입	필수	설명
phoneNumber	text	Y	토큰 번호 요청에 사용된 휴대폰번호
token	text	Y	카카오톡 메시지로 수신한 토큰 번호

Example

- Query String Parameter 방식으로 요청

    $ curl -X POST 'https://dev-alimtalk-api.bizmsg.kr:1443/v2/partner/test/user/certify?phoneNumber=01012341234
    &token=102030'

[Response]

응답 바디는 JSON 객체로 아래 값을 참고 해주세요.

키	-	필수	설명
code		text	성공/실패 여부(success: 성공, fail: 실패)
data		object
	expiredAt	text	토큰 만료 시간 (yyyy-MM-dd HH:mm:ss, KST기준)
message		text	처리결과 오류 메시지

Result

    // 성공
    {
        "code": "success",
        "data": {
                    "expiredAt": “2021-01-01 09:00:00
                },
        "message": ""
    }

    // 실패
    {
        "code": "fail",
        "data": "",
        "message": "카카오톡 유저가 아닙니다."
    }