Centro assistenzaIntegrazioni

Per: Amministratori

Aggiungi e aggiorna gli utenti con una chiave di gestione

Visualizza l'elenco dei membri del tuo hub, aggiungi clienti, visualizza i dettagli e i casi di un utente e disabilita o riabilita il suo accesso.

In questo articolo7 sezioni

Prima di iniziare

Questa pagina riguarda le richieste rivolte alle persone presenti nel tuo hub. I percorsi sono indicati sotto https://prd-api-manage.caseactive.com/v1/<hub id>. La chiave utilizzata per aggiungere delle persone come “Utenti” permette soltanto di modificare il loro stato di accesso: non è possibile trasformare qualcuno in “Amministratore” o “Manager”, né modificare i suoi dati personali dopo l’aggiunta.

Chiamate

ChiamataCosa fa
GET /users/relationsElenca le persone presenti nel tuo hub.
POST /users/relationsAggiunge qualcuno.
GET /users/relations/<user_id>Legge una persona
PUT /users/relations/<user_id>Disattiva o riattiva qualcuno
GET /users/relations/<user_id>/casesElenca i casi in cui una persona si trova.

Elenco delle persone

ParametroCosa faNecessarioPredefinito
type1 è destinato solo alle persone attive; 0 invece è destinato alle persone disabili. Nonostante il nome, il filtro si basa sullo stato delle persone, non sul tipo di utente.No.Entrambi
limitQuanti utenti possono essere presenti su una singola pagina, fino a 1000 utenti.No.20
start_keyIl startKey della pagina precedenteNo.Prima pagina

Ogni persona arriva con… user_id, given_name, family_name, email, phone, email_verified, phone_verified, locale, zoneinfo, host_user_type (admin, manage O user), host_user_status (1 Attivo, 0 Disabili) host_ref_id, host_default_role, host_staff_designation, host_cases_ct (I loro numeri di casi) host_granted_status (approve, O reject Una volta che hanno rimosso l’accesso del tuo hub al loro profilo… created_on. La lista non è organizzata in alcun ordine specifico. Contiene i nomi dei tuoi nodi di connessione. Assistente virtualAssistente virtuale Un membro automatizzato del team che pubblica messaggi di benvenuto, check-in e post di aggiornamento per l'azienda; i suoi post sono contrassegnati da un badge di Assistente Virtuale., di chi host_user_type È bot, E le due persone di esempio con cui ogni nuovo hub inizia a funzionare… Una di queste persone è Staff Demo. host_user_type staff. Mentre rimangono ancora più persone, chiamate. nextLink, O inviare. startKey come start_key.

Aggiungere qualcuno

CampoCosa faNecessarioPredefinito
usernameL’indirizzo e-mail o il numero di cellulare, insieme al codice del paese di appartenenza, ad esempio +12035556677. Un numero senza codice del paese viene interpretato come un numero statunitense.Sì.–
given_name, family_nameIl nome e il cognome devono essere scritti tutti in caratteri maiuscoli. Quelli scritti solo in caratteri minuscoli o tutti in caratteri maiuscoli vengono trasformati in parole complete con lettere maiuscole: mary smith viene salvato come Mary Smith.Sì.–
localeLingua: ar, de, en, es, fr, id, it, ja, pl, pt, ru o zhNo.en
zoneinfoFuso orario, ad esempio: America/New_YorkNo.US/Eastern
host_ref_idÈ necessario utilizzare un identificativo personale per loro, ad esempio un numero di cliente. Questo identificativo può essere composto da lettere, numeri, trattini e barre. Tutti i caratteri devono essere scritti in minuscolo. Nessuna due persone possono condividere lo stesso identificativo.No.Nessuno
host_default_roleIl ruolo viene assegnato per primo, quando vengono aggiunti a un caso, come ad esempio role::clients. Tuttavia, questo ruolo non conferisce alcun vantaggio.No.role::clients
host_staff_designationI loro titoli di rango del personale sono: primary, attorney, paralegal, case_manager, lead_attorney o lead_paralegal.No.primary
birthdateData di nascita, ad esempio: 1985-04-12No.Nessuno
genderMale o FemaleNo.Nessuno
address1, address2, locality, region, postal_codeIndirizzo, seconda riga, città, stato e codice postaleNo.Nessuno
countryCodice nazionale a due lettere, ad esempio: USNo.Nessuno
company, titleNome aziendale e titolo di lavoroNo.Nessuno
host_meta_dataI loro campi personalizzati vengono visualizzati, uno per pagina, in ordine logico. Per leggere le pagine, utilizzare il comando GET /schemas?schema_type=users. Un campo contrassegnato con necessario può essere omesso: solo l’opzione “Edit User” lo verifica.No.Nessuno
curl -X POST https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"username": "jane.sample@example.com", "given_name": "Jane", "family_name": "Sample", "zoneinfo": "America/New_York", "host_ref_id": "cl-1042"}'

Risponde a 201 con i loro user_id.

{"data": {"host_id": "ca-7e6d5c4b3a2f10", "user_id": "cu-4f1c2a9e8b7d60", "selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations"}}
  • Ogni persona che aggiunge una chiave è un Utente, attivo… qualunque cosa tu invii.
  • Una chiave non può conferire a nessuno i poteri necessari per gestire i casi: creare casi, aggiungere persone ai casi o rimuoverle. Il trasferimento di host_create_case, host_add_case_user o host_remove_case_user viene rifiutato; inoltre, nessuna persona viene aggiunta al gruppo dei soggetti coinvolti nei casi. Un amministratore può impostare questi parametri su Modifica utente.
  • Se l’indirizzo o il numero esistente è già associato a un account, appartenente a un’altra società o semplicemente non associato affatto, allora la persona viene collegata a quell’account. In caso contrario, viene creato un nuovo account. In entrambi i casi, nessuno riceve email o messaggi via SMS. Le persone vengono informate soltanto quando vengono aggiunte a una “casella” specifica, attraverso l’invito fornito; per ulteriori informazioni, vedere Come aggiungere e rimuovere membri di una casella, utilizzando la funzione di gestione.

Leggere qualcuno

GET /users/relations/<user_id> risponde a tutte le informazioni elencate, oltre alla data di nascita, al genere, all’indirizzo, all’azienda e al titolo dell’utente. Inoltre, vengono fornite informazioni sui campi personalizzati, sulle opzioni di notifica e sulla data dell’ultima connessione dell’utente. GET /users/relations/<user_id>/cases elenca i casi in cui l’utente è coinvolto; tra questi, sono inclusi anche i casi chiusi. Per ciascun caso, vengono fornite le informazioni case_id, title, case_ref_id (l’ID del hub di riferimento, :: e l’ID della tag), case_status, nonché le informazioni case_role_id e case_designation relative a quel caso.

Disabilitare o riabilitare qualcuno

PUT /users/relations/<user_id> Prende un campo soltanto. host_user_status: 0 Per disattivarli… 1 Per riattivarli… Risponde alla domanda. 204.

curl -X PUT https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations/cu-4f1c2a9e8b7d60 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"host_user_status": 0}'
  • A una persona disabile viene negato l’accesso ovunque nel tuo hub. Tuttavia, il suo account rimane attivo presso altre aziende. Per ulteriori informazioni, consulta Disabilita o riattiva un utente.
  • Quando il loro stato cambia, vengono inviati via e-mail, o messaggi di testo, se non hanno un account e-mail. In tal caso, viene comunicato loro che l’accesso è stato disabilitato o ripristinato. Inviare comunque lo stato attuale dei loro account non cambia nulla.
  • Un’chiave può disattivare o riattivare i diritti di gestione per i Manager e gli Utenti, ma non per gli Amministratori o per l’autorità stessa.

Se una chiamata viene rifiutata

StatomessagePerché
400SchemaFieldsExceptionC’è un campo che non è presente o è invalido. I nomi dei campi validi sono errors. Ad esempio, FieldUsernameTypeException può indicare un nome utente che non è una email o un numero di telefono. FieldPhoneTypeException invece può indicare un numero di telefono non valido. Infine, FieldNameTypeException può indicare un nome.
400FieldUsernameDupsExceptionQualcuno che è attivo nella tua rete già possiede quell’indirizzo e-mail o quel numero di telefono. reason detiene i user_id di quella persona.
400HostUserDisabledExceptionQuella persona si trova nel tuo hub, ma è disabilitata. È necessario riattivarla. reason tiene sotto controllo user_id di quella persona.
400UserReferenceIdExistsExceptionQualcun altro già possiede quel host_ref_id.
400HostUserTypeNotAllowedExceptionHai cercato di disattivare un amministratore, oppure hai cercato di disattivare la chiave stessa.
403BotRelationFieldNotAllowedExceptionHai inviato una “forza di caso” quando hai aggiunto qualcuno, o qualsiasi altro elemento… ma non è stato sufficiente. host_user_status Quando le cambiano.
404ItemNotFoundExceptionNessuno nel tuo hub possiede quel user_id.

Per informazioni sul corpo dell’errore e sugli altri codici, si veda Comunicare gli errori dell’API e i codici di stato.

Articoli correlati

Aggiungi e rimuovi i membri del caso con una chiave di gestioneAssegna ruoli e qualifiche ai membri del team, invia l'email di invito, verifica chi è stato assegnato al caso oppure rimuovi un membro.IntegrazioniCerca casi e utenti con una chiave di gestioneTrova casi, persone, membri del caso, ruoli e importa righe tramite testo, con filtri, dal tuo software.IntegrazioniDisabilitare o riabilitare un utenteBlocca un utente dal tuo hub senza eliminarlo, oppure riattiva l'accesso. In entrambi i casi, l'utente verrà informato tramite email o SMS.I tuoi clienti · 1 min