Cerca contatti

GET 
/api/partner-gateway/v1/contacts

Cerca e recupera i contatti con filtri flessibili e paginazione. Questo endpoint ha due comportamenti distinti a seconda del parametro listIds. Quando listIds è fornito (ID di liste contatti separati da virgola), restituisce l'insieme distinto dei contatti che appartengono a quelle liste, con eventuali filtri aggiuntivi applicati in più. Quando listIds è omesso, cerca tra tutti i contatti del tuo account che corrispondono ai filtri forniti. Usa notListIds per escludere i contatti che appartengono a liste specifiche, utile per trovare i contatti non ancora assegnati a una lista di destinazione. Il parametro search esegue una corrispondenza case-insensitive sul nome del contatto e su altri campi di testo. Puoi filtrare per gender, isValid (contatto raggiungibile su almeno uno tra telefono ed email), communicationSupported (es. SMS, RCS, WHATSAPP), isTest (per trovare o escludere i contatti di test), phoneNumber (corrispondenza esatta) ed email (corrispondenza esatta). I risultati sono paginati: page parte da 0, limit ha come valore predefinito 10 (massimo 1000). Usa sortBy per scegliere il campo di ordinamento (predefinito fullName) e sortOrder per asc o desc. Il parametro sortPriorityListId fa apparire per primi nei risultati i contatti che appartengono a quella specifica lista, utile quando visualizzi i contatti con una lista principale evidenziata. Per recuperare i contatti di una lista specifica con un'API più semplice, valuta invece GET /contacts/list/{listId}/contacts. Restituisce 500 in caso di errore imprevisto del server.

Richiesta

Risposte

200

Contatti recuperati con successo

500

Errore interno del server