방송의 상세 정보 목록을 조회합니다.
날짜와 방송의 상태 등의 조건으로 검색할 수 있습니다.
인증 정보가 필요하지 않은 공개 API입니다.
모아보기 페이지 구성을 위해 사용할 수 있습니다.
- 준비중, 진행중 혹은 종료된 방송에 대한 상세 페이지를 직접 구성할 수 있습니다.
- 날짜 범위와 상태 등을 제한하여 검색할 수 있습니다.
- 방송 상세 설정에서
모아보기 공개여부가공개로 설정되어 있어야 조회가 가능합니다.
GET https://api.shoplive.cloud/v1/campaigns/{accessKey}
REQUEST
| Parameter | Type | Source | Req? | Description | Note |
|---|---|---|---|---|---|
| accessKey | string | path | O | 발급 받은 access key | |
| status | string | query | 조회할 방송의 상태 | READY 준비중ONAIR 진행중CLOSED 종료됨값이 없으면 전체 상태에 대해 조회합니다. | |
| from | timestamp(int64) | query | 시작 날짜 | 날짜 범위 지정 시작 날짜입니다. 초 단위 와 밀리초 단위를 모두 지원합니다. | |
| to | timestamp(int64) | query | 종료 날짜 | 날짜 범위 지정 종료 날짜입니다. 초 단위와 밀리초 단위를 모두 지원합니다. | |
| ascending | bool | query | 날짜 스캔 순서 | 캠페인의 날짜(방송 예정일) 검색 시 정순 혹은 역순으로 스캔/반환할 것인 지 여부입니다. 기본은 false(역순)입니다. | |
| resolutionLevel | int32 | query | 해상도 레벨 | 미리보기 URL(previewLiveUrl)의 해상도를 지정할 수 있습니다.1 320p(기본값) 2 480p3 720p4 1080p레벨에 따른 실제 해상도는 변경될 수 있습니다. | |
| rehearsalAsOnAir | bool | query | 리허설을 방송중 정보로 조회할 것인지 여부 | true인 경우 리허설 상태의 방송 상세 정보를 조회할 수 있습니다. | |
| page | int32 | query | 페이지 | 기본값은 1입니다. | |
| count | int32 | query | 결과 목록 수 | 기본값은 10입니다.최대 30까지 지정할 수 있습니다. |
RESPONSE
| Parameter | Type | Description |
|---|---|---|
| results | list <CampaignInfo> | 방송 상세 정보 목록 |
| totalCount | int32 | 전체 건수 |
모아보기 페이지 구성 예제는 하단 링크에서 확인하실 수 있습니다.