Skip to Content
API参考消息

消息

管理项目的 1 对 1 消息线程并向其追加消息。

GET/v1/messages

ParameterTypeDescription
statusstring筛选线程:open或closed。
limitinteger页面大小。默认为20。
offsetinteger跳过的项目数。默认为0。

GET/v1/messages/:threadId

POST/v1/messages

ParameterTypeDescription
emailrequiredstring线程的最终用户的电子邮件。
namestring最终用户的显示名称。
subjectstring线程主题。
bodystring线程中的第一条消息(可选)。
localestring所触发通知邮件的语言(en、de、es、fr、it、ja、ru、zh)。默认为 en。

PATCH/v1/messages/:threadId

ParameterTypeDescription
statusstringopen或closed。
subjectstring线程的新主题。

DELETE/v1/messages/:threadId

POST/v1/messages/:threadId/messages

ParameterTypeDescription
bodyrequiredstring消息文本。
senderstringend_user、member或system。默认为member。
localestring所触发通知邮件的语言(en、de、es、fr、it、ja、ru、zh)。默认为 en。

写入需要付费计划的API访问 Pro

通知:写入操作会通知到人,取决于是谁发的消息。

发送者通知对象
end_user项目成员,遵循各自的通知偏好 — 以及 Slack、出站 webhook 和推送
member最终用户,通过邮件送达,并归入同一会话
system无人

POST /v1/messages 携带 body 时,该内容记录为 member 消息,因此会向最终用户发送邮件。 送达在响应之后进行,通知不会拖慢你的请求。

任何写入都可以传入可选的 localeendeesfritjaruzh)来选择所触发 邮件的语言。未提供时使用英文。

Last updated on