대행사 브랜드 목록 조회

Request

대행사가 계약된 브랜드 리스트를 제공합니다.

get

https://api-qa.rcsbizcenter.com/api/1.1https://api.rcsbizcenter.com/api/1.1

/agency/{agencyId}/contract

대행사가 계약된 브랜드 리스트를 제공합니다. 브랜드별 기업의 사업자등록번호를 함께 전달 하여 대행사에 등록된 기업 정보와 맵핑할 수 있습니다.

• 계정 권한: 대행사

Authorizations

jwtAuth

AuthorizationstringRequired

인증방식은 JWT인증을 사용합니다. 토큰의 갱신은 없으며 토큰 만료 시 항상 재발급 받아야 합니다.

Path parameters

agencyIdstring · max: 20Required

maxLength: 20 - RCS Biz Center에 등록된 대행사 ID 입니다.

Query parameters

offsetintegerOptional

시작 offset 번호(default: 0) 입니다.

Default: 0

limitinteger · min: 100 · max: 1000Optional

minimum: 100, maximum: 1000 - 조회 최대 건수(default: 100) 입니다.'

Default: 100

Responses

200

페이지 내 Response 섹션 참조

No content

get

/agency/{agencyId}/contract

HTTPcURLJavaScriptPython

GET /api/1.1/agency/{agencyId}/contract HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

페이지 내 Response 섹션 참조

No content

Response

필드명	타입	길이	필수여부	기본값	설명
result	array<object>		O		브랜드와 대행사의 계약관계 정보입니다.
code	string	5	O	20000000
status	integer	3	O	200
desc	string		O
pagination	object		O		전체 건수와 페이징 조건을 제공합니다.
links	object		O		이전/다음 페이지 링크를 제공합니다. offset을 0이 아닌 limit보다 작은 양수값으로 설정한 경우 prev 는 null로 응답됩니다.

result - array<object>

필드명	타입	길이	필수여부	기본값	설명
corpId	string	13	O		RCS Biz Center에 등록된 기업 ID 입니다.
corpRegNum	string	10	O		RCS Biz Center에 등록된 기업의 사업자등록번호 입니다.
brandId	string	13	O		브랜드 ID 입니다.
brandName	string	20	O		브랜드 명 입니다.
agencyId	string	20	O		대행사 ID 입니다
contracts	array<string>				계약 유형 입니다 a2p chat
registerDate	string				계약정보 등록일시 입니다.
updateDate	string				계약정보 수정일시 입니다.
brandDate	string				계약된 대상 브랜드의 최종 변경 일시 정보 입니다.
chatbotDate	string				브랜드 내 등록된 대화방 중 가장 최근에 변경된 대화방의 일시 정보 입니다.
messagebaseDate	string				브랜드 내 등록된 템플릿 중 가장 최근에 변경된 템플릿의 일시 정보 입니다.
logoDate	string				브랜드 내 등록된 브랜드 로고 중 가장 최근에 변경된 로고의 일시 정보 입니다.

contracts - array<string>

필드명	타입	길이	필수여부	기본값	설명
Allowed	string				계약 유형 입니다. a2p chat

pagination - object

필드명	타입	길이	필수여부	기본값	설명
total	integer		O		전체건수
offset	integer		O		조회 기준 위치
limit	integer		O		페이지 당 조회 건수

links - object

필드명	타입	길이	필수여부	기본값	설명
prev	string		O		이전페이지URL
next	string		O		다음페이지URL

❖ response body sample

200

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "corpId": "CO.l9ZohLN20I",
            "corpRegNum": "3148158360",
            "brandId": "BR.i3gC1762pT",
            "brandName": "테스트브랜드",
            "status": "검수완료(수정)",
            "agencyId": "hong",
            "contracts": [
                "a2p,chat"
            ],
            "registerDate": "2024-06-10T16:39:14.000+09",
            "updateDate": "2024-06-10T16:39:14.000+09",
            "brandDate": "2024-06-05T15:27:19.000+09",
            "chatbotDate": "2024-06-05T15:27:17.000+09",
            "messagebaseDate": "2024-06-05T15:27:21.000+09",
            "logoDate": null,
            "approvalDate": "2024-06-10T10:16:59.000+09"
        }
    ],
    "pagination": {
        "offset": 0,
        "limit": 100,
        "total": 1
    },
    "links": {
        "prev": null,
        "next": null
    },
    "status": 200
}

204

401

error code는 RCS Biz Center - Response body error code 참조