Download a User's Face Image

Download the face image of a specific user.

Prerequisites

Administrator has set facial recognition as the authentication method.

Procedures

  1. Get the download URL of a user's face image
  2. Get and decode the Base64 string of the user's face image

Get the download URL of a user's face image

Request URL
GET {base_url}/services/openapi/v1.0/user/user_image/{memberId}
Request parameters
Path parameters
Parameter Required Type Description
memberId Yes Long User's member ID.
Note: You can query the user's member ID using the Query Multiple Users interface.
Response parameters
Parameter Type Description
data Object <Details> The detailed information
status String The result of the request.
  • Success
  • Failed
requestId String The ID of the request, which can be used to quickly locate the request.
Details
Parameter Type Description
imageDownloadUrl String The download link of the user's face image.
expiredTime Integer The validity period of the download link (Unit: second).
Example
Request example
Get the face image download URL of a specific user (member ID: 466).
GET /services/openapi/v1.0/user/user_image/466 HTTP/1.1
Host: workplace.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsiL29wZW5hcGkvIl0sImVudGVycHJpc2VfaWQiOjEwMDQzMywicmVnaW9uIjoiR0wiLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJjZjc3NTg4OC1mM2QwLTRkNDMtODJiYy00NjQ4NWZjYTY0MzIiLCJjbGllbnRfaWQiOiI3OTU2OGFhMC0wYjBkLTQyZjYtOGRiNC03OWExNmQ3MzQ3MmEiLCJ0cyI6MTY4OTkwNTE3MCwiZXhwX2luIjo4NjQwMH0.QULcMVk5CJWNnZFrHp2TYH-P1cdvPoFn4jYYEwSs0Ps
Response example
HTTP/1.1 200 OK
{
    "data": {
        "imageDownloadUrl": "https://example.domain.com/yeastar-workplace/face_features/100433/IMAGE/466/12193767-f7bb-4db9-b384-c1326896c83e.txt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230721T073024Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1799&X-Amz-Credential=AKIASL5ITTRYOTF6CSP6%2F20230721%2Fcn-north-1%2Fs3%2Faws4_request&X-Amz-Signature=b3fba28538eb6f2797364643e6c0be063d890aa3fda4976df8afd5e13f7e82f6",
        "expiredTime": 1800
    },
    "status": "Success",
    "requestId": "0efc6fab4cdf4df4ac06f826bdb67bad"
}

Get and decode the Base64 string of the user's face image

  1. Use HTTP GET method along with the download URL to get the Base64 string of the face image, as the following example shows:
    Tip: You can also directly open the URL in a browser, and a text file containing the Base64 string will be automatically downloaded into your PC.
    GET {download_link}
    Upon sending the request, you will get a Base64 string.
  2. Decode the Base64 string to obtain the user's face image.