Skip to main content
GET
搜索消息

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求头

Authorization
string
必填

Bearer 身份验证

路径参数

inbox_id
string
必填

收件箱的 ID。

查询参数

q
string
必填

全文搜索查询。匹配发件人、收件人、 主题(子字符串)和消息正文(词元化全文)。

limit
integer

返回项目数量的上限。

page_token
string

用于分页的页面 token。

before
string<date-time>

用于筛选的截止时间戳。

after
string<date-time>

用于筛选此时间戳之后数据的时间戳。

响应

状态码为 200 的响应

count
integer
必填

返回的项目数量。

messages
SearchMessageItem · object[]
必填

按相关性排序,最佳匹配项优先。

limit
integer

返回项目数量的上限。

next_page_token
string

用于分页的页面 token。