bizgo Developers
API 레퍼런스커뮤니케이션 API

예약 관리

예약 발송 등록 이후 예약 건의 상태를 조회하거나 발송 시각을 변경하고, 예약 건을 취소/중지/재개할 수 있습니다. 예약 등록은 각 메시지 채널의 발송 흐름에서 함께 확인할 수 있습니다.

예약 조회

예약 목록 조회

GET/api/comm/v1/reservation/list

예약 발송 건 목록을 조회합니다. resvSendTime은 필수이며 월, 일, 시각 단위로 조회할 수 있습니다.

Query Parameters

resvSendTime

필수String

조회 기준 예약 발송 시각입니다.

paymentCode

String

정산 코드로 조회 대상을 필터링합니다.

lastSeq

Long

다음 페이지 조회 시 사용하는 마지막 순번입니다.

limit

Integer

조회 건수입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

요청 예시

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

응답 예시

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}

예약 상세 조회

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

예약 발송 키(resvKey)로 예약 건을 단건 조회합니다.

Path Parameters

resvKey

필수String

예약 발송 키입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

요청 예시

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

응답 예시

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}

예약 변경

예약 수정

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

예약 대기(PENDING) 상태인 예약 건의 발송 시각과 예약명을 수정합니다.

Body Parameters

resvSendTime

필수String

변경할 예약 발송 시각입니다.

resvName

String

예약명입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

요청 예시

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 }'

응답 예시

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}

예약 취소

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

예약 대기(PENDING) 또는 예약 중지(STOPPED) 상태인 예약 건을 취소합니다.

Path Parameters

resvKey

필수String

예약 발송 키입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

요청 예시

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

응답 예시

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}

예약 중지

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

발송 처리 중(PROCESSING)인 예약 건을 중지합니다.

Path Parameters

resvKey

필수String

예약 발송 키입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

요청 예시

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

응답 예시

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}

예약 재개

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

예약 중지(STOPPED) 상태인 예약 건을 다시 발송 처리합니다.

Path Parameters

resvKey

필수String

예약 발송 키입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

요청 예시

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

응답 예시

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}

예약 수신자 관리

예약 수신자 추가

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

기존 예약 건에 수신자를 추가합니다. 한 번에 최대 1000건까지 추가할 수 있습니다.

Body Parameters

destinations

필수Object Array

추가할 수신자 목록입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

요청 예시

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 }'

응답 예시

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 "inserted": 1
12 }
13 }
14}

예약 수신자 목록 조회

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

예약 건에 등록된 수신자 목록을 조회합니다.

Query Parameters

lastSeq

Long

다음 페이지 조회 시 사용하는 마지막 순번입니다.

limit

Integer

조회 건수입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

요청 예시

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

응답 예시

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/api/comm/v1/reservation/resvKey/{resvKey}/destinations/msgKey/{msgKey}

예약 건에 등록된 수신자를 메시지 키(msgKey) 기준으로 삭제합니다.

Path Parameters

resvKey

필수String

예약 발송 키입니다.

msgKey

필수String

삭제할 수신자의 메시지 키입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

요청 예시

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

응답 예시

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}