카카오 비즈메시지

카카오 비즈메시지(알림톡 등) 발송 규격입니다.

• 채널이 등록 되어있는 수신자에게만 친구톡 전송이 가능합니다.

• 친구톡 이미지 메시지를 전송할 경우 사전에 이미지 파일 등록(카카오 비즈메시지 센터)이 필요 합니다.

• 상세 Response 내용은 코드표를 참조해주시기 바랍니다.

알림톡 전송을 위해 사전 승인된 알림톡템플릿코드가 필요 합니다.

알림톡 전송

Error with https://content.gitbook.com/content/jmWNXhuX9P0xPT3xSwge/blobs/26qfyHlb77pUfoOl9pbo/infobank_omniapi_v0.0.9_20230802.yaml: Failed to parse YAML: Multi-line single-quoted string needs to be sufficiently indented

cURL

curl -X POST https://omni.ibapi.kr/v1/send/alimtalk \
-H "content-type: application/json" \
-H "Accept: application/json" \
-H "Authorization:Bearer 발급받은 토큰" \
-d '{"templateCode":"알림톡 템플릿 코드", "msgType":"AT", "text":"알림톡 메시지 내용", "senderKey":"카카오 비즈메시지 발신프로필키", "to":"수신번호", "ref":"참조필드"}' 

JAVA

import java.io.*;
import okhttp3.*;
public class Main {
  public static void main(String []args) throws IOException{
    OkHttpClient client = new OkHttpClient().newBuilder()
      .build();
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"senderKey\": \"발신 프로필키\", \"msgType\": \"알림톡 메시지 타입(AT/AI)\", \"to\": \"수신번호\", \"templateCode\": \"알림톡 템플릿코드\", \"text\": \"알림톡 메시지 내용\", \"ref\": \"참조필드\"}");
    Request request = new Request.Builder()
      .url("https://omni.ibapi.kr/v1/send/alimtalk")
      .method("POST", body)
      .addHeader("Content-Type", "application/json")
      .addHeader("Accept", "application/json")
      .addHeader("Authorization", "Bearer 발급받은 토큰")
      .build();
    Response response = client.newCall(request).execute();
    System.out.println(response.body().string());
  }
}

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://omni.ibapi.kr/v1/send/alimtalk"
  method := "POST"

  payload := strings.NewReader(`{"senderKey": "발신 프로필키", "msgType": "알림톡 메시지 타입(AT/AI)", "to": "수신번호", "templateCode": "알림톡 템플릿코드", "text": "알림톡 메시지 내용", "ref": "참조필드"}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Accept", "application/json")
  req.Header.Add("Authorization", "Bearer 발급받은 토큰")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://omni.ibapi.kr/v1/send/alimtalk',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{"senderKey": "발신 프로필키", "msgType": "알림톡 메시지 타입(AT/AI)", "to": "수신번호", "templateCode": "알림톡 템플릿코드", "text": "알림톡 메시지 내용", "ref": "참조필드"}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Accept: application/json',
    'Authorization: Bearer 발급받은 토큰'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

NodeJS

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://omni.ibapi.kr/v1/send/alimtalk',
  'headers': {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'Authorization': 'Bearer 발급받은 토큰'
  },
  body: JSON.stringify({
    "senderKey": "발신 프로필키",
    "msgType": "알림톡 메시지 타입(AT/AI)",
    "to": "수신번호",
    "templateCode": "알림톡 템플릿코드",
    "text": "알림톡 메시지 내용",
    "ref": "참조필드"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

C#

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://omni.ibapi.kr/v1/send/alimtalk");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer 발급받은 토큰");
var content = new StringContent("{\"senderKey\": \"발신 프로필키\", \"msgType\": \"알림톡 메시지 타입(AT/AI)\", \"to\": \"수신번호\", \"templateCode\": \"알림톡 템플릿코드\", \"text\": \"알림톡 메시지 내용\", \"ref\": \"참조필드\"}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

JavaScript

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Accept", "application/json");
myHeaders.append("Authorization", "Bearer 발급받은 토큰");

var raw = JSON.stringify({
  "senderKey": "발신 프로필키",
  "msgType": "알림톡 메시지 타입(AT/AI)",
  "to": "수신번호",
  "templateCode": "알림톡 템플릿코드",
  "text": "알림톡 메시지 내용",
  "ref": "참조필드"
});

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

fetch("https://omni.ibapi.kr/v1/send/alimtalk", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

python

import http.client
import json

conn = http.client.HTTPSConnection("omni.ibapi.kr")
payload = json.dumps({
  "senderKey": "발신 프로필키",
  "msgType": "알림톡 메시지 타입(AT/AI)",
  "to": "수신번호",
  "templateCode": "알림톡 템플릿코드",
  "text": "알림톡 메시지 내용",
  "ref": "참조필드"
})
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer 발급받은 토큰'
}
conn.request("POST", "/v1/send/alimtalk", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Ruby

require "uri"
require "json"
require "net/http"

url = URI("https://omni.ibapi.kr/v1/send/alimtalk")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Accept"] = "application/json"
request["Authorization"] = "Bearer 발급받은 토큰"
request.body = JSON.dump({
  "senderKey": "발신 프로필키",
  "msgType": "알림톡 메시지 타입(AT/AI)",
  "to": "수신번호",
  "templateCode": "알림톡 템플릿코드",
  "text": "알림톡 메시지 내용",
  "ref": "참조필드"
})

response = https.request(request)
puts response.read_body

Request

Header

Name	Type	Description
Authorization	String	schema + “ “ + token
Content-Type	String	application/json
Accept	String	application/json

Body

Name	Type	Required	Description
senderKey	String	YES	카카오 비즈메시지 발신 프로필 키
msgType	String	YES	카카오 알림톡메시지타입
to	String	YES	수신번호
templateCode	String	YES	알림톡 템플릿 코드
text	String	YES	알림톡 내용
button	Object Array	NO	카카오 버튼 정보(최대 5개)
ref	String(200)	NO	참조필드
fallback	Object	NO	실패 시 전송될 Fallback 메시지 정보

Response

Header

Name	Type	Description
Content-Type	String	application/json

Body

Name	Type	Description
code	String(4)	API호출 결과 코드
result	String	API호출 결과 설명
msgKey	String	메시지 키
ref	String(200)	참조필드(요청 시 입력한 데이터)

Schema

button

Name	Type	Required	Description
type	String	YES	카카오 버튼 종류
name	String	YES	카카오 버튼 명
urlPc	String	NO	PC 환경에서 버튼 클릭시 이동할 URL
urlMobile	String	NO	모바일 환경에서 버튼 클릭 시 이동할 URL
schemeIos	String	NO	iOS 환경에서 버튼클릭 시 실행할 application custom scheme
schemeAndroid	String	NO	Android 환경에서 버튼클릭 시 실행 할 application custom scheme
target	String	NO	버튼 type이 WL(웹 링크)일 경우 "target":"out"입력 시 아웃링크 사용
chatExtra	String	NO	봇/상담톡전환 시 전달할 메타정보
chatEvent	String	NO	봇/상담톡 전환 시 연결할 이벤트 명
bizFormKey	String	NO	비즈폼 키
bizFormId	String	NO	비즈폼 ID

fallback

Name	Type	Required	Description
type	String(3)	YES	Fallback 종류(SMS, MMS)
from	String	YES	Fallback 발신번호
text	String(2000)	YES	Fallback 메시지 내용(최대 2,000byte)
title	String(40)	NO	Fallback 메시지 제목(최대 40byte)
fileKey	String Array	NO	Fallback 파일키(최대 3개)
originCID	String(9)	NO	Fallback 최초 발신사업자 식별코드

카카오 버튼 타입(type)

Code	Button type	Related field(Required)	Description
WL	웹 링크	urlMobile (Y) urlPc(N)	버튼 클릭 시 이동할 pc/mobile환경별 web url
AL	앱 링크	schemeAndroid(Y) schemeIos(N) urlMobile(N) urlPc(N)	scheme_ios, scheme_android, url_mobile 중 2가지 필수 입력
BK	봇 키워드	-	해당 버튼 텍스트 전송
MD	메시지 전달	-	해당 버튼 텍스트 + 메시지 본문 전송
DS	배송조회	-	버튼 클릭 시 배송 조회 페이지로 이동
BC	상담톡 전환	chatExtra(N)	상담톡을 이용하는 카카오톡 채널만 이용 가능
BT	챗봇 전환	chatExtra(N) chatEvent(N)	카카오 I 오픈빌더의 챗봇을 사용하는 카카오톡 채널만 이용가능
AC	채널 추가	-	버튼 클릭 시 카카오톡 채널 추가
P1	플러그인#1	-	이미지 보안 전송 플러그인
P2	플러그인#2	-	개인정보이용 플러그인
P3	플러그인#3	-	원클릭 결제 플러그인 (발송시 oneclick_id 또는 product_id를 필수로 전달해아 함)
BF	비즈폼	bizFormKey(N) bizFormId(N)	카카오 비즈니스에서 생성한 비즈니스폼 ID

카카오 메시지 타입(msgtype)

Code	Message type	Description
AT	알림톡	일반 알림톡 템플릿 사용 시 설정
AI	알림톡 이미지	이미지 알림톡 템플릿 사용 시 설정
FT	친구톡	일반 친구톡 메시지 전송 시 설정
FI	친구톡 이미지	이미지 친구톡 메시지 전송 시 설정
FW	친구톡 와이드 이미지	와이드 이미지 친구톡 메시지 전송 시 설정

친구톡 전송

Error with https://content.gitbook.com/content/jmWNXhuX9P0xPT3xSwge/blobs/26qfyHlb77pUfoOl9pbo/infobank_omniapi_v0.0.9_20230802.yaml: Failed to parse YAML: Multi-line single-quoted string needs to be sufficiently indented

cURL

curl -X POST https://omni.ibapi.kr/v1/send/friendtalk \
-H "content-type: application/json" \
-H "Accept: application/json" \
-H "Authorization:Bearer 발급받은 토큰" \
-d '{"msgType":"FT", "text":"친구톡 메시지 내용", "senderKey":"카카오 비즈메시지 발신프로필키", "to":"수신번호", "ref":"참조필드"}' 

JAVA

import java.io.*;
import okhttp3.*;
public class Main {
  public static void main(String []args) throws IOException{
    OkHttpClient client = new OkHttpClient().newBuilder()
      .build();
    MediaType mediaType = MediaType.parse("application/json");
    RequestBody body = RequestBody.create(mediaType, "{\"senderKey\": \"발신 프로필키\", \"msgType\": \"친구톡 메시지 타입(FT/FI/FW)\", \"to\": \"수신번호\", \"text\": \"친구톡 메시지 내용\",\"ref\": \"참조필드\"}");
    Request request = new Request.Builder()
      .url("https://omni.ibapi.kr/v1/send/friendtalk")
      .method("POST", body)
      .addHeader("Content-Type", "application/json")
      .addHeader("Accept", "application/json")
      .addHeader("Authorization", "Bearer 발급받은 토큰")
      .build();
    Response response = client.newCall(request).execute();
    System.out.println(response.body().string());
  }
}

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://omni.ibapi.kr/v1/send/friendtalk"
  method := "POST"

  payload := strings.NewReader(`{"senderKey": "발신 프로필키", "msgType": "친구톡 메시지 타입(FT/FI/FW)", "to": "수신번호", "text": "친구톡 메시지 내용","ref": "참조필드"}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Accept", "application/json")
  req.Header.Add("Authorization", "Bearer 발급받은 토큰")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://omni.ibapi.kr/v1/send/friendtalk',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{"senderKey": "발신 프로필키", "msgType": "친구톡 메시지 타입(FT/FI/FW)", "to": "수신번호", "text": "친구톡 메시지 내용","ref": "참조필드"}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Accept: application/json',
    'Authorization: Bearer 발급받은 토큰'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

NodeJS

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://omni.ibapi.kr/v1/send/friendtalk',
  'headers': {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'Authorization': 'Bearer 발급받은 토큰'
  },
  body: JSON.stringify({
    "senderKey": "발신 프로필키",
    "msgType": "친구톡 메시지 타입(FT/FI/FW)",
    "to": "수신번호",
    "text": "친구톡 메시지 내용",
    "ref": "참조필드"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

C#

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://omni.ibapi.kr/v1/send/friendtalk");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer 발급받은 토큰");
var content = new StringContent("{\"senderKey\": \"발신 프로필키\", \"msgType\": \"친구톡 메시지 타입(FT/FI/FW)\", \"to\": \"수신번호\", \"text\": \"친구톡 메시지 내용\",\"ref\": \"참조필드\"}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

JavaScript

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Accept", "application/json");
myHeaders.append("Authorization", "Bearer 발급받은 토큰");

var raw = JSON.stringify({
  "senderKey": "발신 프로필키",
  "msgType": "친구톡 메시지 타입(FT/FI/FW)",
  "to": "수신번호",
  "text": "친구톡 메시지 내용",
  "ref": "참조필드"
});

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

fetch("https://omni.ibapi.kr/v1/send/friendtalk", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

python

import http.client
import json

conn = http.client.HTTPSConnection("omni.ibapi.kr")
payload = json.dumps({
  "senderKey": "발신 프로필키",
  "msgType": "친구톡 메시지 타입(FT/FI/FW)",
  "to": "수신번호",
  "text": "친구톡 메시지 내용",
  "ref": "참조필드"
})
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer 발급받은 토큰'
}
conn.request("POST", "/v1/send/friendtalk", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Ruby

require "uri"
require "json"
require "net/http"

url = URI("https://omni.ibapi.kr/v1/send/friendtalk")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Accept"] = "application/json"
request["Authorization"] = "Bearer 발급받은 토큰"
request.body = JSON.dump({
  "senderKey": "발신 프로필키",
  "msgType": "친구톡 메시지 타입(FT/FI/FW)",
  "to": "수신번호",
  "text": "친구톡 메시지 내용",
  "ref": "참조필드"
})

response = https.request(request)
puts response.read_body

Request

Header

Name	Type	Description
Authorization	String	schema + “ “ + token
Content-Type	String	application/json
Accept	String	application/json

Body

Name	Type	Required	Description
senderKey	String	YES	카카오 비즈메시지 발신 프로필 키
msgType	String	YES	카카오 친구톡 메시지타입
to	String	YES	수신번호
text	String(90)	YES	친구톡 내용
imgUrl	String	NO	친구톡 이미지 URL
button	Object Array	NO	친구톡 버튼정보
ref	String(200)	NO	참조필드
fallback	Object	NO	실패 시 전송될 Fallback 메시지 정보

Response

Header

Name	Type	Description
Content-Type	String	application/json

Body

Name	Type	Description
code	String(4)	API호출 결과 코드
result	String	API호출 결과 설명
msgKey	String	메시지 키
ref	String(200)	참조필드(요청 시 입력한 데이터)