消息
管理项目的 1 对 1 消息线程并向其追加消息。
GET/v1/messages
| Parameter | Type | Description |
|---|---|---|
status | string | 筛选线程:open或closed。 |
limit | integer | 页面大小。默认为20。 |
offset | integer | 跳过的项目数。默认为0。 |
GET/v1/messages/:threadId
POST/v1/messages
| Parameter | Type | Description |
|---|---|---|
emailrequired | string | 线程的最终用户的电子邮件。 |
name | string | 最终用户的显示名称。 |
subject | string | 线程主题。 |
body | string | 线程中的第一条消息(可选)。 |
locale | string | 所触发通知邮件的语言(en、de、es、fr、it、ja、ru、zh)。默认为 en。 |
PATCH/v1/messages/:threadId
| Parameter | Type | Description |
|---|---|---|
status | string | open或closed。 |
subject | string | 线程的新主题。 |
DELETE/v1/messages/:threadId
POST/v1/messages/:threadId/messages
| Parameter | Type | Description |
|---|---|---|
bodyrequired | string | 消息文本。 |
sender | string | end_user、member或system。默认为member。 |
locale | string | 所触发通知邮件的语言(en、de、es、fr、it、ja、ru、zh)。默认为 en。 |
写入需要付费计划的API访问 Pro。
通知:写入操作会通知到人,取决于是谁发的消息。
| 发送者 | 通知对象 |
|---|---|
end_user | 项目成员,遵循各自的通知偏好 — 以及 Slack、出站 webhook 和推送 |
member | 最终用户,通过邮件送达,并归入同一会话 |
system | 无人 |
POST /v1/messages 携带 body 时,该内容记录为 member 消息,因此会向最终用户发送邮件。
送达在响应之后进行,通知不会拖慢你的请求。
任何写入都可以传入可选的 locale(en、de、es、fr、it、ja、ru、zh)来选择所触发
邮件的语言。未提供时使用英文。
Last updated on