Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
array<object>
O
등록된 로고 ID 입니다.
code
string
5
O
20000000
status
integer
3
O
200
desc
string
O
fileId
string
등록된 로고 ID 입니다.
{
"code": "20000000",
"desc": null,
"result": [
{
"fileId": "BLG-BR.61hBmMP164-Jt1O"
}
],
"status": 200
}{
"error": {
"code": "64001",
"message": "Missing X-RCS-BrandKey header"
},
"status": 400
}
{
"error": {
"code": "64321",
"message": "Invalid approval status"
},
"status": 400
}{
"error": {
"code": "61003",
"message": "Invalid token"
},
"status": 401
}{
"error": {
"code": "63001",
"message": "No Brand Permission"
},
"status": 403
}error code는 RCS Biz Center - Response body error code 참조
array<object>
O
RBC에서 제공되는 기본 로고 정보
code
string
5
O
20000000
리턴코드값
status
integer
3
O
200
상태값
desc
string
O
처리메시지
fileId
string
64
기본 로고 이미지 파일 ID 입니다.
fileUrl
string
기본 로고 이미지 파일 URL 입니다.
fileName
string
30
기본 로고명 입니다.
{
"code": "20000000",
"desc": null,
"result": [
{
"fileName": "프로모션.gif",
"fileUrl": "https://file-qa.rcsbizcenter.com/form/messagebase.common/LT-messagebase.common-DdWk6s_1.gif",
"fileId": "LT-messagebase.common-DdWk6s"
},
{
"fileName": "쿠폰.gif",
"fileUrl": "https://file-qa.rcsbizcenter.com/form/messagebase.common/LT-messagebase.common-5Weq00_1.gif",
"fileId": "LT-messagebase.common-5Weq00"
},
{
"fileName": "이벤트.gif",
"fileUrl": "https://file-qa.rcsbizcenter.com/form/messagebase.common/LT-messagebase.common-jUAJX2_1.gif",
"fileId": "LT-messagebase.common-jUAJX2"
},
{
"fileName": "예약.gif",
"fileUrl": "https://file-qa.rcsbizcenter.com/form/messagebase.common/LT-messagebase.common-2Yxt2H_1.gif",
"fileId": "LT-messagebase.common-2Yxt2H"
},
{
"fileName": "영수증.gif",
"fileUrl": "https://file-qa.rcsbizcenter.com/form/messagebase.common/LT-messagebase.common-2k8ydI_1.gif",
"fileId": "LT-messagebase.common-2k8ydI"
},
{
"fileName": "알림.gif",
"fileUrl": "https://file-qa.rcsbizcenter.com/form/messagebase.common/LT-messagebase.common-YCVd02_1.gif",
"fileId": "LT-messagebase.common-YCVd02"
}
],
"status": 200
}{
"error": {
"code": "61003",
"message": "Invalid token"
},
"status": 401
}array<object>
O
등록된 로고 ID 입니다.
code
string
5
O
20000000
status
integer
3
O
200
desc
string
O
fileId
string
등록된 로고 ID 입니다.
{
"code": "20000000",
"desc": null,
"result": [
{
"fileId": "BLG-BR.61hBmMP164-Jt1O"
}
],
"status": 200
}{
"error": {
"code": "64001",
"message": "Missing X-RCS-BrandKey header"
},
"status": 400
}{
"error": {
"code": "61003",
"message": "Invalid token"
},
"status": 401
}{
"error": {
"code": "63001",
"message": "No Brand Permission"
},
"status": 403
}error code는 RCS Biz Center - Response body error code 참조
array<object>
O
브랜드 로고 정보
code
string
5
O
20000000
status
integer
3
O
200
desc
string
O
fileId
string
64
로고 이미지 파일 ID 입니다.
fileUrl
string
1000
로고 이미지 파일 URL 입니다.
name
string
30
로고명 입니다.
fileName
string
256
원본 파일명 입니다.
description
string
100
로고 설명입니다.
viaTemplate
string
템플릿 등록 시 추가된 이미지가 로고로 등록된 경우 해당 템플릿(messagebase) ID 를 표시합니다. 템플릿ID가 존재하는 로고 파일ID는 다른 템플릿 등록 시 사용할 수 없습니다.
approvalResult
string
로고 승인 상태입니다.
저장 : RCS Biz Center 홈페이지에서 승인요청 하지 않고 저장 또는 승인요청 취소된 상태입니다. 저장 상태의 로고는 승인요청을 해야 승인대기 상태로 변경됩니다.
승인대기 : 로고 등록 직후 검수 이전 상태입니다.
검수시작 : 로고 검수가 시작된 상태입니다.
승인 : 검수가 완료되어 이통3사에 정보 등록까지 최종 완료되어 RCS 메시지 발송시 사용 가능한 상태입니다.
반려 : 검수 시 승인이 불가하여 반려된 상태입니다. 반려된 로고는 수정 후 다시 승인요청 할 수 있습니다.
검수완료 : RCS Biz Center에서 검수 승인 하였으나 이통사 3사 등록이 완료되지 않은 상태로 RCS 메시지를 발송시 사용할 수 없습니다.
승인대기(수정) : 승인된 로고를 수정하여 다시 승인요청한 상태입니다.
검수시작(수정) : 승인된 로고를 수정하여 다시 승인요청된 로고의 검수가 시작된 상태입니다.
반려(수정) : 승인된 로고를 수정하여 다시 승인요청 후 검수 처리 결과 반려된 상태입니다.
검수완료(수정) : 승인된 로고를 수정하여 다시 승인요청 후 검수 승인은 되었으나 이통3사 정보 갱신이 완료되지 않은 상태입니다. 현재 상태에서는 이통사에 따라 로고가 다르게 표시될 수 있습니다.
approvalReason
string
승인 사유
registerDate
string
로고 등록일시
approvalDate
string
로고 승인일시
updateDate
string
로고 수정일시
registerId
string
20
로고 등록 계정 ID
updateId
string
20
로고 수정 계정 ID
{
"code": "20000000",
"desc": null,
"result": [
{
"fileId": "BLG-BR.61hBmMP164-Jt1O",
"fileUrl": "https://file-qa.rcsbizcenter.com/brand/BR.61hBmMP164/logo/BLG-BR.61hBmMP164-Jt1O_1.png",
"name": "통신",
"fileName": "[크기변환]통신.png",
"approvalResult": "저장",
"viaTemplate": null,
"description": "통신",
"approvalReason": "승인요청 취소",
"registerDate": "2024-07-08 10:10:30",
"approvalDate": null,
"updateDate": "2024-07-08 10:16:16",
"registerId": "swjeong75",
"updateId": "swjeong75"
}
],
"status": 200
}{
"error": {
"code": "64001",
"message": "Missing X-RCS-BrandKey header"
},
"status": 400
}{
"error": {
"code": "61003",
"message": "Invalid token"
},
"status": 401
}{
"error": {
"code": "63001",
"message": "No Brand Permission"
},
"status": 403
}error code는 RCS Biz Center - Response body error code 참조
array<object>
O
수정된 로고 ID 입니다.
code
string
5
O
20000000
status
integer
3
O
200
desc
string
O
fileId
string
수정된 로고 ID 입니다.
{
"code": "20000000",
"desc": null,
"result": [
{
"fileId": "BLG-BR.61hBmMP164-6Cqd"
}
],
"status": 200
}{
"error": {
"code": "64001",
"message": "Missing X-RCS-BrandKey header"
},
"status": 400
}{
"error": {
"code": "61003",
"message": "Invalid token"
},
"status": 401
}{
"error": {
"code": "63001",
"message": "No Brand Permission"
},
"status": 403
}error code는 RCS Biz Center - Response body error code 참조
array<object>
O
삭제된 로고 ID 입니다.
code
string
5
O
20000000
status
integer
3
O
200
desc
string
O
fileId
string
삭제된 로고 ID 입니다.
{
"code": "20000000",
"desc": null,
"result": [
{
"fileId": "BLG-BR.61hBmMP164-Jt1O"
}
],
"status": 200
}{
"error": {
"code": "64001",
"message": "Missing X-RCS-BrandKey header"
},
"status": 400
}
{
"error": {
"code": "64321",
"message": "Invalid approval status"
},
"status": 400
}{
"error": {
"code": "61003",
"message": "Invalid token"
},
"status": 401
}{
"error": {
"code": "63001",
"message": "No Brand Permission"
},
"status": 403
}error code는 RCS Biz Center - Response body error code 참조
array<object>
O
브랜드 로고 정보
code
string
5
O
20000000
status
integer
3
O
200
desc
string
O
object
O
전체 건수와 페이징 조건을 제공합니다.
object
O
이전/다음 페이지 링크를 제공합니다. offset을 0이 아닌 limit보다 작은 양수값으로 설정한 경우 prev 는 null로 응답됩니다.
fileId
string
64
로고 이미지 파일 ID 입니다.
fileUrl
string
1000
로고 이미지 파일 URL 입니다.
name
string
30
로고명 입니다.
fileName
string
256
원본 파일명 입니다.
description
string
100
로고 설명입니다.
viaTemplate
string
템플릿 등록 시 추가된 이미지가 로고로 등록된 경우 해당 템플릿(messagebase) ID 를 표시합니다. 템플릿ID가 존재하는 로고 파일ID는 다른 템플릿 등록 시 사용할 수 없습니다.
approvalResult
string
로고 승인 상태입니다.
저장 : RCS Biz Center 홈페이지에서 승인요청 하지 않고 저장 또는 승인요청 취소된 상태입니다. 저장 상태의 로고는 승인요청을 해야 승인대기 상태로 변경됩니다.
승인대기 : 로고 등록 직후 검수 이전 상태입니다.
검수시작 : 로고 검수가 시작된 상태입니다.
승인 : 검수가 완료되어 이통3사에 정보 등록까지 최종 완료되어 RCS 메시지 발송시 사용 가능한 상태입니다.
반려 : 검수 시 승인이 불가하여 반려된 상태입니다. 반려된 로고는 수정 후 다시 승인요청 할 수 있습니다.
검수완료 : RCS Biz Center에서 검수 승인 하였으나 이통사 3사 등록이 완료되지 않은 상태로 RCS 메시지를 발송시 사용할 수 없습니다.
승인대기(수정) : 승인된 로고를 수정하여 다시 승인요청한 상태입니다.
검수시작(수정) : 승인된 로고를 수정하여 다시 승인요청된 로고의 검수가 시작된 상태입니다.
반려(수정) : 승인된 로고를 수정하여 다시 승인요청 후 검수 처리 결과 반려된 상태입니다.
검수완료(수정) : 승인된 로고를 수정하여 다시 승인요청 후 검수 승인은 되었으나 이통3사 정보 갱신이 완료되지 않은 상태입니다. 현재 상태에서는 이통사에 따라 로고가 다르게 표시될 수 있습니다.
approvalReason
string
승인 사유
registerDate
string
로고 등록일시
approvalDate
string
로고 승인일시
updateDate
string
로고 수정일시
registerId
string
20
로고 등록 계정 ID
updateId
string
20
로고 수정 계정 ID
total
integer
O
전체건수
offset
integer
O
0
조회 기준 위치
limit
integer
O
100
페이지 당 조회 건수
prev
string
O
이전페이지URL
next
string
O
다음페이지URL
{
"code": "20000000",
"desc": null,
"result": [
{
"fileId": "BLG-BR.61hBmMP164-Jt1O",
"fileUrl": "https://file-qa.rcsbizcenter.com/brand/BR.61hBmMP164/logo/BLG-BR.61hBmMP164-Jt1O_1.png",
"name": "통신",
"fileName": "통신.png",
"approvalResult": "저장",
"viaTemplate": null,
"description": "통신",
"approvalReason": "승인요청 취소",
"registerDate": "2024-07-08 10:10:30",
"approvalDate": null,
"updateDate": "2024-07-08 10:16:16",
"registerId": "hong",
"updateId": "hong"
}
],
"pagination": {
"offset": 0,
"limit": 100,
"total": 1
},
"links": {
"prev": null,
"next": null
},
"status": 200
}{
"error": {
"code": "64001",
"message": "Missing X-RCS-BrandKey header"
},
"status": 400
}{
"error": {
"code": "61003",
"message": "Invalid token"
},
"status": 401
}{
"error": {
"code": "63001",
"message": "No Brand Permission"
},
"status": 403
}error code는 RCS Biz Center - Response body error code 참조
브랜드 내에서 사용할 수 있는 로고를 등록 합니다.
등록한 로고는 영구적으로 사용 가능합니다.
템플릿 등록 시 또는 메시지 발송 시 mTitleMedia, itemMedia 에는 로고 파일ID 만 지정이 가능합니다.
다음과 같은 사용은 실패를 유발하므로 주의가 필요합니다.
예1) 템플릿 등록 시 mTitleMedia 에 POST /brand/{brandId}/v2/messagebase/file 로 등록한 이미지 파일ID를 지정하면 등록 실패
예2) 메시지 발송 시 itemMedia 에 이통 메시지 파일 등록 API(POST /file)로 등록한 파일ID를 지정하면 발송 실패
maxLength: 13 - 브랜드 내 정보 접근시 사용되는 브랜드ID Path Parameter 입니다.
maxLength: 18 - RCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key 입니다.
대행사가 해당 브랜드에 대한 권한 여부를 판단하는데 사용됩니다. 따라서, 대행사 계정으로 브랜드 내 정보를 조회/등록/수정 API 연동 시 Header에 설정되어야 합니다.
브랜드 로고 등록시 사용됩니다.
maxLength: 30 - 로고명 입니다.
maxLength: 100 - 100자 이내의 로고 설명 입니다.
업로드 로고 이미지 파일을 지칭합니다.
파일형식 : gif, png, jpeg, jpg, bmp (최대 1MB)
POST /api/1.1/brand/{brandId}/logo HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer JWT
Content-Type: multipart/form-data
Accept: */*
Content-Length: 46
{
"name": "text",
"description": "text",
"file": {}
}이 문서는 브랜드 로고를 관리할수 있는 API를 안내합니다.
브랜드에 등록된 로고를 단건 상세 조회합니다.
maxLength: 13 - 브랜드 내 정보 접근시 사용되는 브랜드ID Path Parameter 입니다.
파일ID Path Parameter 입니다.
maxLength: 18 - RCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key 입니다.
대행사가 해당 브랜드에 대한 권한 여부를 판단하는데 사용됩니다. 따라서, 대행사 계정으로 브랜드 내 정보를 조회/등록/수정 API 연동 시 Header에 설정되어야 합니다.
GET /api/1.1/brand/{brandId}/logo/{fileId} HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer JWT
Accept: */*
로고의 승인요청을 취소합니다.
각 상태별 취소 요청 동작은 다음과 같습니다.
maxLength: 13 - 브랜드 내 정보 접근시 사용되는 브랜드ID Path Parameter 입니다.
파일ID Path Parameter 입니다.
maxLength: 18 - RCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key 입니다.
대행사가 해당 브랜드에 대한 권한 여부를 판단하는데 사용됩니다. 따라서, 대행사 계정으로 브랜드 내 정보를 조회/등록/수정 API 연동 시 Header에 설정되어야 합니다.
PUT /api/1.1/brand/{brandId}/logo/{fileId}/cancel HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer JWT
Accept: */*
브랜드 별 등록된 로고 목록을 조회합니다.
maxLength: 13 - 브랜드 내 정보 접근시 사용되는 브랜드ID Path Parameter 입니다.
시작 offset 번호(default: 0) 입니다.
0조회 최대 건수(default: 100, maximum: 1000) 입니다.
100maxLength: 18 - RCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key 입니다.
대행사가 해당 브랜드에 대한 권한 여부를 판단하는데 사용됩니다. 따라서, 대행사 계정으로 브랜드 내 정보를 조회/등록/수정 API 연동 시 Header에 설정되어야 합니다.
GET /api/1.1/brand/{brandId}/logo HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer JWT
Accept: */*
브랜드에 등록된 로고를 수정 승인요청 합니다.
템플릿 등록 시 또는 메시지 발송 시 mTitleMedia, itemMedia 에는 로고 파일ID 만 지정이 가능합니다.
다음과 같은 사용은 실패를 유발하므로 주의가 필요합니다.
예1) 템플릿 등록 시 mTitleMedia 에 POST /brand/{brandId}/v2/messagebase/file 로 등록한 이미지 파일ID를 지정하면 등록 실패
예2) 메시지 발송 시 itemMedia 에 이통 메시지 파일 등록 API(POST /file)로 등록한 파일ID를 지정하면 발송 실패
maxLength: 13 - 브랜드 내 정보 접근시 사용되는 브랜드ID Path Parameter 입니다.
파일ID Path Parameter 입니다.
maxLength: 18 - RCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key 입니다.
대행사가 해당 브랜드에 대한 권한 여부를 판단하는데 사용됩니다. 따라서, 대행사 계정으로 브랜드 내 정보를 조회/등록/수정 API 연동 시 Header에 설정되어야 합니다.
브랜드 로고 등록시 사용됩니다.
maxLength: 30 - 로고명 입니다.
maxLength: 100 - 100자 이내의 로고 설명 입니다.
업로드 로고 이미지 파일을 지칭합니다.
파일형식 : gif, png, jpeg, jpg, bmp (최대 1MB)
PUT /api/1.1/brand/{brandId}/logo/{fileId} HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer JWT
Content-Type: multipart/form-data
Accept: */*
Content-Length: 46
{
"name": "text",
"description": "text",
"file": {}
}브랜드에 등록된 승인 이전 상태의 로고를 삭제 합니다.
maxLength: 13 - 브랜드 내 정보 접근시 사용되는 브랜드ID Path Parameter 입니다.
파일ID Path Parameter 입니다.
maxLength: 18 - RCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key 입니다.
대행사가 해당 브랜드에 대한 권한 여부를 판단하는데 사용됩니다. 따라서, 대행사 계정으로 브랜드 내 정보를 조회/등록/수정 API 연동 시 Header에 설정되어야 합니다.
DELETE /api/1.1/brand/{brandId}/logo/{fileId} HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer JWT
Accept: */*