RCS
RCS 서비스는 세계이동통신사업자협회(GSMA)가 만든 통합 메신저 규격으로, 기존 SMS 또는 MMS에 비해 추가적으로 그룹채팅, 콘텐츠 공유, 브랜드 생성 등 다양한 서비스를 제공합니다. BizMessage API를 사용하여 사용자에게 전화번호를 기반으로 RCS를 발송할 수 있습니다.
안내
- 모든 BizMessage API를 호출하기 전, OAuth 2.0 인증 API를 선제적으로 호출해야 합니다.
- API 기능별 예제는 Sample Code 문서를 참고하시기 바랍니다.
주의
스테이징 서버는 카카오 운영 서버와 연동되어 있어 실제 메시지가 발송되므로, 메시지 오발송에 주의하시기 바랍니다.
RCS 발송
RCS를 발송하는 API는 다음과 같습니다.
Request
Request Syntax
코드예제RCS 발송 Request Syntax
curl -X POST "https://{base_url}/v2/send/rcs" \
-H "accept: */*" \
-H "authorization: Bearer {oauthToken}" \
-H "Content-Type: application/json" \
-d '{
"cid": "202210181700001",
"message_type": "RCSSMS",
"phone_number": "01000000000",
"template_code": "SMwThM00",
"agency_id": "kakaoenterprise1",
"ad_flag": "Y",
"footer": "080-0000-0000",
"sender_no": "0316001021",
"copy_allowed": true,
"body": [
{
"title": "RCSMMS 타이틀",
"description": "RCSMMS 본문 내용",
"media": "maapfile://0001"
}
],
"fall_back_yn": true,
"fall_back_message_type": "SM",
"fall_back_title": "test",
"fall_back_message": "대체 메시지"
}'
메서드 | 요청 URL |
---|---|
POST | https://{base_url}/v2/send/rcs |
파라미터 | 유형 | 필수 여부 | 대분류 | 구분 | 설명 |
---|---|---|---|---|---|
base_url | String | 필수 |
운영 | 일반 | bizmsg-web.kakaoenterprise.com |
금융권 | bizmsg-bank.kakaoenterprise.com |
||||
증권 | bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | bizmsg-gov.kakaoenterprise.com |
||||
스테이징 | 일반 | stg-user.bizmsg.kakaoenterprise.com |
|||
금융권 | stg-bizmsg-bank.kakaoenterprise.com |
||||
증권 | stg-bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | stg-bizmsg-gov.kakaoenterprise.com |
Request Header
표RCS 발송 Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
accept | String | 필수 |
*/* 로 고정 |
authorization | String | 필수 |
Bearer {oauthToken} - {oauthToken} : OAuth 2.0 인증 API로 발급받은 액세스 토큰 |
Content-Type | String | 필수 |
application/json 으로 고정 |
Request Elements
표RCS 발송 Request Elements파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
cid | String | 필수 |
고객사 정의 Key ID |
message_type | String | 필수 |
메시지 타입 |
RCSSMS : SMS 유형 |
|||
RCSLMS : LMS 유형 |
|||
RCSMMS : MMS 유형 |
|||
RCSTMPL : RCS 템플릿 유형 |
|||
phone_number | String | 필수 |
수신자 전화번호(국가코드(82 )를 포함)- text(16) |
template_code | String | 필수 |
RCS 템플릿 코드(RCSTMPL 유형이 아니더라도, 타입별 기본 템플릿 코드를 필수로 입력해야 함) - text(30) |
agency_id | String | 필수 |
브랜드 대행사 ID - 계약 시 확인 가능 |
client_id | String | 선택 |
고객사 ID |
ad_flag | String | 필수 |
광고성 메시지 여부 - text(1) |
Y (기본값): 광고성 메시지 |
|||
N : 비 광고성 메시지 |
|||
footer | String | 선택 |
수신거부 등록 전화번호 - ad_flag 가 Y 일 때만 사용 가능 |
sender_no | String | 필수 |
고객사 발신 전화번호(대체 발송 시 사용, 미사용 시 임의 값 가능) - text(16) |
copy_allowed | Boolean | 선택 |
RCS 본문 복사 허용 여부 |
true (기본값): 본문 복사 허용 |
|||
false : 본문 복사 비허용 |
|||
Array | 선택 |
[RCSSMS, RCSLMS, RCSMMS] 메시지 본문 - Body 2개 이상은 carousel 형태로 발송되며, 유형별 제한 개수 초과 시 발송 실패 |
|
RCSSMS : Body 최대 1개, Body 당 버튼 최대 1개 |
|||
RCSLMS : Body 최대 1개, Body 당 버튼 최대 3개 |
|||
RCSMMS : 기본 템플릿 코드에 따라 Body 최대 6개까지 가능, Body 당 버튼 최대 2개 |
|||
title | String | 필수 |
RCS 메시지의 제목 |
description | String | 필수 |
RCS 본문 내용 |
RCSSMS : 최대 100 Byte |
|||
RCSLMS : 최대 1300 Byte |
|||
RCSMMS 카드별 총합: 최대 1300 Byte |
|||
RCSTMPL 변수부와 가변부의 합: 최대 90 Byte |
|||
media | String | 선택 |
[RCSMMS] 파일 첨부 시, 미리 업로드 한 파일의 URL |
button | 선택 |
GSMA RCC.07의 3.6.10.4의 ‘suggestions’ 규격에 준하여 버튼을 구성 - button 데이터 예시 참고 |
|
tmpl_decription | String | 선택 |
[RCSTMPL] 서술형, Free 템플릿 유형 시 템플릿 본문 - 변수 부분을 포함한 모든 본문 작성 - 변수부 길이 총합 90자 이내 |
tmpl_variable | Map | 선택 |
[RCSTMPL] cell형 템플릿 유형 시, 변수이름을 Key, 값을 Value 형태로 구성한 JSON 형태 - 변수만 포함, 변수부 길이 총합 90자 이내 |
biz_no | String | 선택 |
최초 발신자 식별 코드 (재판사용) |
fall_back_yn | Boolean | 필수 |
대체 메시지 전송 여부 |
fall_back_message_type | String | 선택 |
대체 발송 시 메시지 타입 - text(2) |
SM : SMS로 대체 발송 |
|||
LM : LMS로 대체 발송 |
|||
fall_back_title | String | 선택 |
대체 발송 메시지 제목 - 60 Byte |
fall_back_message | String | 선택 |
대체 발송 메시지 본문 - text(2000) |
tax_cd1 | String | 선택 |
정산 코드1 - 고객사가 정산을 위해 정의하여 사용하는 변수 - text(50) |
tax_cd2 | String | 선택 |
정산 코드2 - 고객사가 정산을 위해 정의하여 사용하는 변수 - text(50) |
button 데이터 예시
Response
Response Syntax
코드예제RCS 발송 Response Syntax
{
"code": "100",
"result": {
"detail_code": "OK",
"detail_message": null
},
"uid": "2210181656511076scJhgrcTG+U+jB",
"cid": "2022101800001"
}
Response Elements
표RCS 발송 Response Elements프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
code | String | 필수 |
메시지 발송 결과 코드 |
100 : 발송 진행 중(처리 중) |
|||
200 : 성공 |
|||
400 : 권한 오류 |
|||
410 : 입력값이 유효하지 않음 |
|||
420 : 파일/이미지 관련 오류 |
|||
500 : 내부 시스템 오류 |
|||
510 : 발송 실패 |
|||
520 : 실패되었으나 재발송 가능 |
|||
Object | 선택 |
세부 결과 정보(참고용) | |
detail_code | String | 선택 |
세부 결과 코드(참고용) |
detail_message | String | 선택 |
세부 결과 메시지(참고용) |
uid | String | 선택 |
메시지 Key ID |
cid | String | 선택 |
고객사 정의 Key ID |
안내
API 기능별 코드는 Sample Code 문서를 참고하시기 바랍니다.
RCS 파일 업로드
다음은 RCS 발송 전 파일을 업로드하기 위한 API 기능에 대한 설명입니다.
Request
Request Syntax
코드예제RCS 파일 업로드 Request Syntax
curl -X 'POST' \ 'https://{base_url}/v2/upload/rcs' \
-H 'accept: */*' \
-H 'Authorization: Bearer {oauthToken}' \
-H 'Content-Type: multipart/form-data' \
-F 'image=@test_img.jpg;type=image/jpg' \
-F 'description=크리스마스 이벤트 용'
메서드 | 요청 URL |
---|---|
POST | https://{base_url}/v2/upload/rcs |
파라미터 | 유형 | 필수 여부 | 대분류 | 구분 | 설명 |
---|---|---|---|---|---|
base_url | String | 필수 |
운영 | 일반 | bizmsg-web.kakaoenterprise.com |
금융권 | bizmsg-bank.kakaoenterprise.com |
||||
증권 | bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | bizmsg-gov.kakaoenterprise.com |
||||
스테이징 | 일반 | stg-user.bizmsg.kakaoenterprise.com |
|||
금융권 | stg-bizmsg-bank.kakaoenterprise.com |
||||
증권 | stg-bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | stg-bizmsg-gov.kakaoenterprise.com |
Request Header
표RCS 파일 업로드 Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
accept | String | 필수 |
*/* 로 고정 |
authorization | String | 필수 |
Bearer {oauthToken} - {oauthToken} : OAuth 2.0 인증 API로 발급받은 액세스 토큰 |
Content-Type | String | 필수 |
multipart/form-data 로 고정 |
프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
image | File | 필수 |
RCS 파일 정보 - @test_img.jpg;type=image/{이미지 유형} - {이미지 유형}: jpg 또는 png - 파일 크기: 최대 1MB |
description | File | 필수 |
RCS 파일에 대한 설명 |
Response
Response Syntax
코드예제RCS 파일 업로드 Response Syntax
{
"code": "200",
"result": {
"detail_code": "200",
"detail_message": null
},
"file_id": "BR.xCu2bm23hj.d924474ec319404e898fb62192374fbf",
"url": "maapfile://BR.xCu2bm23hj.d924474ec319404e898fb62192374fbf",
"expiry_date": "2024-01-17T00:00:00.000+09"
}
Response Elements
표RCS 파일 업로드 Response Elements프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
code | String | 선택 |
결과 코드 |
Object | 선택 |
세부 결과 정보 (참고용) - API 메시지 상태 코드 참고 |
|
detail_code | String | 선택 |
세부 결과 메시지 - API 메시지 상태 코드 참고 |
detail_message | String | 선택 |
세부 결과 메시지 - API 메시지 상태 코드 참고 |
file_id | String | 선택 |
생성된 파일 ID |
url | String | 선택 |
업로드된 이미지 URL |
expiry_date | String | 선택 |
만료 날짜 |
RCS 발송 결과 요청
RCS 발송 서비스의 결과를 요청하는 API입니다. RCS를 사용하는 경우 해당 RCS 결과 요청 API를 통해 최대 1,000건의 결과를 수신받을 수 있습니다.
안내
메시지 결과 요청 후 완료(RCS 발송 결과 조회 완료) 처리를 해야 처리된 결과를 재조회하지 않습니다.
Request
Request Syntax
코드예제RCS 발송 결과 요청 Request Syntax
curl -X 'GET' \
'https://{base_url}/v2/info/rcs/results' \
-H 'accept: */*' \
-H 'Authorization: Bearer {oauthToken}'
메서드 | 요청 URL |
---|---|
GET | https://{base_url}/v2/info/rcs/results |
파라미터 | 유형 | 필수 여부 | 대분류 | 구분 | 설명 |
---|---|---|---|---|---|
base_url | String | 필수 |
운영 | 일반 | bizmsg-web.kakaoenterprise.com |
금융권 | bizmsg-bank.kakaoenterprise.com |
||||
증권 | bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | bizmsg-gov.kakaoenterprise.com |
||||
스테이징 | 일반 | stg-user.bizmsg.kakaoenterprise.com |
|||
금융권 | stg-bizmsg-bank.kakaoenterprise.com |
||||
증권 | stg-bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | stg-bizmsg-gov.kakaoenterprise.com |
파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
accept | String | 필수 |
*/* 로 고정 |
Authorization | String | 필수 |
Bearer {oauthToken} - {oauthToken} : OAuth 2.0 인증 API로 발급받은 액세스 토큰 |
Response
Response Syntax
코드예제RCS 발송 결과 요청 Response Syntax
{
"code": "200",
"code_detail": {
"detail_code": "NRM00000",
"detail_message": "성공"
},
"report_group_id": "5799598466530692318",
"results": [
{
"uid": "220830105315335+dsk43BTSrG1g3V",
"client_id": "test00001",
"cid": "209fcb9da31d46b4a01278cd187c7289",
"status": "API_200",
"rcs_status": "success"
}
]
}
Response Elements
표RCS 발송 결과 요청 Response Elements프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
code | String | 필수 |
메시지 발송 결과 코드 |
100 : 발송 진행 중(처리 중) |
|||
200 : 성공 |
|||
400 : 권한 오류 |
|||
410 : 입력값이 유효하지 않음 |
|||
420 : 파일/이미지 관련 오류 |
|||
500 : 내부 시스템 오류 |
|||
510 : 발송 실패 |
|||
520 : 실패되었으나 재발송 가능 |
|||
Object | 선택 |
메시지 상태 상세 코드 | |
detail_code | String | 선택 |
상세 코드 |
detail_message | String | 선택 |
상세 메시지 |
report_group_id | String | 선택 |
RCS 결과 그룹 고유 번호 |
Array | 선택 |
RCS 결과 조회 리스트 | |
uid | String | 선택 |
메시지의 Key ID |
client_id | String | 선택 |
클라이언트 ID |
cid | String | 선택 |
고객사 정의 Key ID |
status | String | 선택 |
메시지 상태 코드 - API 메시지 상태 코드 참고 |
rcs_status | String | 선택 |
RCS 처리 결과 코드 |
success : 성공 |
|||
fallback_status | String | 선택 |
대체 처리 결과 코드 - API 메시지 상태 코드 참고 |
RCS 발송 결과 조회 완료
처리가 완료된 RCS 결과를 완료 처리하는 API 입니다.
Request
Request Syntax
코드예제RCS 발송 결과 조회 완료 Request Syntax
curl -X 'PUT' \
'https://{base_url}/v2/info/rcs/results/complete/{report_group_id}' \
-H 'accept: */*' \
-H 'Authorization: Bearer {oauthToken}'
메서드 | 요청 URL |
---|---|
PUT | https://{base_url}/v2/info/rcs/results/complete/{report_group_id} |
파라미터 | 유형 | 필수 여부 | 대분류 | 구분 | 설명 |
---|---|---|---|---|---|
base_url | String | 필수 |
운영 | 일반 | bizmsg-web.kakaoenterprise.com |
금융권 | bizmsg-bank.kakaoenterprise.com |
||||
증권 | bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | bizmsg-gov.kakaoenterprise.com |
||||
스테이징 | 일반 | stg-user.bizmsg.kakaoenterprise.com |
|||
금융권 | stg-bizmsg-bank.kakaoenterprise.com |
||||
증권 | stg-bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | stg-bizmsg-gov.kakaoenterprise.com |
||||
report_group_id | String | 필수 |
RCS 결과 그룹 고유 번호 - ex. 5799598466530692318 |
Request Header
표RCS 발송 결과 조회 완료 Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
accept | String | 필수 |
*/* 로 고정 |
Authorization | String | 필수 |
Bearer {oauthToken} - {oauthToken} : OAuth 2.0 인증 API로 발급받은 액세스 토큰 |
Response
Response Syntax
코드예제RCS 발송 결과 조회 완료 Response Syntax
{
"code": "200",
"code_detail": {
"detail_code": "NRM00000",
"detail_message": "성공"
}
}
프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
code | String | 필수 |
메시지 발송 결과 코드 |
100 : 발송 진행 중(처리 중) |
|||
200 : 성공 |
|||
400 : 권한 오류 |
|||
410 : 입력값이 유효하지 않음 |
|||
420 : 파일/이미지 관련 오류 |
|||
500 : 내부 시스템 오류 |
|||
510 : 발송 실패 |
|||
520 : 실패되었으나 재발송 가능 |
|||
Object | 선택 |
메시지 상태 상세 코드 | |
detail_code | String | 선택 |
상세 코드 |
detail_message | String | 선택 |
상세 메시지 |
RCS 발송 리스트 조회
다음은 RCS 발송 결과의 상태 리스트를 상세하게 조회할 수 있는 API 기능에 대한 설명입니다.
Request
Request Syntax
코드예제RCS 발송 리스트 조회 Request Syntax
curl -X 'POST' \
'https://{base_url}/v2/info/rcs/search' \
-H 'accept: */*' \
-H 'Authorization: Bearer {oauthToken}' \
-H 'Content-Type: application/json' \
-d '{
"start_date": "2022-10-18",
"end_date": "2022-10-18",
"size": 1000
}'
메서드 | 요청 URL |
---|---|
GET | https://{base_url}/v2/info/rcs/search |
파라미터 | 유형 | 필수 여부 | 대분류 | 구분 | 설명 |
---|---|---|---|---|---|
base_url | String | 필수 |
운영 | 일반 | bizmsg-web.kakaoenterprise.com |
금융권 | bizmsg-bank.kakaoenterprise.com |
||||
증권 | bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | bizmsg-gov.kakaoenterprise.com |
||||
스테이징 | 일반 | stg-user.bizmsg.kakaoenterprise.com |
|||
금융권 | stg-bizmsg-bank.kakaoenterprise.com |
||||
증권 | stg-bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | stg-bizmsg-gov.kakaoenterprise.com |
Request Header
표RCS 발송 리스트 조회 Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
accept | String | 필수 |
*/* 로 고정 |
Authorization | String | 필수 |
Bearer {oauthToken} - {oauthToken} : OAuth 2.0 인증 API로 발급받은 액세스 토큰 |
Content-Type | String | 필수 |
application/json 로 고정 |
Request Elements
표RCS 발송 리스트 조회 Request Elements파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
start_date | String | 선택 |
검색 시작일 - 형식: yyyy-mm-dd (date)- 시작일 입력 시 종료일도 필수 입력, 입력값이 없을 경우 당일 데이터를 검색 |
end_date | String | 선택 |
검색 종료일 - 형식: yyyy-mm-dd (date)- 종료일 입력 시 시작일도 필수 입력, 입력값이 없을 경우 당일 데이터를 검색 |
client_id | String | 선택 |
발송 고객사 ID |
size | Integer | 선택 |
페이지 당 리스트 수 (최대 1000) - int32 |
last_uid | String | 선택 |
조회한 페이지 리스트의 마지막 메시지 Key ID - 다음 페이지 조회 시 필수 |
status | String | 선택 |
RCS 상태 코드 |
service_type | String | 선택 |
상품 타입 코드 |
RCSSMS : SMS 유형 |
|||
RCSLMS : LMS 유형 |
|||
RCSMMS : MMS 유형 |
|||
RCSTMPL : RCS 템플릿 유형 |
Response
Response Syntax
코드예제RCS 발송 리스트 조회 Response Syntax
{
"status": "200",
"code": "200",
"count": 5,
"next": false,
"code_detail": {
"detail_code": "NRM00000",
"detail_message": "성공"
},
"results": [
{
"uid": "221018080602083Uk~v+QosQZGZPYD",
"reg_date": "2022-10-18T08:06:02",
"status": "API_200",
"rcs_status": "success",
"cid": "e2fddce9509f4153bf220f1cc356b594"
}
]
}
Response Elements
표RCS 발송 리스트 조회 Response Elements프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
status | String | 필수 |
메시지 발송 결과 코드 |
100 : 발송 진행 중(처리 중) |
|||
200 : 성공 |
|||
400 : 권한 오류 |
|||
410 : 입력값이 유효하지 않음 |
|||
420 : 파일/이미지 관련 오류 |
|||
500 : 내부 시스템 오류 |
|||
510 : 발송 실패 |
|||
520 : 실패되었으나 재발송 가능 |
|||
code | String | 선택 |
응답 상태 코드 |
count | Integer | 선택 |
결과 정보 조회 시 리스트 수 - int64 |
next | Boolean | 선택 |
페이지 조회 시 다음 페이지 여부 |
last_uid | String | 선택 |
조회한 페이지 리스트의 마지막 메시지 Key ID |
Object | 선택 |
메시지 상태 상세 코드 | |
detail_code | String | 선택 |
상세 코드 |
detail_message | String | 선택 |
상세 메시지 |
Array | 선택 |
메시지 결과 조회 리스트 | |
uid | String | 선택 |
메시지의 Key ID |
cid | String | 선택 |
고객사 정의 Key ID |
reg_date | String | 선택 |
메시지 등록일 |
status | String | 선택 |
메시지 상태 코드 - 상세 정보는 API 메시지 상태 코드 참고 |
rcs_status | String | 선택 |
RCS 처리 결과 코드 |
fallback_status | String | 선택 |
대체 처리 결과 코드 |
error_message | String | 선택 |
에러 메시지(오류 시 존재하는 값) |
tax_cd1 | String | 선택 |
정산 코드1 - 고객사가 정산을 위해 정의하여 사용할 수 있는 변수 - text(50) |
tax_cd2 | String | 선택 |
정산 코드2 - 고객사가 정산을 위해 정의하여 사용할 수 있는 변수 - text(50) |
RCS 발송 리스트 상세 정보 조회
다음은 RCS 발송 결과를 상세하게 조회할 수 있는 API 기능에 대한 설명입니다.
Request
Request Syntax
코드예제RCS 발송 리스트 상세 정보 조회 Request Syntax
curl -X 'GET' \
'https://{base_url}/v2/info/rcs/search/detail/{uid}' \
-H 'accept: */*' \
-H 'Authorization: Bearer {oauthToken}'
메서드 | 요청 URL |
---|---|
GET | https://{base_url}/v2/info/rcs/search/detail/{uid} |
파라미터 | 유형 | 필수 여부 | 대분류 | 구분 | 설명 |
---|---|---|---|---|---|
base_url | String | 필수 |
운영 | 일반 | bizmsg-web.kakaoenterprise.com |
금융권 | bizmsg-bank.kakaoenterprise.com |
||||
증권 | bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | bizmsg-gov.kakaoenterprise.com |
||||
스테이징 | 일반 | stg-user.bizmsg.kakaoenterprise.com |
|||
금융권 | stg-bizmsg-bank.kakaoenterprise.com |
||||
증권 | stg-bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | stg-bizmsg-gov.kakaoenterprise.com |
||||
uid | String | 필수 |
메시지 Key ID - ex. 21018173501346cxU7zEswSYSsTmS |
Request Header
표RCS 발송 리스트 상세 정보 조회 Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
accept | String | 필수 |
*/* 로 고정 |
Authorization | String | 필수 |
Bearer {oauthToken} - {oauthToken} : OAuth 2.0 인증 API로 발급받은 액세스 토큰 |
Response
Response Syntax
코드예제RCS 발송 리스트 상세 정보 조회 Response Syntax
{
"code": "200",
"code_detail": {
"detail_code": "NRM00000",
"detail_message": "성공"
},
"result": {
"uid": "221018080602083Uk~v+QosQZGZPYD",
"client_id": "ADMINTEST001",
"cid": "e2fddce9509f4153bf220f1cc356b594",
"reg_date": "2022-10-18T08:06:02",
"phone_number": "01000000000",
"message_base_id": "SS000000",
"service_type": "RCSSMS",
"body": " 메시지",
"buttons": "[{}]",
"fallback_yn": false,
"req_date": "2022-10-18T08:06:02",
"res_date": "2022-10-18T08:06:06",
"sent_date": "2022-10-18T08:06:02",
"time_stamp": "2022-10-18T08:06:03",
"status": "API_200",
"rcs_status": "success",
"mno_info": "SKT"
}
}
Response Elements
표RCS 발송 리스트 상세 정보 조회 Response Elements프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
code | String | 선택 |
응답 상태 코드 |
200 (OK): 성공, 조회 결과 정보 응답 |
|||
401 (Unauthorized): 권한 없음 |
|||
403 (Forbidden): 서버가 요청을 거부함 |
|||
404 (Not Found): 서버가 요청한 페이지(Resource)를 찾을 수 없음 |
|||
Object | 선택 |
메시지 상태 상세 코드 | |
detail_code | String | 선택 |
상세 코드 |
detail_message | String | 선택 |
상세 메시지 |
Object | 선택 |
단일 메시지의 발송 결과 상세 조회 | |
uid | String | 선택 |
메시지의 Key ID |
client_id | String | 선택 |
계약 시 발급받은 클라이언트 ID |
cid | String | 선택 |
고객사 정의 Key ID |
reg_date | String | 선택 |
메시지 등록일(date) |
phone_number | String | 선택 |
수신자 전화번호 |
callback | String | 선택 |
고객사 발신 전화번호 |
message_base_id | String | 선택 |
메시지 기본 코드 |
message_group_id | String | 선택 |
메시지 그룹 코드 |
service_type | String | 선택 |
상품 타입 코드 |
RCSSMS : SMS 유형 |
|||
RCSLMS : LMS 유형 |
|||
RCSMMS : MMS 유형 |
|||
RCSTMPL : RCS 템플릿 유형 |
|||
body | String | 선택 |
수신자에게 전달될 메시지 데이터 |
buttons | [String] | 선택 |
버튼 데이터 |
fallback_yn | Boolean | 선택 |
대체 메시지 발송 여부 |
true : 대체 메시지를 전송 |
|||
false (기본값): 대체 메시지를 전송하지 않음 |
|||
fallback_type | String | 선택 |
대체 발송 타입(SMS,LMS) |
fallback_calback | String | 선택 |
대체 발신번호 |
fallback_subject | String | 선택 |
대체 제목 |
fallback_message | String | 선택 |
대체 본문 |
req_date | String | 선택 |
RCS 발송 시각(date) |
res_date | String | 선택 |
결과 수신 시각(date) |
sent_date | String | 선택 |
KT → 이통사 발송 시각(date) |
time_stamp | String | 선택 |
이통사 → 단말기 수신 시각(date) |
status | String | 선택 |
상태 코드 |
rcs_status | String | 선택 |
RCS 처리결과 코드 |
fallback_status | String | 선택 |
대체 처리결과 코드 |
error_message | String | 선택 |
에러 메시지 |
mno_info | String | 선택 |
이통사 정보(SKT, KT, LGU) |