API Đồ thị
Phiên bản API Đồ thị

Page Live Videos

Đọc

Page Live Videos

Requirements

For Pages you own or for which you can perform the MODERATE task, you will need:

For Pages you do not own or for which you cannot perform the MODERATE task, you will need:

Để tránh gặp sự cố giới hạn tốc độ khi sử dụng tính năng Truy cập vào nội dung công khai trên Trang, hãy dùng mã truy cập của người dùng hệ thống.

New Page Experience

This endpoint is supported for New Page Experience.

Feature Permissions

TênMô tả
Quyền truy cập nội dung công khai trên TrangThis feature permission may be required.

Ví dụ

Graph API Explorer
GET /v19.0/{page-id}/live_videos HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{page-id}/live_videos',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{page-id}/live_videos",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{page-id}/live_videos",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{page-id}/live_videos"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
Nếu bạn muốn tìm hiểu cách sử dụng API Đồ thị, hãy đọc Hướng dẫn sử dụng API Đồ thị của chúng tôi.

Thông số

Thông sốMô tả
broadcast_status
list<enum {UNPUBLISHED, LIVE, LIVE_STOPPED, PROCESSING, VOD, SCHEDULED_UNPUBLISHED, SCHEDULED_LIVE, SCHEDULED_EXPIRED, SCHEDULED_CANCELED}>

Allows you to specify what kind of live videos return. No value returns all status types

source
enum{target, owner}
Giá trị mặc định: target

Specifies what the source of the videos should be. 'target' gets videos broadcasted onto the page's timeline, 'owner' gets videos made by the page. (Note: When the source is set to 'target', unpublished videos will not be returned as they do not have an assigned target at that point.)

Trường

Đọc từ cạnh này sẽ trả về một kết quả JSON đã định dạng:

{
    "data": [],
    "paging": {}
}

data

Danh sách nút LiveVideo.

paging

Để biết thêm chi tiết về chia trang, hãy xem hướng dẫn về API Đồ thị.

Mã lỗi

LỗiMô tả
100Invalid parameter
190Invalid OAuth 2.0 Access Token
200Permissions error
210User not visible

Tạo

Bạn có thể tạo yêu cầu POST đến cạnh live_videos từ các đường dẫn sau:
Khi đăng lên cạnh này, hệ thống sẽ tạo a LiveVideo.

Tính năng lên lịch phát video trực tiếp đã ngừng hoạt động trong phiên bản 12.0 và sẽ ngừng hoạt động trong mọi phiên bản vào ngày 14/12/2021. Các lệnh gọi đến điểm cuối POST /ID/live-video bằng thông số planned_start_time sẽ trả về lỗi.

Thông số

Thông sốMô tả
content_tags
list<numeric string>

Tags that describe the contents of the video. Use search endpoint with type=adinterest to get possible IDs.

                                                  Example:
                                                  ~~~~
                                                  /search?type=adinterest&q=couscous
                                                  ~~~~

crossposting_actions
array<JSON object>

List of desired changes to crossposting for this broadcast. Each change must provide a page_id and action. Example:

[ {page_id: 1234, action: 'enable_crossposting'}, {page_id: 4567, action: 'enable_crossposting_and_create_post'} ]

Available action types:

  • enable_crossposting: Enables crossposting for this broadcast with the Page if it is not currently enabled. No change if crossposting is already enabled with the Page for this broadcast.
  • disable_crossposting: Disables crossposting for this broadcast with the Page if it is currently enabled. No change if crossposting is not already enabled with the Page for this broadcast.
  • enable_crossposting_and_create_post: Same as enable_crossposting, but will also create a post as the Page. The post will be created even if crossposting is already enabled for the Page. This option is subject to your live crossposting relationships and will fail for Pages without the required permission.

When used with a Live Online Event, this will apply to the event.

page_id
page ID

page_id

Bắt buộc
action
enum {ENABLE_CROSSPOSTING, DISABLE_CROSSPOSTING, ENABLE_CROSSPOSTING_AND_CREATE_POST}

action

Bắt buộc
custom_labels
list<string>

Labels used to describe the video. Unlike content tags, custom labels are not published and only appear in insights data.

description
UTF-8 string

The description of the live video.

Hỗ trợ biểu tượng cảm xúc
donate_button_charity_id
numeric string or integer

Specifies the ID of the charity for which a donate button will be added to the live video.

enable_backup_ingest
boolean

Set this to true to enable a backup ingest url. stop_on_delete_stream defaults to false when set

encoding_settings
string

Identifier of the encoding settings group the broadcaster is using for this stream. This parameter is currently only in use for live-360 broadcasts. The value to be passed to this parameter is the value of the identifier key of the encoding settings preset. Encoding presets can be found by querying the /broadcaster_encoding_settings Graph API endpoint (GET query).

event_params
Live Video Event Parameter

Parameters specific to Live Online Event broadcast. If start_time (unix timecode) is set, LOE's start time will be updated. Also, cover (url) uploads an image to use as the cover photo for the event.

Example: { start_time: 1641013200, cover: 'https://your.url/image.jpg', }

fisheye_video_cropped
boolean

Whether the single fisheye video is cropped or not

front_z_rotation
float

The front z rotation in degrees on the single fisheye video

game_show
JSON object

Configure this live stream to be a game show

game_type
enum {KNOCKOUT}

game_type

Bắt buộc
is_spherical
boolean

Flag that denotes the broadcast is a 360 live broadcast.

original_fov
int64

Original field of view of the camera

privacy
Privacy Parameter

Privacy for this live video.

product_items
list<numeric string>

Products which will be shown with live videos.

projection
enum {EQUIRECTANGULAR, CUBEMAP, HALF_EQUIRECTANGULAR}

Flag that denotes expected projection for 360 live streams. The default value is EQUIRECTANGULAR.

published
boolean

Set this to false to preview the stream before going live.

                                                  Deprecated. Prefer setting the status instead.

schedule_custom_profile_image
image

Custom image that will appear in the scheduled live story and lobby.

spatial_audio_format
enum {ambiX_4}

Denotes the format of the spatial audio stream. When unspecified audio is presumed to be mono or stereo.

status
enum {UNPUBLISHED, LIVE_NOW, SCHEDULED_UNPUBLISHED, SCHEDULED_LIVE, SCHEDULED_CANCELED}

The status of the broadcast. A LIVE_NOW broadcast is currently live and visible to users. An UNPUBLISHED broadcast is in preparation; it's not visible to other users, and it may be automatically deleted after several hours in this state. (Consider using the SCHEDULED states to create a planned, future broadcast.)

stereoscopic_mode
enum {MONO, LEFT_RIGHT, TOP_BOTTOM}

Set this parameter to the stereoscopic mode for this video.

stop_on_delete_stream
boolean

Set this to true if stream should be stopped when deleteStream RTMP command received.

targeting
target

Object that limits the audience for this content. Anyone not in these demographics will not be able to view this content.

When used with a Live Online Event, this will apply to the event.

geo_locations
Object

countries
list<string>

regions
list<Object>

key
int64

cities
list<Object>

key
int64

zips
list<Object>

key
string

locales
list<string>

excluded_countries
list<string>

excluded_regions
list<int64>

excluded_cities
list<int64>

excluded_zipcodes
list<string>

timezones
list<int64>

age_min
enum {13, 15, 18, 21, 25}

title
UTF-8 string

The title of the live video. Maximum 254 characters.

Hỗ trợ biểu tượng cảm xúc

Kiểu trả về

This endpoint supports read-after-write and will read the node represented by id in the return type.
Struct {
id: numeric string,
stream_url: string,
secure_stream_url: string,
stream_secondary_urls: List [
string
],
secure_stream_secondary_urls: List [
string
],
dash_ingest_url: string,
dash_ingest_secondary_urls: List [
string
],
event_id: numeric string,
}

Mã lỗi

LỗiMô tả
200Permissions error
368The action attempted has been deemed abusive or is otherwise disallowed
100Invalid parameter
190Invalid OAuth 2.0 Access Token
1000Invalid time for an event.
1005Fail to upload cover photo.
102Session key invalid or no longer valid

Cập nhật

Bạn không thể thực hiện thao tác này trên điểm cuối này.

Xóa

Bạn không thể thực hiện thao tác này trên điểm cuối này.