오디언스
`audiences.list`, `get`, `create`, `update`, `delete`, `listContacts`, `addContact`, `removeContact`.
모든 메서드
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)오디언스는 이 워크스페이스에 있는, 이름이 붙은 연락처 목록입니다. 모든 연락처는 생성되는 순간부터 기본 내장 오디언스에 포함되며, 그 행을 가리키는 것이 builtin입니다. 나머지는 직접 만들고 채우고 삭제하면 됩니다. 누구나 바꿀 수 있는 이름이 아니라 builtin으로 분기하세요.
이 버전은 목록을 관리할 뿐 목록에 아무것도 보내지 않습니다. 찾아 헤맬 브로드캐스트 메서드는 없으며, 연락처를 오디언스에 넣는 것은 연락처가 아니라 오디언스에 대한 쓰기이므로 검사하는 스코프는 audiences:write 하나뿐입니다.
addContact는 이미 연락처인 주소를 받고, 그렇지 않은 주소는 422 contact_not_found로 거부합니다. 먼저 openemail.contacts.create로 저장하세요. 같은 사람을 두 번 추가하면 이미 존재하는 멤버십이 원래의 addedAt과 함께 반환되므로, 이 호출은 안전하게 재시도할 수 있습니다.
기본 오디언스도 다른 오디언스처럼 이름과 설명을 바꿀 수 있지만, 삭제할 수 없고 구성원을 덜어 낼 수도 없습니다. 둘 다 409 audience_immutable로 거부됩니다. 연락처를 없애려면 연락처를 삭제하세요.
응답: AudienceResource
list는 기본 오디언스를 맨 앞에, 나머지를 최신순으로 담은 평범한 배열로 resolve되고, get, create, update는 각각 하나로 resolve됩니다. listContacts는 대신 ContactResource 배열, 즉 멤버십 레코드가 아니라 연락처 자체로 resolve됩니다.
idstring- 영구적인 핸들로, `aud_` 뒤에 16진수 24자가 붙습니다. 이름은 유일하지 않으므로, 저장된 설정에 들어가야 할 것은 이 값입니다.
namestring- 저장 시 앞뒤 공백이 제거되며 1자에서 120자까지입니다. 오디언스는 id로 지정하므로 두 오디언스가 같은 이름을 가질 수 있습니다.
descriptionstring | null- 나중에 목록을 보는 사람을 위한 자유 텍스트입니다. 아무도 쓰지 않았으면 null이고, `update`에서 명시적으로 null을 주면 지워집니다.
builtin'default' | (string & {}) | null- 워크스페이스마다 정확히 한 행에서 `default`이며, 모든 연락처를 담는 오디언스입니다. 누군가 만든 오디언스에서는 null입니다. 나중에 내장 값이 추가되더라도 게시된 타입을 깨지 않고 편집기에서 좁혀질 수 있도록 유니온은 열린 채로 둡니다.
contactCountnumber- 오디언스에 속한 연락처 수로, 캐시된 값이 아니라 읽는 시점에 셉니다. `contacts.create` 앞뒤로 두 번 읽으면 값이 1만큼 차이 납니다.
createdAtstring- ISO-8601 UTC로, 오디언스가 만들어진 시각입니다. 기본 오디언스 다음의 목록 순서를 결정합니다.
updatedAtstring- ISO-8601 UTC로, 이름이나 설명이 바뀌면 갱신됩니다. 구성원 변경은 이 값을 건드리지 않습니다.