Audiences
`audiences.list`, `get`, `create`, `update`, `delete`, `listContacts`, `addContact` en `removeContact`.
Elke methode
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)Een audience is een benoemde lijst met contacten in deze workspace. Elk contact zit vanaf het moment dat het bestaat in de ingebouwde standaardaudience, en builtin is wat die rij aanduidt; de rest is aan jou om te maken, te vullen en te verwijderen. Vertak op builtin in plaats van op de naam, die iedereen kan wijzigen.
Deze versie beheert lijsten en verstuurt er niets naartoe. Er is geen broadcastmethode om naar te zoeken, en een contact in een audience zetten is een schrijfactie op de audience en niet op het contact, dus audiences:write is de enige scope die wordt gecontroleerd.
addContact neemt een adres dat al een contact is en weigert er een die dat niet is, met 422 contact_not_found. Sla het eerst op met openemail.contacts.create. Iemand twee keer toevoegen antwoordt met het lidmaatschap dat er al is, inclusief de oorspronkelijke addedAt, dus de aanroep is veilig te herhalen.
De standaardaudience kan net als elke andere worden hernoemd en beschreven, maar hij kan niet worden verwijderd en er kan niets uit worden gehaald. Beide worden geweigerd met 409 audience_immutable. Verwijder het contact als je bedoelt dat het contact weg moet.
Antwoord: AudienceResource
list levert een gewone array hiervan op, met de standaardaudience eerst en de rest nieuwste eerst, en get, create en update leveren er elk één op. listContacts levert in plaats daarvan een array van ContactResource op, de contacten zelf en niet de lidmaatschapsrecords.
idstring- Het duurzame handvat, `aud_` gevolgd door 24 hextekens. Namen zijn niet uniek, dus dit is wat in opgeslagen configuratie thuishoort.
namestring- Bij het schrijven getrimd, 1 tot 120 tekens. Twee audiences mogen een naam delen, want een audience wordt op zijn id aangesproken.
descriptionstring | null- Vrije tekst voor wie de lijst later leest. Null wanneer niemand iets schreef, en een expliciete null bij `update` wist hem.
builtin'default' | (string & {}) | null- `default` op precies één rij per workspace, de audience die elk contact bevat, en null op elke audience die iemand zelf maakte. De union blijft open zodat een later toegevoegde ingebouwde waarde in een editor versmalt zonder het gepubliceerde type te breken.
contactCountnumber- Hoeveel contacten er in de audience zitten, geteld op het moment van lezen en niet gecachet. Twee leesacties aan weerszijden van een `contacts.create` verschillen één.
createdAtstring- ISO-8601 UTC, wanneer de audience is gemaakt. Bepaalt de lijstvolgorde na de standaardaudience.
updatedAtstring- ISO-8601 UTC, opgehoogd door een hernoeming of een wijziging van de beschrijving. Wijzigingen in het lidmaatschap raken hem niet aan.