다채널 대체

다채널 대체 발송은 기존 대체 발송(부달 발송)이 SMS, LMS만 지원하던 것과 달리 대체 발송 채널을 다양화하여 발송할 수 있는 기능입니다. 다채널 대체 발송은 Rule 기반의 발송으로, 사용 시 고객사가 웹 화면에서 대체 발송 타입 진행 순서를 설정해야 합니다. 다채널 대체 발송의 Rule은 부서 코드와 1:1 맵핑되므로 발송 시 부서 코드를 첨부하면, 맵핑된 Rule을 참조하여 대체 발송이 진행됩니다. (부서 코드는 웹 화면에서 생성할 수 있습니다.)

대체 발송 타입을 발송 데이터에 임의로 지정할 시 기존 방식과 동일하게 대체 발송됩니다. (SMS, LMS에 대해 한 번의 대체 발송)

안내

다채널 대체 발송은 계약 정보 수정이 필요하므로, 별도 문의하시기 바랍니다.

다채널 대체 발송 관련 웹 화면은 추후 지원 예정입니다.

다채널 대체 발송은 발송/결과 테이블의 칼럼이 추가되므로 추가 대응이 필수로 요구됩니다.

신규 결과 Request 정보

메시지 종류	필드	타입	설명
공통	department_cd	String	부서 코드 - 부서 코드에 매핑된 다채널 대체 발송 전략을 참조하여 발송
XMS	fall_back_yn	String	대체 발송 사용 여부 - XMS는 대체 발송이 없었기에 추가
XMS	fall_back_title	String	대체 발송 제목 - XMS는 대체 발송이 없었기에 추가
XMS	fall_back_message	String	대체 발송 메시지 - XMS는 대체 발송이 없었기에 추가

안내

모든 BizMessage API를 호출하기 전, OAuth 2.0 인증 API를 선제적으로 호출해야 합니다.

API 기능별 예제는 Sample Code 문서를 참고하시기 바랍니다.

주의
스테이징 서버는 카카오 운영 서버와 연동되어 있어 실제 메시지가 발송되므로, 메시지 오발송에 주의하시기 바랍니다.

통합 메시지 발송 결과 요청

메시지 결과를 발송과 동시에 응답하는 push 방식으로만 구성되어있지 않은 경우 별도의 결과 수신 API를 통해 메시지 발송 결과를 수신할 수 있습니다.

모든 메시지 타입을 처리할 수 있습니다.

안내
메시지 결과 요청 후 완료 처리해야 처리된 결과를 재조회하지 않습니다.

Request

Request Syntax

코드예제통합 메시지 발송 결과 요청 Request Syntax

BASH

curl -X 'GET' \
  'https://{base_url}/v2/info/report/results' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer {oauthToken}'

표API 호출 방식

메서드	요청 URL
GET	`https://{base_url}/v2/info/report/results`

표통합 메시지 발송 결과 요청 Path Parameter

파라미터	유형	필수 여부	대분류	구분	설명
base_url	String	`필수`	운영	일반	`bizmsg-web.kakaoenterprise.com`
				금융권	`bizmsg-bank.kakaoenterprise.com`
				증권	`bizmsg-stock.kakaoenterprise.com`
				공공 기관	`bizmsg-gov.kakaoenterprise.com`
			스테이징	일반	`stg-user.bizmsg.kakaoenterprise.com`
				금융권	`stg-bizmsg-bank.kakaoenterprise.com`
				증권	`stg-bizmsg-stock.kakaoenterprise.com`
				공공 기관	`stg-bizmsg-gov.kakaoenterprise.com`

Request Header

표통합 메시지 발송 결과 요청 Request Header

파라미터	타입	필수 여부	설명
accept	String	`필수`	`/`로 고정
authorization	String	`필수`	`Bearer {oauthToken}` - `{oauthToken}`: OAuth 2.0 인증 API로 발급받은 액세스 토큰
client_id	String	`선택`	발송 고객사 ID
message_types	String[]	`선택`	조회하고자 하는 메시지 타입

Response

Response Syntax

코드예제통합 메시지 발송 결과 요청 Response Syntax

JSON

{
  "code": "200",
  "code_detail": {
    "detail_code": "",
    "detail_message": "성공"
  },
  "report_group_no": "8493608862033069978",
  "results": [
    {
      "cid": "77613652af2d464580796c41cf0d39a3",
      "uid": "220918080309405KFXrvK8CR9e+k8s",
      "message_type": "AT",
      "final_message_type": "RCSSMS",
      "status_code": "API_200",
      "broker_status_code": "0000",
      "error_message": "성공",
      "req_date": "2022-12-07T04:58:36.656Z",
      "res_date": "2022-12-07T04:58:36.656Z"
    }
  ]
}

표통합 메시지 발송 결과 요청 Response Elements

프로퍼티	타입	필수 여부	설명
code	String	`선택`	메시지 발송 결과 코드 - `100`: 발송 진행 중 (처리중) - `200`: 성공 - `400`: 권한 오류 - `410`: 입력값이 유효하지 않음 - `420`: 파일/이미지 관련 오류 - `500`: 내부 시스템 오류 - `510`: 발송 실패 - `520`: 실패되었으나 재 발송 가능능
	Object	`선택`	상세 코드 정보
detail_code	String	`선택`	상세 코드
detail_message	String	`선택`	상세 메시지
report_group_no	String	`선택`	메시지 결과 그룹 고유 번호
	Array	`선택`	메시지 결과 조회 리스트
uid	String	`선택`	메시지의 Key ID
cid	String	`선택`	고객사 정의 Key Id
message_type	String	`선택`	최초 요청 메시지 타입
final_message_type	String	`선택`	최종 발송 메시지 타입
status_code	String	`선택`	메시지 상태 코드 - 상세 정보는 API 메시지 상태 코드 문서 참고
broker_status_code	String	`선택`	발송사에서 전송되는 처리 결과 코드
error_message	String	`선택`	결과 메시지
req_date	String	`선택`	발송 요청 시간
res_date	String	`선택`	처리 완료 시간

통합 메시지 발송 결과 완료

결과 요청이 완료된 메시지를 완료 처리하는 API입니다.

Request

Request Syntax

코드예제통합 메시지 발송 결과 완료 Request Syntax

BASH

curl -X 'PUT' \
  'https://{base_url}/v2/info/report/results/complete/{report_group_no}' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer {oauthToken}'

표API 호출 방식

메서드	요청 URL
PUT	`https://{base_url}/v2/info/report/results/complete/{report_group_no}`

표통합 메시지 발송 결과 완료 Path Parameter

파라미터	유형	필수 여부	대분류	구분	설명
base_url	String	`필수`	운영	일반	`bizmsg-web.kakaoenterprise.com`
				금융권	`bizmsg-bank.kakaoenterprise.com`
				증권	`bizmsg-stock.kakaoenterprise.com`
				공공 기관	`bizmsg-gov.kakaoenterprise.com`
			스테이징	일반	`stg-user.bizmsg.kakaoenterprise.com`
				금융권	`stg-bizmsg-bank.kakaoenterprise.com`
				증권	`stg-bizmsg-stock.kakaoenterprise.com`
				공공 기관	`stg-bizmsg-gov.kakaoenterprise.com`
report_group_no	String	`필수`			메시지 결과 그룹 고유 번호

Request Header

표통합 메시지 발송 결과 완료 Request Header

파라미터	타입	필수 여부	설명
accept	String	`필수`	`/`로 고정
authorization	String	`필수`	`Bearer {oauthToken}` - `{oauthToken}`: OAuth 2.0 인증 API로 발급받은 액세스 토큰

Response

Response Syntax

코드예제통합 메시지 발송 결과 완료 Response Syntax

JSON

{
  "code": "200",
  "code_detail": {
    "detail_code": "",
    "detail_message": "성공"
  }
}

Response Elements

표통합 메시지 발송 결과 완료 Response Elements

프로퍼티	타입	필수 여부	설명
code	String	`선택`	메시지 발송 결과 코드 - `100`: 발송 진행 중 (처리중) - `200`: 성공 - `400`: 권한 오류 - `410`: 입력값이 유효하지 않음 - `420`: 파일/이미지 관련 오류 - `500`: 내부 시스템 오류 - `510`: 발송 실패 - `520`: 실패되었으나 재 발송 가능
	Object	`선택`	메시지 상태 상세 코드
detail_code	String	`선택`	상세 코드
detail_message	String	`선택`	상세 메시지

통합 메시지 발송 상세 조회

다음은 모든 타입에 대한 발송 결과를 상세하게 조회할 수 있는 API 기능에 대한 설명입니다.

Request

Request Syntax

코드예제통합 메시지 상세 조회 Request Syntax

BASH

curl -X 'GET' \
  'https://{base_url}/v2/info/report/search/detail/{uid}' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer {oauthToken}'

표API 호출 방식

메서드	요청 URL
GET	`https://{base_url}/v2/info/report/search/detail/{uid}`

표통합 메시지 상세 조회 Path Parameter

파라미터	유형	필수 여부	대분류	구분	설명
base_url	String	`필수`	운영	일반	`bizmsg-web.kakaoenterprise.com`
				금융권	`bizmsg-bank.kakaoenterprise.com`
				증권	`bizmsg-stock.kakaoenterprise.com`
				공공 기관	`bizmsg-gov.kakaoenterprise.com`
			스테이징	일반	`stg-user.bizmsg.kakaoenterprise.com`
				금융권	`stg-bizmsg-bank.kakaoenterprise.com`
				증권	`stg-bizmsg-stock.kakaoenterprise.com`
				공공 기관	`stg-bizmsg-gov.kakaoenterprise.com`
uid	String	`필수`			메시지 Key ID - ex. `21018173501346cxU7zEswSYSsTmS`

Request Header

표통합 메시지 상세 조회 Request Header

파라미터	타입	필수 여부	설명
accept	String	`필수`	`/`로 고정
authorization	String	`필수`	`Bearer {oauthToken}` - `{oauthToken}`: OAuth 2.0 인증 API로 발급받은 액세스 토큰

Response

Response Syntax

코드예제통합 메시지 상세 조회 Response Syntax

JSON

{
  "code": "200",
  "code_detail": {
    "detail_code": "",
    "detail_message": "성공"
  },
  "results": {
    "cid": "11329b64174a4738b049e2a74e93c5c1",
    "uid": "221018080314511j7usTgzgQDOXvIk",
    "phone_number": "01000000000",
    "sender_no": "0000-0000",
    "message": "메시지",
    "fall_back_message": "대체 메시지",
    "steps": [
      {
        "step": 0,
        "message_type": "AT",
        "template_code": "TEMPLATECODE-1",
        "status_code": "API_200",
        "broker_status_code": "0000",
        "error_message": "성공",
        "req_date": "2022-12-07T05:10:40.540Z",
        "res_date": "2022-12-07T05:10:40.540Z"
      }
    ]
  }
}

Response Elements

표통합 메시지 상세 조회 Response Elements

프로퍼티	타입	필수 여부	설명
code	String	`선택`	메시지 발송 결과 코드 - `100`: 발송 진행 중 (처리중) - `200`: 성공 - `400`: 권한 오류 - `410`: 입력값이 유효하지 않음 - `420`: 파일/이미지 관련 오류 - `500`: 내부 시스템 오류 - `510`: 발송 실패 - `520`: 실패되었으나 재 발송 가능
		`선택`	메시지 상태 상세 코드
detail_code	String	`선택`	상세 코드
detail_message	String	`선택`	상세 메시지
		`선택`	단일 메시지의 발송 결과 상세 조회
cid	String	`선택`	고객사 정의 Key ID
uid	String	`선택`	메시지의 Key ID
phone_number	String	`선택`	수신자 전화번호 - text(16)
sender_no	String	`선택`	발신자 전화번호 - text(16)
message	String	`선택`	발송 메시지 내용
fall_back_message	String	`선택`	대체 발송 메시지 내용
		`선택`	대체 발송 시 타입 별 상세 결과
step	Integer	`선택`	메시지 발송 순서 - 타입 변경마다 1씩 증가
message_type	String	`선택`	메시지 타입
template_code	String	`선택`	템플릿 코드 - 타입 별로 사용 템플릿이 다를 수 있음
status_code	String	`선택`	dk techin 메시지 발송 결과 코드
broker_status_code	String	`선택`	발송사 메시지 발송 결과 코드 (참고용)
error_message	String	`선택`	상세 메시지
req_date	String	`선택`	발송 요청 시각
res_date	String	`선택`	결과 처리 시각

kakaoIdocumentation

Kakao i Connect Message::BizMessage(KOR)::API 호출 방식::API 레퍼런스::다채널 대체 발송

페이지 이동경로

다채널 대체

신규 결과 Request 정보

통합 메시지 발송 결과 요청

Request

Request Syntax

Request Header

Response

Response Syntax

통합 메시지 발송 결과 완료

Request

Request Syntax

Request Header

Response

Response Syntax

Response Elements

통합 메시지 발송 상세 조회

Request

Request Syntax

Request Header

Response

Response Syntax

Response Elements