bizgo Developers
API ReferenceCommunication API

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, must use the yyyy-MM-dd HH:mm:ss format, and returns reservations at or after that 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.

data

Object

The service response section.

Request example

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

Response example

1{
2 "common": {
3 "authCode": "A000",
4 "authResult": "Success",
5 "infobankTrId": "Infobank-Tracking-Id"
6 },
7 "data": {
8 "code": "A000",
9 "result": "Success",
10 "data": {
11 "lastSeq": 100,
12 "hasNext": false,
13 "reservations": [
14 {
15 "seq": 100,
16 "resvKey": "MO20260501100000abcdef",
17 "paymentCode": "SMS07",
18 "resvName": "금요일 캠페인",
19 "productType": "MESSAGE",
20 "status": "PENDING",
21 "adYn": "N",
22 "resvSendTime": "2026-05-01 10:00:00",
23 "expectedCnt": 1000,
24 "sentCnt": 0,
25 "successCnt": 0,
26 "failCnt": 0,
27 "updateDate": "2026-04-30 12:34:56",
28 "regDate": "2026-04-30 12:00:00"
29 }
30 ]
31 }
32 }
33}

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.

data

Object

The service response section.

Request example

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

Response example

1{
2 "common": {
3 "authCode": "A000",
4 "authResult": "Success",
5 "infobankTrId": "Infobank-Tracking-Id"
6 },
7 "data": {
8 "code": "A000",
9 "result": "Success",
10 "data": {
11 "seq": 100,
12 "resvKey": "MO20260501100000abcdef",
13 "paymentCode": "SMS07",
14 "resvName": "금요일 캠페인",
15 "productType": "MESSAGE",
16 "status": "PENDING",
17 "adYn": "N",
18 "resvSendTime": "2026-05-01 10:00:00",
19 "resvData": "{\"sms\":{\"from\":\"0212345678\",\"text\":\"금요일 캠페인 안내\"}}",
20 "expectedCnt": 1000,
21 "sentCnt": 0,
22 "successCnt": 0,
23 "failCnt": 0,
24 "updateDate": "2026-04-30 12:34:56",
25 "regDate": "2026-04-30 12:00:00"
26 }
27 }
28}

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.

Request example

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

Response example

1{
2 "common": {
3 "authCode": "A000",
4 "authResult": "Success",
5 "infobankTrId": "Infobank-Tracking-Id"
6 },
7 "data": {
8 "code": "A000",
9 "result": "Success",
10 "data": {
11 "seq": 100,
12 "resvKey": "MO20260501100000abcdef",
13 "paymentCode": "SMS07",
14 "resvName": "금요일 캠페인 수정",
15 "productType": "MESSAGE",
16 "status": "PENDING",
17 "adYn": "N",
18 "resvSendTime": "2026-05-01 11:00:00",
19 "expectedCnt": 1000,
20 "sentCnt": 0,
21 "successCnt": 0,
22 "failCnt": 0,
23 "updateDate": "2026-04-30 12:40:00",
24 "regDate": "2026-04-30 12:00:00"
25 }
26 }
27}

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.

data

Object

The service response section.

Request example

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

Response example

1{
2 "common": {
3 "authCode": "A000",
4 "authResult": "Success",
5 "infobankTrId": "Infobank-Tracking-Id"
6 },
7 "data": {
8 "code": "A000",
9 "result": "Success",
10 "data": {
11 "seq": 100,
12 "resvKey": "MO20260501100000abcdef",
13 "paymentCode": "SMS07",
14 "resvName": "금요일 캠페인",
15 "productType": "MESSAGE",
16 "status": "CANCELLED",
17 "adYn": "N",
18 "resvSendTime": "2026-05-01 10:00:00",
19 "expectedCnt": 1000,
20 "sentCnt": 0,
21 "successCnt": 0,
22 "failCnt": 0,
23 "updateDate": "2026-04-30 12:34:56",
24 "regDate": "2026-04-30 12:00:00"
25 }
26 }
27}

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.

data

Object

The service response section.

Request example

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

Response example

1{
2 "common": {
3 "authCode": "A000",
4 "authResult": "Success",
5 "infobankTrId": "Infobank-Tracking-Id"
6 },
7 "data": {
8 "code": "A000",
9 "result": "Success",
10 "data": {
11 "seq": 100,
12 "resvKey": "MO20260501100000abcdef",
13 "paymentCode": "SMS07",
14 "resvName": "금요일 캠페인",
15 "productType": "MESSAGE",
16 "status": "STOPPED",
17 "adYn": "N",
18 "resvSendTime": "2026-05-01 10:00:00",
19 "expectedCnt": 1000,
20 "sentCnt": 0,
21 "successCnt": 0,
22 "failCnt": 0,
23 "updateDate": "2026-04-30 12:34:56",
24 "regDate": "2026-04-30 12:00:00"
25 }
26 }
27}

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.

data

Object

The service response section.

Request example

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

Response example

1{
2 "common": {
3 "authCode": "A000",
4 "authResult": "Success",
5 "infobankTrId": "Infobank-Tracking-Id"
6 },
7 "data": {
8 "code": "A000",
9 "result": "Success",
10 "data": {
11 "seq": 100,
12 "resvKey": "MO20260501100000abcdef",
13 "paymentCode": "SMS07",
14 "resvName": "금요일 캠페인",
15 "productType": "MESSAGE",
16 "status": "PENDING",
17 "adYn": "N",
18 "resvSendTime": "2026-05-01 10:00:00",
19 "expectedCnt": 1000,
20 "sentCnt": 0,
21 "successCnt": 0,
22 "failCnt": 0,
23 "updateDate": "2026-04-30 12:34:56",
24 "regDate": "2026-04-30 12:00:00"
25 }
26 }
27}

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.

Returns

common

Object

The common response section.

data

Object

The service response section.

Request example

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

Response example

1{
2 "common": {
3 "authCode": "A000",
4 "authResult": "Success",
5 "infobankTrId": "Infobank-Tracking-Id"
6 },
7 "data": {
8 "code": "A000",
9 "result": "Success",
10 "data": {
11 "destinations": [
12 {
13 "to": "01000000000",
14 "msgKey": "MO20260501100001abcdef",
15 "code": "A000",
16 "result": "Success"
17 }
18 ]
19 }
20 }
21}

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.

data

Object

The service response section.

Request example

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

Response example

1{
2 "common": {
3 "authCode": "A000",
4 "authResult": "Success",
5 "infobankTrId": "Infobank-Tracking-Id"
6 },
7 "data": {
8 "code": "A000",
9 "result": "Success",
10 "data": {
11 "lastSeq": 10,
12 "hasNext": false,
13 "destinations": [
14 {
15 "msgKey": "20260424104234546POM101182450000",
16 "destSeq": 1,
17 "to": "01000000000",
18 "destData": "name=홍길동",
19 "status": "PENDING",
20 "responseCode": "A000",
21 "responseText": "Success"
22 }
23 ]
24 }
25 }
26}

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.

data

Object

The service response section.

Request example

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

Response example

1{
2 "common": {
3 "authCode": "A000",
4 "authResult": "Success",
5 "infobankTrId": "Infobank-Tracking-Id"
6 },
7 "data": {
8 "code": "A000",
9 "result": "Success"
10 }
11}