Kakao i Connect Message::BizMessage(KOR)::API 호출 방식::Sample Code

페이지 이동경로

Sample Code

BizMessage API 유형별 코드 예제는 다음과 같습니다.
코드 예제 내 Base URL은 사용자의 환경에 따라 다르게 입력합니다.

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

OAuth 2.0 인증

OAuth 2.0 인증 API 명세는 OAuth 2.0 인증 문서를 참고하시기 바랍니다.

코드예제OAuth 2.0 인증 Sample Code

var myHeaders = new Headers();
myHeaders.append("Authorization", "Basic ${client_id} ${client_secret}");

var urlencoded = new URLSearchParams();
urlencoded.append("grant_type", "client_credentials");

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: urlencoded,
  redirect: 'follow'
};

fetch("${base_url}/v2/oauth/token", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

알림톡 발송

알림톡 발송 API 명세는 알림톡 발송 문서를 참고하시기 바랍니다.

코드예제알림톡 발송 Sample Code

var myHeaders = new Headers();
myheaders.append(Authorization, Bearer ${access_token});
myheaders.append(Content-Type: application/json);

var body = new FormData();
body.append(client_id, client_id);
body.append(message_type, message_type);
body.append(message, message);
body.append(cid, cid);
body.append(phone_number, phone_number);


var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: JSON.stringify(body),
  redirect: 'follow'
};

fetch("${base_url}/v2/send/kakao", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

친구톡

친구톡 발송

친구톡 발송 API 명세는 친구톡 발송 문서를 참고하시기 바랍니다.

코드예제친구톡 발송 Sample Code

var myHeaders = new Headers();
myheaders.append(Authorization, Bearer ${access_token});
myheaders.append(Content-Type: application/json);

var body = new FormData();
body.append(client_id, client_id);
body.append(message_type, message_type);
body.append(message, message);
body.append(cid, cid);
body.append(phone_number, phone_number);


var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: JSON.stringify(body),
  redirect: 'follow'
};

fetch("${base_url}/v2/send/kakao", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

친구톡 일반 이미지 업로드

친구톡 일반 이미지 업로드 API 명세는 친구톡 일반 이미지 업로드를 참고하시기 바랍니다.

코드예제친구톡 이미지 업로드 Sample Code

var myHeaders = new Headers();
myheaders.append(Authorization, Bearer ${access_token});
myheaders.append(Content-Type: multipart/form-data);

var formdata = new FormData();
formdata.append("image", fileInput.files[0]);

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: formdata,
  redirect: 'follow'
};

fetch("${base_url}/v2/upload/ft/image", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

친구톡 와이드 이미지 업로드

친구톡 와이드 이미지 업로드 API 명세는 친구톡 와이드 이미지 업로드를 참고하시기 바랍니다.

코드예제친구톡 와이드 이미지 업로드 Sample Code

var myHeaders = new Headers();
myheaders.append(Authorization, Bearer ${access_token});
myheaders.append(Content-Type: multipart/form-data);

var formdata = new FormData();
formdata.append("image", fileInput.files[0]);

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: formdata,
  redirect: 'follow'
};

fetch("${base_url}/v2/upload/ft/wide/image", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

친구톡 발송 정보 리스트 조회

친구톡 발송 정보 리스트 조회 API 명세는 친구톡 발송 정보 리스트 조회를 참고하시기 바랍니다.

코드예제친구톡 발송 정보 리스트 조회 Sample Code

var myHeaders = new Headers();
myheaders.append(Authorization, Bearer ${access_token});
myheaders.append(Content-Type: application/json);

var body = new FormData();
body.append(client_id, client_id);
body.append(start_date, start_date);
body.append(end_date, end_date);
body.append(status_code,status_code);
body.append(etc1, etc1);
body.append(etc2, etc2);
body.append(size, size);
body.append(page, page);
body.append(last_uid, uid);

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: JSON.stringify(body),
  redirect: 'follow'
};

fetch("${base_url}/v2/info/ft/search", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

친구톡 발송 상세 정보 조회

친구톡 발송 상세 정보 조회 API 명세는 친구톡 발송 상세 정보 조회를 참고하시기 바랍니다.

코드예제친구톡 발송 상세 정보 조회 Sample Code

var myHeaders = new Headers();
myheaders.append(Authorization, Bearer ${access_token});

var requestOptions = {
  method: GET,
  headers: myHeaders,
  redirect: 'follow'
};

fetch("${base_url}/v2/info/ft/search/detail/${uid}?client_id=${client_id}", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

XMS 메시지 발송

XMS 메시지 발송 API 명세는 XMS 메시지 발송을 참고하시기 바랍니다.

코드예제XMS 메시지 발송 Sample Code

var myHeaders = new Headers();
myheaders.append(Authorization, Bearer ${access_token});
myheaders.append(Content-Type: application/json);

var body = new FormData();
body.append(client_id, client_id);
body.append(message_type, message_type);
body.append(message, message);
body.append(cid, cid);
body.append(phone_number, phone_number);


var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: JSON.stringify(body),
  redirect: 'follow'
};

fetch("${base_url}/v2/send/xms", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

MMS 파일 업로드

MMS 파일 업로드 API 명세는 MMS 파일 업로드를 참고하시기 바랍니다.

코드예제MMS 파일 업로드 Sample Code

var myHeaders = new Headers();
myheaders.append(Authorization, Bearer ${access_token});
myheaders.append(Content-Type: multipart/form-data);

var formdata = new FormData();
formdata.append("images", fileInput.files[0]);
formdata.append("images", fileInput.files[1]);
formdata.append("images", fileInput.files[2]);

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: formdata,
  redirect: 'follow'
};

fetch("${base_url}/v2/upload/message/mms/files", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

RCS

RCS 메시지 발송

RCS 메시지 발송 API 명세는 RCS 메시지 발송를 참고하시기 바랍니다.

코드예제RCS 메시지 발송 Sample Code

var myHeaders = new Headers();
myheaders.append(Authorization, Bearer ${access_token});
myheaders.append(Content-Type: application/json);

var body = new FormData();
body.append(client_id, client_id);
body.append(message_type, message_type);
body.append(cid, cid);
body.append(phone_number, phone_number);
body.append(body, body);


var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: JSON.stringify(body),
  redirect: 'follow'
};

fetch("${base_url}/v2/send/rcs", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

RCS 파일 업로드

RCS 파일 업로드 API 명세는 RCS 파일 업로드를 참고하시기 바랍니다.

코드예제RCS 파일 업로드 Sample Code

var myHeaders = new Headers();
myheaders.append(Authorization, Bearer ${access_token});
myheaders.append(Content-Type: multipart/form-data);

var formdata = new FormData();
formdata.append("image", fileInput.files[0]);
formdata.append("description", description);

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: formdata,
  redirect: 'follow'
};

fetch("${base_url}/v2/upload/rcs", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

RCS 발송 정보 리스트 조회

RCS 발송 정보 리스트 조회 API 명세는 RCS 파일 업로드를 참고하시기 바랍니다.

코드예제RCS 발송 정보 리스트 조회 Sample Code

var myHeaders = new Headers();
myheaders.append(Authorization, Bearer ${access_token});
myheaders.append(Content-Type: application/json);

var body = new FormData();
body.append(client_id, client_id);
body.append(start_date, start_date);
body.append(end_date, end_date);
body.append(status,status_code);
body.append(size, size);
body.append(last_uid, uid);
body.append(service_type, service_type);

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: JSON.stringify(body),
  redirect: 'follow'
};

fetch("${base_url}/v2/info/rcs/search", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

RCS 발송 상세 정보 조회

RCS 발송 상세 정보 조회 API 명세는 RCS 발송 상세 정보 조회를 참고하시기 바랍니다.

코드예제RCS 발송 상세 정보 조회 Sample Code

var myHeaders = new Headers();
myheaders.append(Authorization, Bearer ${access_token});

var requestOptions = {
  method: GET,
  headers: myHeaders,
  redirect: 'follow'
};

fetch("${base_url}/v2/info/rcs/search/detail/${uid}?client_id=${client_id}", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

RCS 결과 요청

RCS 결과 요청 API 명세는 RCS 결과 요청 문서를 참고하시기 바랍니다.

코드예제RCS 결과 요청 Sample Code

var myHeaders = new Headers();
myheaders.append(Authorization, Bearer ${access_token});

var requestOptions = {
  method: GET,
  headers: myHeaders,
  redirect: 'follow'
};

fetch("${base_url}/v2/info/rcs/results", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

RCS 결과 완료

RCS 결과 완료 API 명세는 RCS 결과 완료 문서를 참고하시기 바랍니다.

코드예제RCS 결과 완료 Sample Code

var myHeaders = new Headers();
myheaders.append(Authorization, Bearer ${access_token});

var requestOptions = {
  method: PUT,
  headers: myHeaders,
  redirect: 'follow'
};

fetch("${base_url}/v2/info/rcs/results/complete/${report_group_no}", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

발송 조회

메시지 발송 결과 조회 요청

발송한 모든 메시지의 발송 결과를 조회하는 예제는 다음과 같습니다.

안내
메시지 발송 결과 조회 요청 시, 반드시 메시지 발송 결과 조회 완료를 수행해야 합니다. 메시지 발송 결과 조회 완료를 하지 않은 경우, 메시지 발송 결과 조회가 중단없이 계속 진행됩니다.

코드예제메시지 발송 결과 조회 요청 Sample Code

var myHeaders = new Headers();
myheaders.append(Authorization, Bearer ${access_token});

var requestOptions = {
  method: GET,
  headers: myHeaders,
  redirect: 'follow'
};

fetch("${base_url}/v2/info/message/results", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

메시지 발송 결과 조회 완료

다음은 메시지 발송 결과 조회 요청 후, 메시지 발송 결과 조회 완료를 수행하는 예제입니다.

코드예제메시지 결과 완료 Sample Code

var myHeaders = new Headers();
myheaders.append(Authorization, Bearer ${access_token});

var requestOptions = {
  method: PUT,
  headers: myHeaders,
  redirect: 'follow'
};

fetch("${base_url}/v2/info/message/results/complete/${report_group_no}", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

메시지 발송 정보 리스트 조회

발송한 모든 메시지의 발송 정보 리스트를 조회하는 예제는 다음과 같습니다.

코드예제메시지 발송 정보 리스트 조회 Sample Code

var myHeaders = new Headers();
myheaders.append(Authorization, Bearer ${access_token});
myheaders.append(Content-Type: application/json);

var body = new FormData();
body.append(client_id, client_id);
body.append(start_date, start_date);
body.append(end_date, end_date);
body.append(status_code,status_code);
body.append(etc1, etc1);
body.append(etc2, etc2);
body.append(size, size);
body.append(page, page);
body.append(last_uid, uid);

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: JSON.stringify(body),
  redirect: 'follow'
};

fetch("${base_url}/v2/info/message/search", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

메시지 발송 상세 정보 조회

발송한 모든 메시지의 발송 상세 정보를 조회하는 예제는 다음과 같습니다.

코드예제메시지 발송 상세 정보 조회 Sample Code

var myHeaders = new Headers();
myheaders.append(Authorization, Bearer ${access_token});

var requestOptions = {
  method: GET,
  headers: myHeaders,
  redirect: 'follow'
};

fetch("${base_url}/v2/info/message/search/detail/${uid}?client_id=${client_id}", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

이 문서가 만족스러운 이유를 알려주세요.
이 문서에 아쉬운 점을 알려주세요.
평가해주셔서 감사합니다.

더 자세한 의견은 contact.dkt@kakaocorp.com 으로 제보해주세요.