Description

Upload CRM creative files.

Request Specification

HTTP Method: POST + application/json

Request URL: https://${cloud domain}/media/upload?thirdTraceId=${Random String}

Request Headers: Refer to Common Parameters

Example (using curl command to upload a media file via FORM):

curl -F "media=@test.jpg" http://open.fxiaoke.com/media/upload?corpAccessToken=xxx&corpId=xxx&type=image

File size limits:

• Image type: Max 20MB, supports JPG, PNG, GIF, BMP, JPEG formats
• Document type: Max 100MB

Note: mediaId is reusable. The same mediaId can be used for CRM object's image and file type fields.

Request Parameters

Parameter	Type	Required	Description
type	String	Yes	File type. Currently supports: image (CRM creative), document (document type, supports approval creative and CRM creative)
igonreMediaIdConvert	Boolean	Yes	mediaId type. When true, the returned mediaId value is npath; when false, it's mediaId. Upload and download should use the same value (recommended: true)
media		Yes	Binary stream containing media file identifier in form-data, including filename, filelength, content-type etc.

Request Example

{
  "media": "hello",
  "type": 1,
  "igonreMediaIdConvert": 1
}

Response Parameters

Parameter	Type	Description
traceId	string	Unique request ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	Error codes reference

Response Example

{
  "traceId": "E-O.827xxxxxx",
  "errorDescription": "success",
  "errorMessage": "OK",
  "errorCode": 0
}

Notes

• Do not use the message field in response for logical judgment as errorMessage may change;