Reservation management

Once a reservation is registered, you can look up its status, change the send time, and cancel, stop, or resume the reservation. You can find how to register a reservation in the send flow for each message channel.

Look up reservations

Look up the reservation list

GET/api/comm/v1/reservation/list

Looks up the list of reservations. resvSendTime is required, and you can look up by month, day, or time.

Query Parameters

resvSendTime

RequiredString

The reservation send time used for the lookup.

paymentCode

String

Filters the lookup by settlement code.

lastSeq

Long

The last sequence number used when looking up the next page.

limit

Integer

The number of records to look up.

Returns

common

Object

The common response section.

authCode

String

The authentication result code.

authResult

String

The authentication result message.

infobankTrId

String

The transaction tracing ID.

data

Object

The service response section.

code

String

The processing result code.

result

String

The processing result message.

data

Object

The reservation list response data.

lastSeq

Long

The lastSeq to use when looking up the next page. It is 0 when there are no results.

hasNext

Boolean

Whether a next page exists.

reservations

Object Array

The list of reservations.

seq

Long

The reservation sequence number. You can use it as the lastSeq reference in list lookups.

resvKey

String

The reservation key.

paymentCode

String

The settlement code.

resvName

String

The reservation name.

productType

String

The product type.

status

String

The reservation status.

adYn

String

Whether it is a promotional message.

resvSendTime

String

The reservation send time.

resvData

String

The reservation send request body. It may be omitted from update responses.

expectedCnt

Integer

The estimated number of sends.

sentCnt

Integer

The number processed for sending.

successCnt

Integer

The success count.

failCnt

Integer

The failure count.

updateDate

String

The update time.

regDate

String

The registration time.

Request example

curl -X GET "https://mars.ibapi.kr/api/comm/v1/reservation/list?resvSendTime=2026-05&limit=100" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "lastSeq": 100,
      "hasNext": false,
      "reservations": [
        {
          "seq": 100,
          "resvKey": "MO20260501100000abcdef",
          "paymentCode": "SMS07",
          "resvName": "금요일 캠페인",
          "productType": "MESSAGE",
          "status": "PENDING",
          "adYn": "N",
          "resvSendTime": "2026-05-01 10:00:00",
          "expectedCnt": 1000,
          "sentCnt": 0,
          "successCnt": 0,
          "failCnt": 0,
          "updateDate": "2026-04-30 12:34:56",
          "regDate": "2026-04-30 12:00:00"
        }
      ]
    }
  }
}

Look up reservation details

GET/api/comm/v1/reservation/resvKey/{resvKey}

Looks up a single reservation by its reservation key (resvKey).

Path Parameters

resvKey

RequiredString

The reservation key.

Returns

common

Object

The common response section.

authCode

String

The authentication result code.

authResult

String

The authentication result message.

infobankTrId

String

The transaction tracing ID.

data

Object

The service response section.

code

String

The processing result code.

result

String

The processing result message.

data

Object

The response data object.

seq

Long

The reservation sequence number. You can use it as the lastSeq reference in list lookups.

resvKey

String

The reservation key.

paymentCode

String

The settlement code.

resvName

String

The reservation name.

productType

String

The product type.

status

String

The reservation status.

adYn

String

Whether it is a promotional message.

resvSendTime

String

The reservation send time.

resvData

String

The reservation send request body. It may be omitted from update responses.

expectedCnt

Integer

The estimated number of sends.

sentCnt

Integer

The number processed for sending.

successCnt

Integer

The success count.

failCnt

Integer

The failure count.

updateDate

String

The update time.

regDate

String

The registration time.

Request example

curl -X GET "https://mars.ibapi.kr/api/comm/v1/reservation/resvKey/MO20260501100000abcdef" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "seq": 100,
      "resvKey": "MO20260501100000abcdef",
      "paymentCode": "SMS07",
      "resvName": "금요일 캠페인",
      "productType": "MESSAGE",
      "status": "PENDING",
      "adYn": "N",
      "resvSendTime": "2026-05-01 10:00:00",
      "expectedCnt": 1000,
      "sentCnt": 0,
      "successCnt": 0,
      "failCnt": 0,
      "updateDate": "2026-04-30 12:34:56",
      "regDate": "2026-04-30 12:00:00"
    }
  }
}

Change reservations

Update a reservation

PUT/api/comm/v1/reservation/resvKey/{resvKey}

Updates the send time and reservation name of a reservation that is pending (PENDING).

Body Parameters

resvSendTime

RequiredString

The new reservation send time.

resvName

String

The reservation name.

Returns

common

Object

The common response section.

data

Object

The service response section.

data

Object

The response data object.

resvName

String

The reservation name.

productType

String

The product type.

status

String

The reservation status.

adYn

String

Whether it is a promotional message.

resvSendTime

String

The reservation send time.

Request example

curl -X PUT "https://mars.ibapi.kr/api/comm/v1/reservation/resvKey/MO20260501100000abcdef" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "resvSendTime": "2026-05-01 11:00:00",
    "resvName": "금요일 캠페인 수정"
  }'

Response example

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "seq": 100,
      "resvKey": "MO20260501100000abcdef",
      "paymentCode": "SMS07",
      "resvName": "금요일 캠페인 수정",
      "productType": "MESSAGE",
      "status": "PENDING",
      "adYn": "N",
      "resvSendTime": "2026-05-01 11:00:00",
      "expectedCnt": 1000,
      "sentCnt": 0,
      "successCnt": 0,
      "failCnt": 0,
      "updateDate": "2026-04-30 12:40:00",
      "regDate": "2026-04-30 12:00:00"
    }
  }
}

Cancel a reservation

POST/api/comm/v1/reservation/resvKey/{resvKey}/cancel

Cancels a reservation that is pending (PENDING) or paused (STOPPED).

Path Parameters

resvKey

RequiredString

The reservation key.

Returns

common

Object

The common response section.

authCode

String

The authentication result code.

authResult

String

The authentication result message.

infobankTrId

String

The transaction tracing ID.

data

Object

The service response section.

code

String

The processing result code.

result

String

The processing result message.

data

Object

The response data object.

seq

Long

The reservation sequence number. You can use it as the lastSeq reference in list lookups.

resvKey

String

The reservation key.

paymentCode

String

The settlement code.

resvName

String

The reservation name.

productType

String

The product type.

status

String

The reservation status.

adYn

String

Whether it is a promotional message.

resvSendTime

String

The reservation send time.

resvData

String

The reservation send request body. It may be omitted from update responses.

expectedCnt

Integer

The estimated number of sends.

sentCnt

Integer

The number processed for sending.

successCnt

Integer

The success count.

failCnt

Integer

The failure count.

updateDate

String

The update time.

regDate

String

The registration time.

Request example

curl -X POST "https://mars.ibapi.kr/api/comm/v1/reservation/resvKey/MO20260501100000abcdef/cancel" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "seq": 100,
      "resvKey": "MO20260501100000abcdef",
      "paymentCode": "SMS07",
      "resvName": "금요일 캠페인",
      "productType": "MESSAGE",
      "status": "CANCELLED",
      "adYn": "N",
      "resvSendTime": "2026-05-01 10:00:00",
      "expectedCnt": 1000,
      "sentCnt": 0,
      "successCnt": 0,
      "failCnt": 0,
      "updateDate": "2026-04-30 12:34:56",
      "regDate": "2026-04-30 12:00:00"
    }
  }
}

Stop a reservation

POST/api/comm/v1/reservation/resvKey/{resvKey}/stop

Pauses a reservation that is being processed (PROCESSING).

Path Parameters

resvKey

RequiredString

The reservation key.

Returns

common

Object

The common response section.

authCode

String

The authentication result code.

authResult

String

The authentication result message.

infobankTrId

String

The transaction tracing ID.

data

Object

The service response section.

code

String

The processing result code.

result

String

The processing result message.

data

Object

The response data object.

seq

Long

The reservation sequence number. You can use it as the lastSeq reference in list lookups.

resvKey

String

The reservation key.

paymentCode

String

The settlement code.

resvName

String

The reservation name.

productType

String

The product type.

status

String

The reservation status.

adYn

String

Whether it is a promotional message.

resvSendTime

String

The reservation send time.

resvData

String

The reservation send request body. It may be omitted from update responses.

expectedCnt

Integer

The estimated number of sends.

sentCnt

Integer

The number processed for sending.

successCnt

Integer

The success count.

failCnt

Integer

The failure count.

updateDate

String

The update time.

regDate

String

The registration time.

Request example

curl -X POST "https://mars.ibapi.kr/api/comm/v1/reservation/resvKey/MO20260501100000abcdef/stop" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "seq": 100,
      "resvKey": "MO20260501100000abcdef",
      "paymentCode": "SMS07",
      "resvName": "금요일 캠페인",
      "productType": "MESSAGE",
      "status": "STOPPED",
      "adYn": "N",
      "resvSendTime": "2026-05-01 10:00:00",
      "expectedCnt": 1000,
      "sentCnt": 0,
      "successCnt": 0,
      "failCnt": 0,
      "updateDate": "2026-04-30 12:34:56",
      "regDate": "2026-04-30 12:00:00"
    }
  }
}

Resume a reservation

POST/api/comm/v1/reservation/resvKey/{resvKey}/resume

Resumes sending for a reservation that is paused (STOPPED).

Path Parameters

resvKey

RequiredString

The reservation key.

Returns

common

Object

The common response section.

authCode

String

The authentication result code.

authResult

String

The authentication result message.

infobankTrId

String

The transaction tracing ID.

data

Object

The service response section.

code

String

The processing result code.

result

String

The processing result message.

data

Object

The response data object.

seq

Long

The reservation sequence number. You can use it as the lastSeq reference in list lookups.

resvKey

String

The reservation key.

paymentCode

String

The settlement code.

resvName

String

The reservation name.

productType

String

The product type.

status

String

The reservation status.

adYn

String

Whether it is a promotional message.

resvSendTime

String

The reservation send time.

resvData

String

The reservation send request body. It may be omitted from update responses.

expectedCnt

Integer

The estimated number of sends.

sentCnt

Integer

The number processed for sending.

successCnt

Integer

The success count.

failCnt

Integer

The failure count.

updateDate

String

The update time.

regDate

String

The registration time.

Request example

curl -X POST "https://mars.ibapi.kr/api/comm/v1/reservation/resvKey/MO20260501100000abcdef/resume" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "seq": 100,
      "resvKey": "MO20260501100000abcdef",
      "paymentCode": "SMS07",
      "resvName": "금요일 캠페인",
      "productType": "MESSAGE",
      "status": "PENDING",
      "adYn": "N",
      "resvSendTime": "2026-05-01 10:00:00",
      "expectedCnt": 1000,
      "sentCnt": 0,
      "successCnt": 0,
      "failCnt": 0,
      "updateDate": "2026-04-30 12:34:56",
      "regDate": "2026-04-30 12:00:00"
    }
  }
}

Manage reservation recipients

Add reservation recipients

POST/api/comm/v1/reservation/resvKey/{resvKey}/destinations

Adds recipients to an existing reservation. You can add up to 1,000 at a time.

Body Parameters

destinations

RequiredObject Array

The list of recipients to add.

ref

String

A per-recipient reference field.

Returns

common

Object

The common response section.

data

Object

The service response section.

data

Object

The result of adding recipients.

Request example

curl -X POST "https://mars.ibapi.kr/api/comm/v1/reservation/resvKey/MO20260501100000abcdef/destinations" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "destinations": [{
      "to": "01000000000",
      "replaceWords": { "name": "홍길동" },
      "ref": "dest-001"
    }]
  }'

Response example

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "inserted": 1
    }
  }
}

Look up the reservation recipient list

GET/api/comm/v1/reservation/resvKey/{resvKey}/destinations

Looks up the recipients registered on a reservation.

Query Parameters

lastSeq

Long

The last sequence number used when looking up the next page.

limit

Integer

The number of records to look up.

Returns

common

Object

The common response section.

authCode

String

The authentication result code.

authResult

String

The authentication result message.

infobankTrId

String

The transaction tracing ID.

data

Object

The service response section.

code

String

The processing result code.

result

String

The processing result message.

data

Object

The reservation recipient list response data.

lastSeq

Long

The lastSeq to use when looking up the next page.

hasNext

Boolean

Whether a next page exists.

destinations

Object Array

The list of reservation recipients.

msgKey

String

The message key.

destSeq

Integer

The recipient sequence number.

String

The recipient number.

destData

String

The per-recipient substitution data.

status

String

The recipient status.

responseCode

String

The processing result code.

responseText

String

The processing result message.

Request example

curl -X GET "https://mars.ibapi.kr/api/comm/v1/reservation/resvKey/MO20260501100000abcdef/destinations?limit=100" \
  -H "Authorization: {ApiKey}"

Response example

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "lastSeq": 10,
      "hasNext": false,
      "destinations": [
        {
          "msgKey": "20260424104234546POM101182450000",
          "destSeq": 1,
          "to": "01000000000",
          "destData": "name=홍길동",
          "status": "PENDING",
          "responseCode": "A000",
          "responseText": "Success"
        }
      ]
    }
  }
}

Delete a reservation recipient

DELETE/api/comm/v1/reservation/resvKey/{resvKey}/destinations/msgKey/{msgKey}

Deletes a recipient registered on a reservation by message key (msgKey).

Path Parameters

resvKey

RequiredString

The reservation key.

msgKey

RequiredString

The message key of the recipient to delete.

Returns

common

Object

The common response section.

authCode

String

The authentication result code.

authResult

String

The authentication result message.

infobankTrId

String

The transaction tracing ID.

data

Object

The service response section.

code

String

The processing result code.

result

String

The processing result message.

Request example

curl -X DELETE "https://mars.ibapi.kr/api/comm/v1/reservation/resvKey/MO20260501100000abcdef/destinations/msgKey/20260424104234546POM101182450000" \
  -H "Authorization: {ApiKey}"

Response example

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