RCS

RCS 메시지 발송 규격입니다.

• 미디어메시지 종류에 따라 3가지(standalone, carousel, template)로 전송 요청 할 수 있습니다.

• 요청할 메시지 종류에 맞는 format ID(RCS messagebaseId)입력이 필요합니다.

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

RCS메시지 전송

POST /v1/send/rcs

Request

Header

Name	Type	Description
Authorization	String	발급받은 schema + “ “ + 발급받은 accessToken
Content-Type	String	application/json
Accept	String	application/json

Body

Name	Type	Required	Description
content	Object	YES	RCS Message Json Object
from	String	YES	발신번호
to	String	YES	수신번호
formatId	String	YES	RCS 메시지 formatID
brandKey	String	YES	RCS 브랜드 키
brandId	String	NO	RCS 브랜드 ID
expiryOption	String(1)	NO	전송 time out설정 (Default: 1) (1: 24시간, 2: 40초, 3: 3분 10초, 4: 1시간)
header	String(1)	NO	메시지 상단 ‘광고’ 표출 여부 (Default: 0) (0:미표출, 1:표출) 1인경우 footer 입력 필요
footer	String(100)	NO	메시지 하단 수신거부 번호
ref	String(200)	NO	참조필드
fallback	Object	NO	실패 시 전송될 Fallback 메시지 정보

cURL

curl -X POST https://omni.ibapi.kr/v1/send/rcs \
-H "content-type: application/json" \
-H "Accept: application/json" \
-H "Authorization:Bearer 발급받은 토큰" \
-d '{"from": "발신번호", "to": "수신번호", "content": {"standalone": {"text": "메시지 내용"}},"formatId": "RCS 포맷ID", "ref": "참조필드", "brandKey":"RCS브랜드키"}' 

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, "{\"from\": \"발신번호\", \"to\": \"수신번호\", \"content\": {\"standalone\": {\"text\": \"메시지 내용\"}},\"formatId\": \"RCS 포맷ID\", \"ref\": \"참조필드\", \"brandKey\":\"RCS브랜드키\"}");
    Request request = new Request.Builder()
      .url("https://omni.ibapi.kr/v1/send/rcs")
      .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/rcs"
  method := "POST"

  payload := strings.NewReader(`{"from": "발신번호", "to": "수신번호", "content": {"standalone": {"text": "메시지 내용"}},"formatId": "RCS 포맷ID", "ref": "참조필드", "brandKey":"RCS브랜드키"}`)

  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/rcs',
  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 =>'{"from": "발신번호", "to": "수신번호", "content": {"standalone": {"text": "메시지 내용"}},"formatId": "RCS 포맷ID", "ref": "참조필드", "brandKey":"RCS브랜드키"}',
  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/rcs',
  'headers': {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
    'Authorization': 'Bearer 발급받은 토큰'
  },
  body: JSON.stringify({
    "from": "발신번호",
    "to": "수신번호",
    "content": {
      "standalone": {
        "text": "메시지 내용"
      }
    },
    "formatId": "RCS 포맷ID",
    "ref": "참조필드",
    "brandKey":"RCS브랜드키"
  })

};
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/rcs");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer 발급받은 토큰");
var content = new StringContent("{\"from\": \"발신번호\", \"to\": \"수신번호\", \"content\": {\"standalone\": {\"text\": \"메시지 내용\"}},\"formatId\": \"RCS 포맷ID\", \"ref\": \"참조필드\", \"brandKey\":\"RCS브랜드키\"}", 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({
  "from": "발신번호",
  "to": "수신번호",
  "content": {
    "standalone": {
      "text": "메시지 내용"
    }
  },
  "formatId": "RCS 포맷ID",
  "ref": "참조필드",
  "brandKey":"RCS브랜드키"
});

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

fetch("https://omni.ibapi.kr/v1/send/rcs", 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({
  "from": "발신번호",
  "to": "수신번호",
  "content": {
    "standalone": {
      "text": "메시지 내용"
    }
  },
  "formatId": "RCS 포맷ID",
  "ref": "참조필드",
  "brandKey":"RCS브랜드키"
})
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer 발급받은 토큰'
}
conn.request("POST", "/v1/send/rcs", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))py

Ruby

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

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

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({
  "from": "발신번호",
  "to": "수신번호",
  "content": {
    "standalone": {
      "text": "메시지 내용"
    }
  },
  "formatId": "RCS 포맷ID",
  "ref": "참조필드",
  "brandKey":"RCS브랜드키"
})

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

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)	참조필드(요청 시 입력한 데이터)

HTTP 200(성공:Success)

{
    "code": "A000",
    "result": "Success",
    "msgKey": "발급된 메시지 키",
    "ref": "요청시 입력한 데이터"      
}

HTTP 400(실패:Bad Request)

{
    "code": "A010",
    "result": "Cannot parse JSON"
} 

HTTP 401(실패:Unauthorized)

{
    "code": "A001",
    "result": "Expired token"
}

HTTP 429(실패:Too Many Requests)

{
    "code": "A020",
    "result": "Rate limit exceeded"
}

HTTP 500(실패:Forbidden)

{
    "code": "A999",
    "result": "Unknown error"
}

Schema

content

3개 필드 중 1개 필수(standalone, carousel, template)입니다.

Name	Type
standalone	Object Name Type Description text String RCS 내용 title String RCS 제목 media String 미디어(maapfile://) mediaUrl String 클릭 시 랜딩 URL (값이 '\' 경우 이미지 전체보기) button Object Array 버튼 정보 subContent Object Array 서브 컨텐트 정보
carousel	Object Array Name Type Description text String RCS 내용 title String RCS 제목 media String 미디어(maapfile://) mediaUrl String 클릭 시 랜딩 URL (값이 '\' 경우 이미지 전체보기) button Object Array 버튼 정보
template	Object Name Type Description title String 템플릿 제목 description String {key} String 사전에 등록된 key, value(JSON) subContent Object Array 서브 컨텐트 정보

subContent

Name	Type	Description
subTitle	String	서브 소제목
subDesc	String	서브 소본문
subMedia	String	서브 이미지
subMediaUrl	String	서브 이미지 URL

RCS formatId(messagebaseId)

Service	Code	Type	Specifications
RCS SMS	SS000000	Standalone	Image: none Title: none Text: 최대 100자 Card: 1장 Button: 1개
RCS LMS	SL000000	Standalone	Image: none Title: 최대 30자 Text: 최대 1,300자 Card: 1장 Button: 3개(최대 17자)Image: Tall(568*528) Title: 최대 30자 Text: 최대 1,300자 Card: 1장 Button: 3개(최대 17자)
RCS MMS	SMwThT00	Standalone Media Top	Image: Tall(568*528) Title: 최대 30자 Text: 최대 1,300자 Card: 1장 Button: 2개(최대 17자)
RCS MMS	SMwThM00	Standalone Media Top	Image: Medium(568*336) Title: 최대 30자 Text: 최대 1,300자 Card: 1장 Button: 2개(최대 17자)
RCS MMS CAROUSEL	CMwMhM0200	Carousel Medium	Image: Medium(696*504) 총합 1MB Title: 카드 별 최대 30자 Text: 총합 1,300자 Card: 2장 Button: 카드 별 2개(최대 13자)
RCS MMS CAROUSEL	CMwMhM0300	Carousel Medium	Image: Medium(696*504) 총합 1MB Title: 카드 별 최대 30자 Text: 총합 1,300자 Card: 3장 Button: 카드 별 2개(최대 13자)
RCS MMS CAROUSEL	CMwMhM0400	Carousel Medium	Image: Medium(696*504) 총합 1MB Title: 카드 별 최대 30자 Text: 총합 1,300자 Card: 4장 Button: 카드 별 2개(최대 13자)
RCS MMS CAROUSEL	CMwMhM0500	Carousel Medium	Image: Medium(696*504) 총합 1MB Title: 카드 별 최대 30자 Text: 총합 1,300자 Card: 5장 Button: 카드 별 2개(최대 13자)
RCS MMS CAROUSEL	CMwMhM0600	Carousel Medium	Image: Medium(696*504) 총합 1MB Title: 카드 별 최대 30자 Text: 총합 1,300자 Card: 6장 Button: 카드 별 2개(최대 13자)
RCS MMS CAROUSEL	CMwShS0200	Carousel Small	Image: Small(360*336) 총합 1MB Title: 카드 별 최대 30자 Text: 총합 1,300자 Card: 2장 Button: 카드 별 2개(최대 5자)
RCS MMS CAROUSEL	CMwShS0300	Carousel Small	Image: Small(360*336) 총합 1MB Title: 카드 별 최대 30자 Text: 총합 1,300자 Card: 3장 Button: 카드 별 2개(최대 5자)
RCS MMS CAROUSEL	CMwShS0400	Carousel Small	Image: Small(360*336) 총합 1MB Title: 카드 별 최대 30자 Text: 총합 1,300자 Card: 4장 Button: 카드 별 2개(최대 5자)
RCS MMS CAROUSEL	CMwShS0500	Carousel Small	Image: Small(360*336) 총합 1MB Title: 카드 별 최대 30자 Text: 총합 1,300자 Card: 5장 Button: 카드 별 2개(최대 5자)
RCS MMS CAROUSEL	CMwShS0600	Carousel Small	Image: Small(360*336) 총합 1MB Title: 카드 별 최대 30자 Text: 총합 1,300자 Card: 6장 Button: 카드 별 2개(최대 5자)
RCS MMS 이미지&타이틀 강조형	OMHITV0001	이미지&타이틀 강조형 3:4 Long	Image: 900*1200 Title: 최대 30자 Text: N/A Card: 1장 Button: 카드 별 2개(최대 16자) sub정보: 최대 1개
RCS MMS 이미지&타이틀 강조형	OMHITS0001	이미지&타이틀 강조형 1:1 Square	Image: 900*900 Title: 최대 30자 Text: N/A Card: 1장 Button: 카드 별 2개(최대 16자) sub정보: 최대 1개
RCS MMS 이미지 강조형	OMHIMV0001	이미지 강조형 3:4 Long	Image: 900*1200 Title: 최대 30자 Text: N/A Card: 1장 Button: 카드 별 2개(최대 16자) sub정보: N/A
RCS MMS 이미지 강조형	OMHIMS0001	이미지강조형 1:1 Square	Image: 900*900 Title: 최대 30자 Text: N/A Card: 1장 Button: 카드 별 2개(최대 16자) sub정보: N/A
RCS MMS 썸네일형	OMTBNV0001	썸네일형 세로	Image: 900*560 Title: 최대 30자 Text: 150자 Card: 1장 Button: 카드 별 2개(최대 16자) sub정보: 최대 2개
RCS MMS 썸네일형	OMTBNH0001	썸네일형 가로	Image: 900*560 Title: 최대 30자 Text: 150자 Card: 1장 Button: 카드 별 2개(최대 16자) sub정보: 최대 3개
RCS MMS SNS형	OMSNSS0001	SNS형	Image: 900*900 Title: 최대 30자 Text: 150자 Card: 1장 Button: 카드 별 2개(최대 16자) sub정보: N/A
RCS MMS SNS형	OMSNSH0001	SNS형 중간버튼	Image: 900*900 Title: 최대 30자 Text: 150자 Card: 1장 Button: 카드 별 2개(최대 16자) sub정보: N/A
FREE TEMPLATE (타이틀 자유형/선택형)	발급 된 Template ID	Free	Image: none Title: none Text: 최대 90자 Card: 1장 Button: 1개
DESCRIPTION TEMPLATE (타이틀 자유형/선택형)	발급 된 Template ID	Description	Image: none Title: 최대 8자 Text: 최대 90자 Card: 1장 Button: 2개
CELL TEMPLATE (타이틀 자유형/선택형)	발급 된 Template ID	Cell	Image: none Title: 최대 8자 Text: 최대 90자 Card: 1장 Button: 0~2개
IMAGE TEMPLATE (이미지&타이틀 강조형, 이미지 강조형, 썸네일형, SNS형)	발급 된 Template ID	Image	Image: 900*1200 또는900*900 또는 900*560, 상세Image: 300*300 Title: 최대 30자 Text: 최대 150자 상세Text: 최대 33자 Card: 1장 Button: 2개

RCS button

9가지 형태의 버튼을 제공하며 각 버튼에 맞는 옵션 값 입력이 필요합니다.

Button	Type	Description
URL 연결	Name Type Description type String 버튼 종류(URL) name String 버튼 명 url String 웹브라우저로 연결할 URL주소	Web page 또는 App으로 이동할 수 있습니다.
지도 보여주기	Name Type Description type String 버튼 종류(MAP_LOC) name String 버튼 명 label String 지도 App에 표시될 라벨명 latitude String 위도 값(예)37.4001971 longitude String 경도 값 (예)127.1071718 fallbackUrl String 지도 App동작이 안 될 경우 대처할 URL	지정된 좌표로 설정된 지도 App을 실행합니다.
지도 검색	Name Type Description type String 버튼 종류(MAP_QRY) name String 버튼 명 query String 지도 App에서 검색할 구문 fallbackUrl String 지도 App동작이 안 될 경우 대처할 URL	검색어를 통해 조회된 지도 App을 실행합니다.
위치 전송	Name Type Description type String 버튼 종류(MAP_SEND) name String 버튼 명	휴대폰의 현재 위치 정보를 전송합니다.
일정 등록	Name Type Description type String 버튼 종류(CALENDAR) name String 버튼 명 startTime String 시작 일정(yyyy-MM-dd’T’HH:mm:ssXXX) endTime String 종료 일정(yyyy-MM-dd’T’HH:mm:ssXXX) title String 일정 제목 description String 일정 내용	정해진 일자와 내용으로 일정을 등록합니다.
복사하기	Name Type Description type String 버튼 종류(COPY) name String 버튼 명 text String 클립보드로 복사될 내용	지정된 내용을 클립보드로 복사합니다.
대화방 열기 (문자)	Name Type Description type String 버튼 종류(COM_T) name String 버튼 명 phoneNumber String 대화방의 수신자 번호 text String 내용	메시지 App을 실행합니다.
대화방 열기 (음성, 영상)	Name Type Description type String 버튼 종류(COM_V) name String 버튼 명 phoneNumber String 대화방의 수신자 번호	메시지 App을 실행합니다.
전화 연결	Name Type Description type String 버튼 종류(DIAL) name String 버튼 명 phoneNumber String 전화 연결 할 수신자 번호	특정 전화번호로 전화를 걸 수 있습니다.

fallback

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