Get Media File

Retrieve information about files uploaded to WhatsApp through the API.

• URL: https://api2.nxcloud.com/api/wa/getMedia
• Method: POST
• Content-Type: application/json
• Requires authentication: Yes

Authentication Mechanism

Please refer to the following link for authentication rules: API Interface Call Convention

Request Parameters

Header Parameters:

Parameter Name	Type	Required	Example	Description
accessKey	String	Yes	fme2na3kdi3ki	User identity identifier
ts	String	Yes	1655710885431	Current timestamp of the request (in milliseconds). The maximum allowed time difference is 60 seconds on the server side.
bizType	String	Yes	2	WhatsApp business type, fixed value "2"
action	String	Yes	getMedia	WhatsApp business operation, fixed value "getMedia"
sign	String	Yes	6e9506557d1f289501d333ee2c365826	API input parameter signature, signature algorithm

Body Parameters:

Parameter Name	Type	Required	Example	Description
business_phone	String	Yes	86158xxxx1795	Merchant phone number, including the country code. For example: 86158xxxx1795
messaging_product	String	Yes	whatsapp	Channel for sending messages, must be "whatsapp" for WhatsApp messages
Media-ID	String	Yes	fd81acff-eea8-4d9d-acc9-6c62904d6615	Media file ID

Request Example

Body (application/json) parameters:

{
    "business_phone": "86158xxxx1795",
    "Media-ID": "fd81acff-eea8-4d9d-acc9-6c62904d6615",
    "messaging_product": "whatsapp"
}

Response Parameters

Parameter Name	Type	Description
code	Integer	Result code
data	JsonObject	Request result
message	String	Request result description

• data JsonObject parameters:

Parameter Name	Type	Description
mime_type	String	File type
file_name	String	File name
url	String	File download URL

Response Example

Successful Example

{
    "code": 0,
    "data": {
        "mime_type": "image/webp",
        "file_name": "c5e744fab2a3b69941ed3c64",
        "url": "https://goss.oss-cn-hongkong.aliyuncs.com/1b0a4c77-c5e7-44fa-b2a3-b69941ed3c64?Expires=1663747602&OSSAccessKeyId=LTAI5tBrjWM5EyDe6MA5uc7z&Signature=EW1KaByzd3rybo2swNSEKkpF5Lk%3D"
    },
    "message": "Request successful"
}

Failed Example

{
    "code": -1,
    "message": "Request failed",
    "data": null
}

Response Code Explanation

code	message	Solution
0	Request successful
-1	Request failed	Please contact technical support to troubleshoot the issue
1000~100X	Authentication issue	Refer to the API authentication section for details
9000	Parameter exception	Missing parameters, please check the required parameters
9001	System business error	Please contact technical support to troubleshoot the issue
9002	Merchant phone number error	Please confirm if the merchant number belongs to a WhatsApp number
9006	WhatsApp number not bound to the application	Please contact the business personnel to handle the binding operation between the application and the phone number