All Products
Search

This Product

    Drive and Photo Service:ShareLink

    Document Center

    Drive and Photo Service:ShareLink

    Last Updated:Sep 29, 2024
    ParameterTypeDescriptionExample
    share_idstring

    The share ID.

    		7JQX1FswpQ8
    share_pwdstring

    The access code. An access code can be up to 64 characters in length. If you do not specify a value, files can be accessed without an access code.

    		abcF123x
    drive_idstring

    The drive ID.

    		1
    file_id_liststring

    The IDs of the files to share in the parent path.

    		["520b217f13adf4fc24f2191991b1664ce045b393"]
    expirationstring

    The time when the share URL expires. The value of this parameter follows the RFC 3339 standard. Example: "2020-06-28T11:33:00.000+08:00". If you set the value to "", the share URL never expires.

    		2020-06-28T11:33:00.000+08:00
    expiredboolean

    Specifies whether the share is expired.

    		false
    created_atstring

    The time when the share was created.

    		2019-08-20T06:51:27.292Z
    updated_atstring

    The time when the share was last modified.

    		2019-08-20T06:51:27.292Z
    descriptionstring

    The description of the share.

    		videos
    share_namestring

    The name of the share. By default, the file name that corresponds to the first ID in the file ID list is used.

    		video-1.MP4
    creatorstring

    The user who created the share.

    		c9b7a5aa04d14ae3867fdc886fa01da4
    statusstring

    The status of the share. Valid values:

    • disabled: The share is canceled.
    • enabled: The share is effective.
    		enabled
    preview_countlong

    The number of times that the shared files are previewed.

    		10
    save_countlong

    The number of times that the shared files are saved.

    		2
    download_countlong

    The number of times that the shared files are downloaded.

    		5
    report_countlong

    The number of times that the shared files are reported.

    		0
    video_preview_countlong

    The number of times that the shared audio and video files are played.

    		1
    access_countlong

    The number of times that the shared files are visited.

    		4
    disable_previewboolean

    Specifies whether to disable the preview feature.

    		false
    disable_saveboolean

    Specifies whether to disable the save feature.

    		false
    disable_downloadboolean

    Specifies whether to disable the download feature.

    		false
    preview_limitlong

    The limit on the number of times that the shared files can be previewed.

    		100
    save_limitlong

    The limit on the number of times that the shared files can be saved.

    		100
    download_limitlong

    The limit on the number of times that the shared files can be downloaded.

    		100
    share_all_filesboolean

    Specifies whether to share all files in the drive.

    		true