list_outreach_messages(brand_id, bucket, direction_path_id?, q?, limit?, offset?)
列出一个收件箱分组里的外联邮件。待审和已排期的行包含主题和正文。已发送、失败和暂扣的行包含主题和状态,不含正文。暂扣的行包含暂扣原因。搜索匹配主题和门店名称。不含邮箱和电话。get_outreach_message 可返回任意分组中一封邮件的正文。发送留在应用里。
参数
- brand_idstring必填
- 用户已确认的品牌。
- bucketstring必填
- review、held、scheduled、sent 或 failed 之一。
- direction_path_idstring可选
- 只列出一个方向。
- qstring可选
- 匹配主题和门店名称。不匹配邮箱地址。
- limitnumber可选
- 每页条数。不超过收件箱页最大条数。
- offsetnumber可选
- 页偏移。
返回
- messagesarray
- 每行包含 message_id、subject、status、send_state、scheduled_at、sent_at、failure_cause、direction_path_id、direction_title、candidate_organization_name、revision 和 app_link。review 和 scheduled 包含 body_text。held 包含 hold_reason。
- bucket_totalsobject
- 各收件箱分组的数量。
- direction_summariesarray
- 每个方向:path_id、strategy_id、title、review_count、failed_count、drafting、autopilot_on、scheduled_count 和 held_count。
- totalnumber
- 匹配此列表的行数。
- limitnumber
- 本次使用的每页条数。
- offsetnumber
- 本次使用的页偏移。
- has_nextboolean
- 是否还有下一页。