Bỏ qua tới phần tài liệu
SDK

Audience

`audiences.list`, `get`, `create`, `update`, `delete`, `listContacts`, `addContact` và `removeContact`.

Mọi phương thức

audiences.ts
const audiences = await openemail.audiences.list()const everyone = audiences.find((audience) => audience.builtin === 'default') const list = await openemail.audiences.create({  name: 'Product updates',  description: 'Customers who asked to hear about releases',}) await openemail.contacts.create({ email: '[email protected]', name: 'Grace Hopper' })await openemail.audiences.addContact(list.id, { email: '[email protected]' }) const members = await openemail.audiences.listContacts(list.id, { limit: 200 }) await openemail.audiences.update(list.id, { name: 'Release notes' })await openemail.audiences.removeContact(list.id, '[email protected]')await openemail.audiences.delete(list.id) console.log(everyone?.contactCount, members.length)

Một audience là một danh sách contact có tên trong workspace này. Mọi contact đều thuộc audience mặc định có sẵn ngay từ khi được tạo, và builtin là trường đánh dấu bản ghi đó; phần còn lại do bạn tạo, thêm thành viên và xóa. Hãy rẽ nhánh theo builtin chứ không theo tên, vì ai cũng đổi được tên.

Phiên bản này quản lý danh sách và không gửi gì tới chúng. Không có phương thức broadcast nào để tìm, và đưa một contact vào một audience là thao tác ghi vào audience chứ không phải vào contact, nên audiences:write là scope duy nhất được kiểm tra.

addContact nhận một địa chỉ đã là contact và từ chối địa chỉ chưa phải contact, với 422 contact_not_found. Hãy lưu nó bằng openemail.contacts.create trước. Thêm cùng một người hai lần sẽ trả về bản ghi thành viên đã có, kèm addedAt ban đầu, nên lệnh gọi này an toàn khi thử lại.

Audience mặc định có thể đổi tên và mô tả như mọi audience khác, nhưng không thể bị xóa và không thể bị bớt thành viên. Cả hai đều bị từ chối với 409 audience_immutable. Hãy xóa contact khi bạn thực sự muốn contact đó biến mất.

Phản hồi: AudienceResource

list phân giải ra một mảng thuần các object này, audience mặc định đứng đầu và phần còn lại mới nhất trước, còn get, createupdate mỗi cái phân giải ra một object. listContacts thì phân giải ra một mảng ContactResource, tức là chính các contact chứ không phải bản ghi thành viên.

idstring
Định danh bền vững, `aud_` theo sau là 24 ký tự hex. Tên không duy nhất, nên đây mới là thứ nên lưu trong cấu hình.
namestring
Được cắt khoảng trắng khi ghi, từ 1 đến 120 ký tự. Hai audience có thể trùng tên, vì audience được xác định bằng id.
descriptionstring | null
Văn bản tự do cho người đọc danh sách về sau. Null khi chưa ai viết gì, và một null tường minh trên `update` sẽ xóa nó.
builtin'default' | (string & {}) | null
`default` trên đúng một bản ghi mỗi workspace, là audience chứa mọi contact, và null trên mọi audience do người dùng tạo. Union được để mở để một giá trị built-in thêm về sau vẫn được thu hẹp kiểu trong trình soạn thảo mà không phá vỡ kiểu đã công bố.
contactCountnumber
Số contact trong audience, được đếm tại thời điểm đọc chứ không lấy từ cache. Hai lần đọc trước và sau một `contacts.create` sẽ chênh nhau một.
createdAtstring
ISO-8601 UTC, thời điểm audience được tạo. Quyết định thứ tự danh sách sau audience mặc định.
updatedAtstring
ISO-8601 UTC, được cập nhật khi đổi tên hoặc đổi mô tả. Thay đổi thành viên không ảnh hưởng tới nó.