RCS message

RCS message is the channel API that supports rich messages with buttons, cards, and images.

Send a unified RCS message

POST/api/comm/v1/send/omni

Try sending a message Try it in the Sandbox

Unified RCS is a send method that supports both iOS and Android. Unless you are maintaining an existing integration, review the difference between unified RCS and Android RCS and prefer unified RCS.

Body Parameters

{}JSON

destinations

RequiredObject Array

The array of recipient information. Up to 200 per broadcast send.

RequiredString

The recipient number.

replaceWords

Object

Variable substitution variables (JSON).

ref

String

A per-message reference field.

messageFlow

RequiredObject Array

When you add messages, they are handled in order as automatic failover messages.

rcs

RequiredObject

The unified RCS message object.

body

RequiredObject

The RCS message body object.

buttons

Object Array

The list of RCS buttons.

suggestions

Object Array

The list of button action definitions.

action

Object

The button action object.

urlAction

Object

Opens a web link.

openUrl

RequiredObject

The web link object.

dialerAction

Object

Places a call.

dialPhoneNumber

RequiredObject

The call object.

mapAction

Object

Map search, map display, and location share.

showLocation

RequiredObject

The map location display object.

location

RequiredObject

The map location.

fallbackUrl

String

The fallback URL used when the location lookup fails.

requestLocationPush

Object

The location share request object.

calendarAction

Object

Registers a calendar event.

createCalendarEvent

RequiredObject

The calendar event object.

composeAction

Object

Text/video and call.

composeTextMessage

RequiredObject

The send-text object.

text

String

The SMS/LMS/MMS message content.

composeRecordingMessage

Object

The send video/voice object.

formatId

RequiredString

The RCS message format ID.

expiryOption

String

The send timeout setting.

agencyId

String

The agency ID.

ttl

String

The message time-to-live in seconds.

paymentCode

String

The department code used for settlement.

groupKey

String

A key you set to group messages and review their statistics in Message Insight.

idempotencyKey

String

The idempotency key field that identifies the request for idempotency.

idempotencyTtl

Integer

The validity period of the idempotency key.

ref

String

A per-request reference field.

Returns

common

Object

The common response section.

authCode

String

The authentication result code.

authResult

String

The authentication result message.

data

Object

The service response section.

data

Object

The actual message response data.

destinations

Object Array

The array of per-recipient results.

code

String

The per-recipient result code.

ref

String

The reference value passed with the request.

Request example

curl -X POST "/api/comm/v1/send/omni" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "destinations": [{ "to": "01012345678" }],
    "messageFlow": [{
      "rcs": {
        "from": "{senderNumber}",
        "formatId": "RCS_FORMAT_ID",
        "brandKey": "RCS_BRAND_KEY",
        "body": {
          "title": "통합 RCS 안내",
          "description": "통합 RCS 본문입니다."
        }
      }
    }],
    "ref": "rcs-unified-20260331-001"
  }'

Response example

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "SUCCESS",
    "data": {
      "destinations": [{
        "to": "01012345678",
        "msgKey": "20260424104234546POM101182450000",
        "code": "A000",
        "result": "Success"
      }]
    },
    "ref": "rcs-unified-20260331-001"
  }
}

Registers a unified RCS message to be sent at the specified time. The detailed fields you can send are the same as in the unified RCS send specification. After registering, see the Reservation management page for lookup, update, cancel, pause, resume, and recipient management.

Body Parameters

{}JSON

destinations

RequiredObject Array

The array of recipient information. Up to 200 per broadcast send.

RequiredString

The recipient number.

ref

String

A per-message reference field.

messageFlow

RequiredObject Array

When you add messages, they are handled in order as automatic failover messages.

rcs

RequiredObject

The unified RCS message object.

body

RequiredObject

The RCS message body object.

buttons

Object Array

The list of RCS buttons.

suggestions

Object Array

The list of button action definitions.

action

Object

The button action object.

urlAction

Object

Opens a web link.

openUrl

RequiredObject

The web link object.

dialerAction

Object

Places a call.

dialPhoneNumber

RequiredObject

The call object.

mapAction

Object

Map search, map display, and location share.

showLocation

RequiredObject

The map location display object.

location

RequiredObject

The map location.

fallbackUrl

String

The fallback URL used when the location lookup fails.

requestLocationPush

Object

The location share request object.

calendarAction

Object

Registers a calendar event.

createCalendarEvent

RequiredObject

The calendar event object.

composeAction

Object

Text/video and call.

composeTextMessage

RequiredObject

The send-text object.

text

String

The SMS/LMS/MMS message content.

composeRecordingMessage

Object

The send video/voice object.

formatId

RequiredString

The RCS message format ID.

expiryOption

String

The send timeout setting.

agencyId

String

The agency ID.

ttl

String

The message time-to-live in seconds.

resvSendTime

RequiredString

The reservation send time.

resvName

String

A name that identifies the reservation.

ref

String

A per-request reference field.

Returns

common

Object

The common response section.

authCode

String

The authentication result code.

authResult

String

The authentication result message.

data

Object

The reservation registration response section.

code

String

The reservation registration result code.

result

String

The reservation registration result message.

Request example

curl -X POST "https://mars.ibapi.kr/api/comm/v1/reservation" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "destinations": [{
      "to": "01000000000"
    }],
    "messageFlow": [{
      "rcs": {
        "from": "{senderNumber}",
        "formatId": "RCS_FORMAT_ID",
        "brandKey": "RCS_BRAND_KEY",
        "body": {
          "title": "통합 RCS 예약 안내",
          "description": "지정한 시각에 발송되는 통합 RCS 메시지입니다."
        },
        "expiryOption": "1"
      }
    }],
    "resvSendTime": "2026-05-01 10:00:00",
    "resvName": "통합 RCS 예약 발송",
    "ref": "rcs-resv-20260501-001"
  }'

Response example

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "resvKey": "20260501100000RESV0000000001"
  }
}

Send an Android RCS message

POST/api/comm/v1/send/omni

Try it in the Sandbox

Use Android RCS when you need to keep an existing Android Chat+ integration. Before starting a new integration, first review the difference between unified RCS and Android RCS.

Body Parameters

{}JSON

destinations

RequiredObject Array

The array of recipient information. Up to 200 per broadcast send.

RequiredString

The recipient number.

replaceWords

Object

Variable substitution variables (JSON).

ref

String

A per-message reference field.

messageFlow

RequiredObject Array

When you add messages, they are handled in order as automatic failover messages.

rcs

RequiredObject

The Android RCS message object.

body

RequiredObject

The RCS message body object.

buttons

Object Array

The list of RCS buttons.

suggestions

Object Array

The list of button action definitions.

action

Object

The button action object.

urlAction

Object

Opens a web link.

openUrl

RequiredObject

The web link object.

dialerAction

Object

Places a call.

dialPhoneNumber

RequiredObject

The call object.

mapAction

Object

Map search, map display, and location share.

showLocation

RequiredObject

The map location display object.

location

RequiredObject

The map location.

fallbackUrl

String

The fallback URL used when the location lookup fails.

requestLocationPush

Object

The location share request object.

calendarAction

Object

Registers a calendar event.

createCalendarEvent

RequiredObject

The calendar event object.

composeAction

Object

Text/video and call.

composeTextMessage

RequiredObject

The send-text object.

text

String

The SMS/LMS/MMS message content.

composeRecordingMessage

Object

The send video/voice object.

formatId

RequiredString

The RCS message format template ID.

brandKey

RequiredString

The RCS brand identification key.

expiryOption

String

The send timeout setting.

copyAllowed

String

Whether copying the message is allowed.

header

String

Whether to show the advertising label.

footer

String

The opt-out number.

agencyId

String

The agency ID.

ttl

String

The message time-to-live in seconds.

paymentCode

String

The department code used for settlement.

groupKey

String

A key you set to group messages and review their statistics in Message Insight.

idempotencyKey

String

The idempotency key field that identifies the request for idempotency.

idempotencyTtl

Integer

The validity period of the idempotency key.

ref

String

A per-request reference field.

Returns

common

Object

The common response section.

authCode

String

The authentication result code.

authResult

String

The authentication result message.

data

Object

The service response section.

data

Object

The actual message response data.

destinations

Object Array

The array of per-recipient results.

code

String

The per-recipient result code.

ref

String

The reference value passed with the request.

Request example

curl -X POST "/api/comm/v1/send/omni" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "destinations": [{ "to": "01012345678" }],
    "messageFlow": [{
      "rcs": {
        "from": "{senderNumber}",
        "formatId": "RCS_FORMAT_ID",
        "brandKey": "RCS_BRAND_KEY",
        "body": {
          "title": "RCS 안내",
          "description": "안드로이드 RCS 메시지입니다."
        }
      }
    }],
    "ref": "rcs-android-20260331-001"
  }'

Response example

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "SUCCESS",
    "data": {
      "destinations": [{
        "to": "01012345678",
        "msgKey": "20260424104234546POM101182450000",
        "code": "A000",
        "result": "Success"
      }]
    },
    "ref": "rcs-android-20260331-001"
  }
}

Upload an image

POST/api/comm/v1/file/rcs

Try it in the Sandbox

Upload the image before sending the RCS message, then put the issued media value in messageFlow[].rcs.body.media.

Body Parameters

FORM-DATA

file

RequiredBinary

The RCS image file to upload.

Returns

common

Object

The common response section.

data

Object

The service response section.

data

Object

The actual upload response data.

media

String

The media key to put in the RCS message body (body.media).

Request example

curl -X POST "https://mars.ibapi.kr/api/comm/v1/file/rcs" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@/path/to/rcs-image.jpg"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "media":"maapfile://clientId_c70626a6917a452a8faec8509e93065e",
      "expired":"2027-04-24T12:16:38+09:00"
    }
  }
}

Manage brands

Look up brand details

GET/api/comm/v1/center/rcs/brand

Try it in the Sandbox

Looks up RCS brand details by brandId.

Query Parameters

brandId

RequiredString

The brand ID to look up.

Returns

common

Object

The common response section.

data

Object

The API result section.

data

Object

The actual response data.

rcs

Object

The RCS brand response information.

mediaUrl

Object Array

The image file ID, URL, and usage type.

typeName

String

Distinguishes how the image is used.

menus

Object Array

The menu.

Request example

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/rcs/brand?brandId={brandId}" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "brandId":"{brandId}",
        "name":"{name}",
        "brandKey":"{brandKey}",
        "status":"ready"
      }
    }
  }
}

Update a brand

PUT/api/comm/v1/center/rcs/brand

Try it in the Sandbox

Updates the brand's basic information and images.

Body Parameters

FORM-DATA

brandId

RequiredString

The brand ID to update.

regBrand

RequiredObject

The brand update information.

brandId

RequiredString

The brand ID.

name

RequiredString

The brand name.

brandKey

String(200)

The brand key.

registerDate

String(30)

The registration time.

approvalDate

String

The approval time.

updateDate

String

The update time.

status

String(1300)

The brand status.

mediaUrl

Object Array

The image file ID, URL, and usage type.

fileId

String

The file ID.

url

String

The file URL.

typeName

String

Distinguishes how the image is used.

fileName

String

The name of the registered file.

chatbotDate

String

The time the most recently changed chat room under the brand was updated.

logoDate

String

The time the most recently changed logo image was updated.

messagebaseDate

String

The time the most recently changed template under the brand was updated.

description

String

The content registered in the brand description.

tel

String

The phone number shown on the brand home.

menus

Object Array

The menu.

buttonType

String

The button type.

applink

String

The app link.

weblink

String

The web link.

categoryId

Object

The brand category ID.

categoryName

Object Array

The brand category name.

subCategoryId

Object

The brand subcategory ID.

subCategoryName

Object

The brand subcategory name.

categoryOpt

Object

The search keywords.

zipCode

Object Array

The postal code shown on the brand home.

roadAddress

String

The street address shown on the brand home.

detailAddress

String

The detailed address shown on the brand home.

String

The email address shown on the brand home.

webSiteUrl

String

The website address shown on the brand home.

approvalReason

String

The rejection reason from the review.

brandFeedUrl

String

The brand news URL.

initTab

String

Specifies the default tab of the brand home shown on the device.

initFeedItems

String

Specifies the menu shown on the news tab when initTab is FEED.

templateColor

String

The button color used by templates registered under the brand.

bizInfoYn

String

Sets whether operational information is shown on the brand news tab.

bizInfoTitle

String

Specifies the operational information title when bizInfoYn is Y.

bizInfoContent

String

Specifies the operational information content when bizInfoYn is Y.

saftyStatusYn

String

Whether the company is designated with the trust mark.

brandProfile

Binary

The brand profile image file.

brandBackground

Binary

The brand background image file.

seasonDocFile

Binary

The seasonal supporting document file.

Returns

common

Object

The common response section.

data

Object

The API result section.

data

Object

The actual response data.

rcs

Object

The RCS brand response information.

mediaUrl

Object Array

The image file ID, URL, and usage type.

typeName

String

Distinguishes how the image is used.

menus

Object Array

The menu.

Request example

curl -X PUT "https://mars.ibapi.kr/api/comm/v1/center/rcs/brand" \
  -H "Authorization: {ApiKey}" \
  -F "brandId={brandId}" \
  -F 'regBrand={
    "name": "비즈고",
    "description": "브랜드 소개 문구",
    "tel": "0212345678",
    "webSiteUrl": "https://www.example.com"
  }' \
  -F "brandProfile=@brand-profile.png"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "brandId":"{brandId}",
        "name":"{name}",
        "brandKey":"{brandKey}",
        "status":"ready"
      }
    }
  }
}

Manage chatrooms

A chatroom (chatbot) belongs to a brand and is the unit that actually exchanges messages. Use these APIs to look up and update the chatroom information under a brand, or to cancel an approval request and delete it.

Look up the chatroom list

GET/api/comm/v1/center/rcs/chatbot/list

Try it in the Sandbox

Looks up the RCS chat rooms registered under a brand ID.

Query Parameters

brandId

RequiredString

The brand ID to look up.

offset

Integer

The lookup start offset.

limit

Integer

The maximum number of records to look up.

Returns

common

Object

The common response section.

data

Object

The product response section.

data

Object

The processing result data.

rcs

Object

The RCS response section.

chatbot

Object Array

The array of chat room information.

isMainNum

String

Whether it is the representative number.

psMenuUse

String

Whether the persistent menu is used.

mediaUrl

Object

The chat room image file ID, URL, and usage type.

Request example

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/rcs/chatbot/list?brandId={brandId}&offset=0&limit=1000" \
  -H "Content-Type: application/json" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "chatbot": [
          {
            "chatbotId":"{chatbotId}",
            "brandId":"{brandId}",
            "mdn":"0212345678",
            "subTitle":"고객센터 대화방",
            "status":"ready",
            "approvalResult":"approved",
            "registerDate":"2026-07-21 10:00:00"
          },
          {
            "chatbotId":"{chatbotId2}",
            "brandId":"{brandId}",
            "mdn":"0287654321",
            "subTitle":"주문 안내 대화방",
            "status":"ready",
            "approvalResult":"approved",
            "registerDate":"2026-07-20 09:00:00"
          }
        ]
      }
    }
  }
}

Look up chatroom details

GET/api/comm/v1/center/rcs/chatbot

Try it in the Sandbox

Looks up RCS chat room details by brand ID and chat room ID.

Query Parameters

brandId

RequiredString

The brand ID to look up.

chatbotId

RequiredString

The chat room ID to look up.

Returns

common

Object

The common response section.

data

Object

The product response section.

data

Object

The processing result data.

rcs

Object

The RCS response section.

chatbot

Object Array

The array of chat room information.

isMainNum

String

Whether it is the representative number.

psMenuUse

String

Whether the persistent menu is used.

mediaUrl

Object

The chat room image file ID, URL, and usage type.

Request example

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/rcs/chatbot?brandId={brandId}&chatbotId={chatbotId}" \
  -H "Content-Type: application/json" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "chatbot": [
          {
            "chatbotId":"{chatbotId}",
            "brandId":"{brandId}",
            "mdn":"0212345678",
            "subTitle":"고객센터 대화방",
            "status":"ready",
            "approvalResult":"approved",
            "registerDate":"2026-07-21 10:00:00"
          }
        ]
      }
    }
  }
}

Update a chatroom

PUT/api/comm/v1/center/rcs/chatbot

Try it in the Sandbox

Updates a registered RCS chat room. Send the chat room information as a JSON string and the additional-number proof document as a file.

Body Parameters

brandId

RequiredString

The ID of the brand the chat room to update belongs to.

chatbot

RequiredString

A JSON string containing the chat room information to update.

chatbotId

String

The chat room ID.

brandId

String

The ID of the brand the chat room belongs to.

groupId

String

The ID of the group the chat room belongs to.

mdn

String

The sender number linked to the chat room.

subNum

String

The additional number linked to the chat room.

isMainNum

String

Whether it is the representative number.

subTitle

String

The chat room subtitle.

subDescr

String

The additional chat room description.

service

String

The service classification value of the chat room.

display

String

The chat room visibility setting.

inputField

Integer

The setting for the chat room input field.

botAgencyId

String

The ID of the agency that registered the chat room.

saftyStatusYn

String

Whether the company is designated with the trust mark.

psMenuUse

String

Whether the persistent menu is used.

persistentMenu

Object

The persistent menu configuration of the chat room.

rcsReply

String

The chat room response setting.

webhook

String

The webhook URL that receives chat room events.

searchWeight

String

The chat room search weight.

botTcPage

String

The URL of the chat room terms of service page.

mediaUrl

Object

The chat room image file ID, URL, and usage type.

status

String

The chat room status.

approvalResult

String

The chat room approval result.

approvalReason

String

The rejection reason from the review.

approvalDate

String

The approval time.

registerDate

String

The registration time.

registerId

String

The ID of the registrant.

updateDate

String

The update time.

updateId

String

The ID of the last editor.

subNumCertificate

RequiredBinary

The document file that proves use of the additional number.

Returns

common

Object

The common response section.

data

Object

The product response section.

data

Object

The processing result data.

rcs

Object

The RCS response section.

chatbot

Object Array

The array of chat room information.

isMainNum

String

Whether it is the representative number.

psMenuUse

String

Whether the persistent menu is used.

mediaUrl

Object

The chat room image file ID, URL, and usage type.

Request example

curl -X PUT "https://mars.ibapi.kr/api/comm/v1/center/rcs/chatbot" \
  -H "Authorization: {ApiKey}" \
  -F "brandId={brandId}" \
  -F 'chatbot={
    "chatbotId": "{chatbotId}",
    "subTitle": "고객센터 대화방",
    "subDescr": "주문/배송 문의 대화방입니다",
    "webhook": "https://example.com/rcs/webhook"
  }' \
  -F "subNumCertificate=@/path/sub-num-certificate.pdf"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "chatbot": [
          {
            "chatbotId":"{chatbotId}",
            "brandId":"{brandId}",
            "mdn":"0212345678",
            "subTitle":"고객센터 대화방",
            "status":"ready",
            "approvalResult":"approved",
            "registerDate":"2026-07-21 10:00:00"
          }
        ]
      }
    }
  }
}

Cancel chatroom approval

PUT/api/comm/v1/center/rcs/brandId/{brandId}/chatbotId/{chatbotId}/cancel

Try it in the Sandbox

Cancels the approval request for an RCS chat room under review.

Path Parameters

brandId

RequiredString

The brand ID.

chatbotId

RequiredString

The chat room ID.

Returns

common

Object

The common response section.

data

Object

The product response section.

data

Object

The processing result data.

rcs

Object

The RCS response section.

chatbot

Object Array

The array of chat room information.

isMainNum

String

Whether it is the representative number.

psMenuUse

String

Whether the persistent menu is used.

mediaUrl

Object

The chat room image file ID, URL, and usage type.

Request example

curl -X PUT "https://mars.ibapi.kr/api/comm/v1/center/rcs/brandId/{brandId}/chatbotId/{chatbotId}/cancel" \
  -H "Content-Type: application/json" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "chatbot": [
          {
            "chatbotId":"{chatbotId}",
            "brandId":"{brandId}",
            "mdn":"0212345678",
            "subTitle":"고객센터 대화방",
            "status":"ready",
            "approvalResult":"approved",
            "registerDate":"2026-07-21 10:00:00"
          }
        ]
      }
    }
  }
}

Delete a chatroom

DELETE/api/comm/v1/center/rcs/brandId/{brandId}/chatbotId/{chatbotId}

Try it in the Sandbox

Deletes a registered RCS chat room.

Path Parameters

brandId

RequiredString

The brand ID.

chatbotId

RequiredString

The chat room ID.

Returns

common

Object

The common response section.

data

Object

The product response section.

data

Object

The processing result data.

rcs

Object

The RCS response section.

chatbot

Object Array

The array of chat room information.

isMainNum

String

Whether it is the representative number.

psMenuUse

String

Whether the persistent menu is used.

mediaUrl

Object

The chat room image file ID, URL, and usage type.

Request example

curl -X DELETE "https://mars.ibapi.kr/api/comm/v1/center/rcs/brandId/{brandId}/chatbotId/{chatbotId}" \
  -H "Content-Type: application/json" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "chatbot": [
          {
            "chatbotId":"{chatbotId}",
            "brandId":"{brandId}",
            "mdn":"0212345678",
            "subTitle":"고객센터 대화방",
            "status":"ready",
            "approvalResult":"approved",
            "registerDate":"2026-07-21 10:00:00"
          }
        ]
      }
    }
  }
}

Look up the available queries

GET/api/comm/v1/center/rcs/usableQuery/chatbotId/{chatbotId}

Try it in the Sandbox

Looks up the queries available for a chat room by its chat room ID.

Path Parameters

chatbotId

RequiredString

The chat room ID.

Returns

common

Object

The common response section.

data

Object

The product response section.

data

Object

The processing result data.

rcs

Object

The RCS response section.

chatbot

Object Array

The array of chat room information.

isMainNum

String

Whether it is the representative number.

psMenuUse

String

Whether the persistent menu is used.

mediaUrl

Object

The chat room image file ID, URL, and usage type.

Request example

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/rcs/usableQuery/chatbotId/{chatbotId}" \
  -H "Content-Type: application/json" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "chatbot": [
          {
            "chatbotId":"{chatbotId}",
            "brandId":"{brandId}",
            "mdn":"0212345678",
            "subTitle":"고객센터 대화방",
            "status":"ready",
            "approvalResult":"approved",
            "registerDate":"2026-07-21 10:00:00"
          }
        ]
      }
    }
  }
}

Manage common formats

Look up common formats

GET/api/comm/v1/center/rcs/messagebase/common/list

Try it in the Sandbox

Looks up the common formats available for RCS.

Returns

common

Object

The common response section.

data

Object

The product response section.

data

Object

The processing result data.

rcs

Object

The RCS response information.

pagination

Object

The total count and paging conditions.

messageForms

Object Array

The list of common formats.

Request example

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/rcs/messagebase/common/list" \
  -H "Content-Type: application/json" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "messageForms": [
          {
            "messagebaseformId":"RPISMTX002",
            "formName":"모바일 상품권 전송 T",
            "bizCondition": [],
            "cardType":"standalone media top",
            "registerDate":"2026-02-05T17:59:20",
            "updateDate":"2026-02-05T18:37:56"
          }
        ]
      }
    }
  }
}

Look up common format details

GET/api/comm/v1/center/rcs/messagebase/common

Try it in the Sandbox

Looks up RCS common format details by message base ID.

Query Parameters

messagebaseId

RequiredString

The message base ID to look up.

Returns

common

Object

The common response section.

data

Object

The product response section.

data

Object

The processing result data.

rcs

Object

The RCS response information.

messageForm

Object

The common format details.

body

Object Array

The body definition.

param

String

The validation parameter name.

buttons

Object

The button definition.

policyInfo

Object

The validation policy for the content included in rich cards and open rich cards.

Request example

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/rcs/messagebase/common?messagebaseId={messagebaseId}" \
  -H "Content-Type: application/json" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "messageForm": {
          "formatId":"RPTDXXX001",
          "templateName":"통합 정보형 템플릿",
          "body": [],
          "buttons": {
            "suggestions": []
          },
          "policyInfo": {
            "buttonsAllowed": true,
            "maxButtonCount": 2
          }
        }
      }
    }
  }
}

Manage templates

Look up the template form list

GET/api/comm/v1/center/rcs/messagebase/messagebaseform/list

Try it in the Sandbox

Looks up the template forms available for registering an RCS template.

Query Parameters

offset

Integer

The lookup start offset.

limit

Integer

The maximum number of records to look up.

Returns

common

Object

The common response section.

data

Object

The product response section.

data

Object

The processing result data.

rcs

Object

The RCS response information.

pagination

Object

The total count and paging conditions.

messageForms

Object Array

The list of template forms.

Request example

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/rcs/messagebase/messagebaseform/list?offset=0&limit=100" \
  -H "Content-Type: application/json" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "messageForms": [
          {
            "messagebaseformId":"RPISMTX002",
            "formName":"모바일 상품권 전송 T",
            "bizCondition": [],
            "cardType":"standalone media top"
          }
        ]
      }
    }
  }
}

Look up template form details

GET/api/comm/v1/center/rcs/messagebase/messagebaseform

Try it in the Sandbox

Looks up template form details by template form ID.

Query Parameters

messagebaseformId

RequiredString

The message form ID.

Returns

common

Object

The common response section.

data

Object

The product response section.

data

Object

The processing result data.

rcs

Object

The RCS response information.

messageForm

Object

The template form details.

policyInfo

Object

The validation policy for the content included in rich cards and open rich cards.

Request example

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/rcs/messagebase/messagebaseform?messagebaseformId={messagebaseformId}" \
  -H "Content-Type: application/json" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "messageForm": {
          "formatId":"RPTDXXX001",
          "templateName":"통합 정보형 템플릿",
          "body": [],
          "buttons": []
        }
      }
    }
  }
}

Look up the template list

GET/api/comm/v1/center/rcs/messagebase/list

Try it in the Sandbox

Looks up the RCS templates registered under a brand ID.

Returns

common

Object

The common response section.

data

Object

The product response section.

data

Object

The processing result data.

rcs

Object

The RCS response information.

pagination

Object

The total count and paging conditions.

templates

Object Array

The list of templates.

messagebaseId

String

The message base ID.

status

String

Shows the template status.

Request example

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/rcs/messagebase/list" \
  -H "Content-Type: application/json" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "templates": [
          {
            "messagebaseId":"{messagebaseId}",
            "formatId":"RPTDXXX001",
            "templateName":"통합 정보형 템플릿",
            "status":"ready",
            "approvalResult":"approved"
          }
        ]
      }
    }
  }
}

Look up template details

GET/api/comm/v1/center/rcs/messagebase

Try it in the Sandbox

Looks up registered RCS template details by message base ID.

Query Parameters

messagebaseId

RequiredString

The message base ID.

Returns

common

Object

The common response section.

data

Object

The product response section.

data

Object

The processing result data.

rcs

Object

The RCS response information.

body

Object

The body area definition.

formatId

String

The template form ID.

Request example

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/rcs/messagebase?messagebaseId={messagebaseId}" \
  -H "Content-Type: application/json" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "status":"ready",
        "approvalResult":"승인",
        "approvalReason":"승인완료",
        "registerDate":"2026-04-08T10:00:00",
        "approvalDate":"2026-04-08T11:00:00",
        "updateDate":"2026-04-08T11:00:00",
        "registerId":"example_id",
        "updateId":"example_id",
        "productCode":"lms",
        "spec":"openrichcard",
        "cardType":"descriptionNew",
        "body": {
          "description":"#{이름}님, 안녕하세요.\n신청하신 내용을 안내드립니다.\n\n◼︎항목: #{항목명}\n◼︎일시: #{일시}\n\n자세한 내용은 아래에서 확인해 주세요.\nhttps://example.com/#{URL}\n\n본 메시지는 신청자에게 전달되는 정보성 메시지입니다.",
          "mTitle":"안내 메시지",
          "title":"안내 메시지"
        },
        "brandKey":"BK.EXAMPLE0000000000",
        "formatId":"LBR.EXAMPLE0000000000000000000000000000"
      }
    }
  }
}

Register a template

POST/api/comm/v1/center/rcs/messagebase

Try it in the Sandbox

Registers an RCS template for the brand.

Body Parameters

rcs

RequiredObject

The RCS template request information.

body

RequiredObject Array

The body area definition.

param

RequiredString

The validation parameter name.

buttons

RequiredObject Array

The button definition.

suggestions

Object Array

The list of button actions.

action

Object

The button action object.

clipboardAction

Object

The copy-to-clipboard action.

copyToClipboard

RequiredObject

The copy-to-clipboard object.

urlAction

Object

The open-web-link action.

openUrl

RequiredObject

The open-web-link object.

dialerAction

Object

The call action.

dialPhoneNumber

RequiredObject

The call object.

mapAction

Object

The map action.

showLocation

Object

The map location display object.

location

RequiredObject

The map location information.

calendarAction

Object

The calendar event action.

createCalendarEvent

RequiredObject

The calendar event object.

composeAction

Object

The text, voice, and video action.

composeTextMessage

Object

The send-text object.

composeRecordingMessage

Object

The send voice/video object.

type

RequiredString

The VIDEO or AUDIO type.

Returns

common

Object

The common response section.

data

Object

The product response section.

data

Object

The processing result data.

rcs

Object

The RCS response information.

messagebaseId

String

The registered message base ID.

Request example

curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/rcs/messagebase" \
  -H "Content-Type: application/json" \
  -H "Authorization: {ApiKey}" \
  -d '{
  "rcs": {
    "brandId": "{brandId}",
    "templateName": "발송 안내 템플릿",
    "body": [],
    "buttons": []
  }
}'

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "messagebaseId":"{messagebaseId}"
      }
    }
  }
}

Update a template

PUT/api/comm/v1/center/rcs/messagebase

Try it in the Sandbox

Updates a registered RCS template.

Body Parameters

rcs

RequiredObject

The RCS template request information.

body

RequiredObject Array

The body area definition.

param

RequiredString

The validation parameter name.

buttons

RequiredObject Array

The button definition.

suggestions

Object Array

The list of button actions.

action

Object

The button action object.

clipboardAction

Object

The copy-to-clipboard action.

copyToClipboard

RequiredObject

The copy-to-clipboard object.

urlAction

Object

The open-web-link action.

openUrl

RequiredObject

The open-web-link object.

dialerAction

Object

The call action.

dialPhoneNumber

RequiredObject

The call object.

mapAction

Object

The map action.

showLocation

Object

The map location display object.

location

RequiredObject

The map location information.

calendarAction

Object

The calendar event action.

createCalendarEvent

RequiredObject

The calendar event object.

composeAction

Object

The text, voice, and video action.

composeTextMessage

Object

The send-text object.

composeRecordingMessage

Object

The send voice/video object.

type

RequiredString

The VIDEO or AUDIO type.

Returns

common

Object

The common response section.

data

Object

The product response section.

data

Object

The processing result data.

rcs

Object

The RCS response information.

messagebaseId

String

The updated message base ID.

Request example

curl -X PUT "https://mars.ibapi.kr/api/comm/v1/center/rcs/messagebase" \
  -H "Content-Type: application/json" \
  -H "Authorization: {ApiKey}" \
  -d '{
  "rcs": {
    "brandId": "{brandId}",
    "templateName": "발송 안내 템플릿",
    "body": [],
    "buttons": []
  }
}'

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "messagebaseId":"{messagebaseId}"
      }
    }
  }
}

Cancel template approval

PUT/api/comm/v1/center/rcs/brandId/{brandId}/messagebaseId/{messagebaseId}/cancel

Try it in the Sandbox

Cancels the approval request for an RCS template under review.

Path Parameters

brandId

RequiredString

The brand ID.

messagebaseId

RequiredString

The message base ID.

Returns

common

Object

The common response section.

data

Object

The product response section.

data

Object

The processing result data.

rcs

Object

The RCS response information.

messagebaseId

String

The message base ID whose approval was canceled.

Request example

curl -X PUT "https://mars.ibapi.kr/api/comm/v1/center/rcs/brandId/{brandId}/messagebaseId/{messagebaseId}/cancel" \
  -H "Content-Type: application/json" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "messagebaseId":"{messagebaseId}"
      }
    }
  }
}

Delete a template

DELETE/api/comm/v1/center/rcs/brandId/{brandId}/messagebaseId/{messagebaseId}

Try it in the Sandbox

Deletes a registered RCS template.

Path Parameters

brandId

RequiredString

The brand ID.

messagebaseId

RequiredString

The message base ID.

Returns

common

Object

The common response section.

data

Object

The product response section.

data

Object

The processing result data.

rcs

Object

The RCS response information.

messagebaseId

String

The deleted message base ID.

Request example

curl -X DELETE "https://mars.ibapi.kr/api/comm/v1/center/rcs/brandId/{brandId}/messagebaseId/{messagebaseId}" \
  -H "Content-Type: application/json" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "messagebaseId":"{messagebaseId}"
      }
    }
  }
}

Manage template images

Register a template image

POST/api/comm/v1/center/rcs/messagebase/file

Try it in the Sandbox

Uploads an image for registering an RCS template and issues a template file ID.

Body Parameters

FORM-DATA

brandId

RequiredString

The brand ID.

file

RequiredBinary

The binary of the image file used to register the template.

Returns

common

Object

The common response section.

data

Object

The product response section.

data

Object

The processing result data.

rcs

Object

The RCS response information.

image

Object

The template image information.

Request example

curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/rcs/messagebase/file" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: multipart/form-data" \
  -F "brandId={brandId}" \
  -F "file=@/path/to/template-image.jpg"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "image": {
          "fileId":"{fileId}",
          "fileName":"template-image.jpg",
          "imageWidth": 900,
          "imageHeight": 900
        }
      }
    }
  }
}

Look up template image details

GET/api/comm/v1/center/rcs/messagebase/file

Try it in the Sandbox

Looks up template image details by brand ID and template file ID.

Query Parameters

brandId

RequiredString

The brand ID.

fileId

RequiredString

The template file ID.

Returns

common

Object

The common response section.

data

Object

The product response section.

data

Object

The processing result data.

rcs

Object

The RCS response information.

image

Object

The template image information.

Request example

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/rcs/messagebase/file?brandId={brandId}&fileId={fileId}" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "image": {
          "fileId":"{fileId}",
          "fileName":"template-image.jpg",
          "imageWidth": 900,
          "imageHeight": 900
        }
      }
    }
  }
}

Look up template form logo images

GET/api/comm/v1/center/rcs/messagebase/messagebaseform/logo

Try it in the Sandbox

Looks up the logo images available for a template form by its template form ID.

Query Parameters

messagebaseformId

RequiredString

The message form ID.

Returns

common

Object

The common response section.

data

Object

The product response section.

data

Object

The processing result data.

rcs

Object

The RCS response information.

images

Object Array

The list of logo images for the template form.

Request example

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/rcs/messagebase/messagebaseform/logo?messagebaseformId={messagebaseformId}" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json"

Response example

{
  "common": {
    "authCode":"A000",
    "authResult":"Success",
    "infobankTrId":"header-value-X-Infobank-Tracking-Id"
  },
  "data": {
    "code":"A000",
    "result":"Success",
    "data": {
      "rcs": {
        "images": [
          {
            "fileId":"{fileId}",
            "fileName":"template-logo.png",
            "imageWidth": 900,
            "imageHeight": 900
          }
        ]
      }
    }
  }
}