POST /shared-links/{sharedId}/email
基本信息
Note: 该端点在Alfresco 5.2和更高版本中可用。
发送带有特定于应用程序的URL的电子邮件,其中包括标识符sharedId。
在请求正文中,client和receiveEmails属性是必需的。 例如,通过电子邮件发送包含最少信息的shared-links:
{ "client": "myClient", "recipientEmails": ["john.doe@acme.com", "joe.bloggs@acme.com"] }
可以选择在请求正文中提供纯文本消息属性,以自定义发送的电子邮件。 另外,可以在请求正文中选择性地提供语言环境属性,以使用特定语言发送电子邮件(如果该语言环境受Alfresco支持)。 例如,通过电子邮件发送包含消息和语言环境的shared-links:
{ "client": "myClient", "recipientEmails": ["john.doe@acme.com", "joe.bloggs@acme.com"], "message": "myMessage", "locale":"en-GB" }
Note:您必须先注册客户端,然后才能发送共享链接电子邮件。 请参阅[服务器文档]。 但是,现成的共享(share)已注册为默认客户端,因此您可以将共享作为客户端名称传递:
{ "client": "share", "recipientEmails": ["john.doe@acme.com"] }
请求方式 :POST
请求API :/ shared-links / {sharedId} / email
Path参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
sharedId | string | 是 | 指向文件的shared-links的标识符。 |
Body参数(sharedLinkBodyEmail)
request body示例
{ "client": "string", "message": "string", "locale": "string", "recipientEmails": [ "string" ] }
错误信息描述
状态码 | 原因 |
202 | 成功回应 |
400 | 无效的参数:sharedId无效,或者sharedLinkBodyEmail无效 |
401 | 验证失败 |
404 | sharedId不存在或客户端未注册 |
501 | 系统禁用了shared-links |
default | 意外错误 |
返回结果示例
{ "error": { "errorKey": "string", "statusCode": 0, "briefSummary": "string", "stackTrace": "string", "descriptionURL": "string", "logId": "string" } }