Richiesta di testo

La richiesta di testo è una piattaforma di testo aziendale creata per attivare l'engagement dei clienti. Abbiamo creato una soluzione di messaggistica plug-and-play per i tuoi problemi di comunicazione di tutti i giorni, in modo da poter tagliare il rumore e connetterti con i clienti in qualsiasi momento, ovunque. Scopri di più su come aiutiamo i responsabili aziendali occupati come te.

Questo connettore è disponibile nei prodotti e nelle aree seguenti:

Servizio	Class	Regions
Copilot Studio	Di alta qualità	Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD)
App per la logica	Normale	Tutte le aree di App per la logica , ad eccezione delle seguenti: - Aree di Azure per enti pubblici - Aree di Azure Cina - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Apps	Di alta qualità	Tutte le aree di Power Apps , ad eccezione dei seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Automate	Di alta qualità	Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD)

Contatto
Nome	Supporto DELL'API Richiesta di testo
URL	https://www.textrequest.com/contact
Email	apidev@textrequest.com

Metadati del connettore
Editore	Richiesta di testo
Sito web	https://www.textrequest.com/
Informativa sulla privacy	https://www.textrequest.com/privacy-policy/
Categorie	Comunicazione; Vendite e CRM

Aranda Service Management Suite (ASMS)

Aumentare la produttività dell'azienda e trasformare l'esperienza degli utenti con Aranda Service Management Suite, la soluzione multi-tenant che consente di gestire, integrare e automatizzare processi e servizi aziendali. Creare, cercare e aggiornare i record archiviati in qualsiasi area di lavoro (progetto) di ASMS, inclusi eventi imprevisti, requisiti e modifiche, tra gli altri.

Pre-requisites

Tenere presente i prerequisiti seguenti per continuare:

Una sottoscrizione e un'istanza di Aranda Service Management Suite (ASMS). Iniziare da qui: https://arandasoft.com/
Una sottoscrizione attiva di Microsoft Power Automate con funzionalità del connettore Premium.

Recupero delle credenziali

Per eseguire l'autenticazione, usare il token di integrazione. Nel collegamento seguente sono disponibili informazioni su come ottenere il token di integrazione

Introduzione al connettore

Richiede una sottoscrizione ad Aranda Service Management Suite (ASMS).
Ottenere il token di integrazione
Ottenere l'URL dell'istanza dell'API ASMS (ApiAsms) di Gestione dei servizi Aranda.
Stabilire una connessione con il connettore Aranda Service Management Suite.
Selezionare una delle funzioni seguenti offerte dal connettore:
Per informazioni dettagliate sul connettore, vedere https://docs.arandasoft.com/connectors

È possibile usare questo connettore nei casi seguenti:

Creare, cercare e aggiornare i ticket, tra le altre azioni disponibili.
Ottenere la tracciabilità dei biglietti.
Scaricare gli allegati correlati a un ticket.
Cercare articoli della Knowledge Base (KB) in Aranda Service Management Suite.
Scaricare gli allegati dagli articoli della Knowledge Base (KB).
Creare, cercare e aggiornare gli elementi di configurazione (CI).
Consente alle organizzazioni di risolvere le richieste di supporto interne, la gestione e la semplificazione del processo di risoluzione dei problemi tecnici.
Consente di tenere traccia delle comunicazioni tra i richiedenti e gli agenti di supporto.
Offrire risposte automatiche per informare i richiedenti dello stato del ticket.

Risposta riuscita

Codice	Nome	Description
200	Va bene	La richiesta è riuscita
204	Nessun contenuto	Nessun dato trovato nella richiesta

Errori e rimedi comuni

Codice	Nome	Description	Soluzione
400	Richiesta non valida	CriteriaNeedsSomeArguments	Verificare che i parametri di ricerca non siano vuoti
400	Richiesta non valida	InvalidAdditionalFieldId	Verificare che gli ID dei campi aggiuntivi siano corretti
400	Richiesta non valida	InvalidItemType	Il tipo di caso non è corretto, modificare l'ID del tipo di caso
400	Richiesta non valida	InvalidProjectId	L'ID del progetto non è corretto, modificare l'ID del progetto in cui verrà associato il caso
400	Richiesta non valida	InvalidStateId	Controllare lo stato aggiunto durante la creazione o l'aggiornamento di un ticket
400	Richiesta non valida	InvalidUploadType	Si è verificato un errore durante il collegamento di un file, richiedere assistenza a un amministratore di sistema
400	Richiesta non valida	RequestNeedsSomeArguments	Controllare i campi obbligatori del ticket e aggiungere il valore corrispondente di questi nel connettore
400	Richiesta non valida	SearchListIsRequired	Richiedere assistenza a un amministratore di sistema
400	Richiesta non valida	Nome parametro: {Name parameter}	Verificare che le proprietà indicate nell'errore non siano null
400	Richiesta non valida	Nome parametro Null: {Name parameter}	Verificare che le proprietà indicate nell'errore non siano null
400	Richiesta non valida	ItemTypeIsRequired	Aggiungere il tipo di case
400	Richiesta non valida	ModelIdIsEmpty	Aggiungere il parametro modelId. Questo argomento è obbligatorio.
400	Richiesta non valida	StateIdIsEmpty	Aggiungere il parametro stateId. Questo argomento è obbligatorio.
400	Richiesta non valida	ServiceIdIsEmpty	Aggiungere il parametro serviceId. Questo argomento è obbligatorio.
400	Richiesta non valida	CategoryIdIsEmpty	Aggiungere il parametro categoryId. Questo argomento è obbligatorio.
400	Richiesta non valida	TypesListNeedsSomeArguments	Richiede l'aggiunta del tipo di caso durante la ricerca di ticket, richiedere assistenza da un amministratore di sistema
400	Richiesta non valida	'{PARAMETER_NAME}' AdditionalFieldIsRequired	Il campo aggiuntivo '{PARAMETER_NAME}' è obbligatorio
400	Richiesta non valida	ModelNotActive	Il modello associato al caso non è attivo
400	Richiesta non valida	FailedToCloseTaskPendingCloseTasksPredecessors	Se si tenta di chiudere il caso e il caso padre ha attività in sospeso da chiudere
400	Richiesta non valida	DuplicatedObject	L'interfaccia ci esiste già nel database
400	Richiesta non valida	Nome parametro EmptyValue: {PARAMETER_NAME}	Il parametro {PARAMETER_NAME} è obbligatorio
400	Richiesta non valida	EmptyEnumeration Parameter name: {PARAMETER_NAME}	Il parametro {PARAMETER_NAME} è un elenco ed è obbligatorio
403	Vietato	DoNotHavePermissionForThisAction	Rivolgersi all'amministratore di sistema per assegnare le autorizzazioni

Codice	Nome	Description	Soluzione
500	Errore del Server Interno		Richiedere assistenza a un amministratore di sistema
500	Errore del Server Interno	FailureExportExcel	Richiedere assistenza a un amministratore di sistema
500	Errore del Server Interno	FailureGetAdditionalFields	Richiedere assistenza a un amministratore di sistema
500	Errore del Server Interno	FailureGetCategoriesByService	Richiedere assistenza a un amministratore di sistema
500	Errore del Server Interno	FailureGetChangeFSC	Richiedere assistenza a un amministratore di sistema
500	Errore del Server Interno	FailureGetFields	Richiedere assistenza a un amministratore di sistema
500	Errore del Server Interno	FailureGetFieldsList	Richiedere assistenza a un amministratore di sistema
500	Errore del Server Interno	FailureGetFiles	Richiedere assistenza a un amministratore di sistema
500	Errore del Server Interno	FailureGetLookupValues	Richiedere assistenza a un amministratore di sistema
500	Errore del Server Interno	FailureGetMailTemplates	Richiedere assistenza a un amministratore di sistema
500	Errore del Server Interno	FailureGetModelByCategory	Richiedere assistenza a un amministratore di sistema
500	Errore del Server Interno	FailureGetOperators	Richiedere assistenza a un amministratore di sistema
500	Errore del Server Interno	FailureGetReassignmentReasons	Richiedere assistenza a un amministratore di sistema
500	Errore del Server Interno	FailureGetSimilarItems	Richiedere assistenza a un amministratore di sistema
500	Errore del Server Interno	FailureSearchQuickManagement	Richiedere assistenza a un amministratore di sistema

Domande frequenti

Come recuperare gli ID degli attributi necessari per usare le diverse azioni nel connettore (ad esempio, progetto, servizio, categoria, gruppo, specialista)?

Gli ID possono essere recuperati in molti modi:
- Con Aranda Query Manager è possibile creare un report che esegue una query sulla tabella Aranda Service Management Suite (ASMS) in cui si trovano i dati necessari. Se sono necessarie indicazioni sugli oggetti dati nella soluzione, visitare il collegamento https://docs.arandasoft.com/docs/database.html seguente e identificare la versione del database Aranda corrispondente all'installazione di ASMS.
- Se si usa un'installazione locale di ASMS, è possibile eseguire una query sulla tabella ASMS in cui si trovano i dati necessari tramite un client SQL.
- Tramite Aranda Support Center, la creazione di una richiesta di supporto tramite i canali di contatto indicati nel sito Web seguente.
Qual è la dimensione massima dei file da allegare quando si usa l'azione "Aggiungi allegato"?

La dimensione massima dipende dalla configurazione specifica dell'istanza o dell'installazione di ASMS. Chiedere all'amministratore ASMS.
Qual è il livello di accesso ai dati richiesto dall'account tecnico il cui token viene usato nella configurazione della connessione ASMS richiesta dal connettore?

Il livello di accesso è lo stesso dell'account tecnico usato regolarmente in ASMS. In altre parole, in base ai ruoli e alle autorizzazioni del tecnico corrispondente in ASMS, è possibile accedere ai dati con il connettore.
L'account tecnico il cui token verrà usato nel connettore sarà Denominato o Concurrent?

Poiché il connettore può accedere all'istanza asms correlata più volte all'ora, è consigliabile che l'account sia un tipo denominato.
La creazione o la modifica dei casi che usano il connettore seguono le stesse regole di convalida dei dati presenti nell'interfaccia ASMS?

Sì, segue le stesse regole di convalida. Ad esempio, quando si crea un caso per un progetto, un servizio e una categoria specifici, se è necessario compilare campi nativi e aggiuntivi, questi dati sono necessari anche quando si invia il caso tramite il connettore.
Il connettore può essere usato per le istanze di ASMS in ambienti cloud e locali?

Sì, può essere usato sia nelle installazioni cloud che locali di ASMS. Nelle installazioni locali è necessario considerare la connettività tra il server ASMS e l'ambiente Power Automate.
Si dispone di una licenza di Power Automate che consente di usare solo i connettori Standard. È possibile usare il connettore ASMS?

Non è possibile, il connettore ASMS è di tipo Premium.
Si vogliono creare flussi in Power Automate che iniziano dagli eventi in ASMS, ad esempio quando viene creato un caso, quando un caso viene assegnato a un gruppo specifico. È possibile usare trigger che iniziano da eventi che si verificano in ASMS?

Sì, è possibile. Sono consigliati i passaggi seguenti:
- Inizializzare un trigger "Quando viene ricevuta una richiesta HTTP" e creare uno schema JSON del corpo della richiesta contenente la struttura di dati prevista per la ricezione da ASMS. Dopo aver creato il trigger, si otterrà un URL HTTP POST (URL WebHook) da usare nell'istanza di ASMS. Non dimenticare di prendere in considerazione il meccanismo di autenticazione per accedere all'URL del webhook (ad esempio token).
- Creare una regola business in ASMS per il set di condizioni che, quando soddisfatte, deve avviare il flusso in Power Automate. Come azione all'interno della regola, selezionare "Invoke Webhook" (Richiama webhook) e nell'URL di destinazione della chiamata immettere l'URL webhook ottenuto in precedenza, i parametri da inviare e il corpo della richiesta (che deve corrispondere allo schema JSON del corpo della richiesta). Per altre informazioni su come richiamare un webhook da una regola in ASMS, visitare il collegamento seguente: Regola webhook
- Testare la regola creata e convalidare l'invio di una richiesta HTTP all'URL del webhook e inizializza il flusso in Power Automate.
È possibile richiamare gli endpoint dell'API REST ASMS come azioni dai flussi in Power Automate?

Sì, è possibile. Usare l'azione "HTTP" e inserire i dati necessari (URI, metodo, intestazioni, corpo, tra gli altri).

Creazione di una connessione

Il connettore supporta i tipi di autenticazione seguenti:


Predefinita	Parametri per la creazione della connessione.	Tutte le aree geografiche	Non condivisibile

Predefinito

Applicabile: tutte le aree

Parametri per la creazione della connessione.

Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.

Nome	TIPO	Description	Obbligatorio
Chiave API	securestring	Chiave API per questa API	Vero

Limiti per la limitazione delle richieste

Nome	Chiamate	Periodo di rinnovo
Chiamate API per connessione	100	60 secondi

Azioni

Aggiorna un gruppo con l'ID specificato	Aggiorna il nome di un gruppo usando l'ID numerico del gruppo. Se l'ID del gruppo passato non esiste, la chiamata avrà esito negativo.
Aggiornare il nome di un dashboard specifico	Aggiorna un dashboard. Questo non modifica il numero di telefono di un dashboard. Se si vuole un nuovo numero con i contatti di un altro dashboard, sarà necessario creare un nuovo dashboard con un POST e aggiungere i contatti con un'esportazione/importazione in blocco.
Aggiornare in blocco i contatti	Solo il dashboard specificato avrà contatti aggiunti; i contatti sono organizzati in base al dashboard e non è disponibile alcuna ricerca a livello di account per un numero.
Annulla il pagamento specificato	Annulla il pagamento specificato, in cui viene scritto all'utente che il pagamento è stato annullato. Non è possibile modificare i pagamenti, quindi annullare ed emettere un nuovo pagamento è il modo migliore per correggere un pagamento.
Annullare l'esecuzione di una conversazione	Sconvolse una conversazione. Una volta che una conversazione non viene visualizzata, verrà nuovamente visualizzata nella coda. verrà visualizzato anche nelle conversazioni restituite dall'endpoint /conversations. Se una conversazione non è già selezionata, questo metodo non ha alcun effetto.
Archiviare una conversazione	Archivia una conversazione, rimuovendola dai risultati di tutti gli endpoint di recupero della conversazione. Una conversazione verrà automaticamente annullata se il cliente invia un testo al numero di richiesta di testo o se si invia al cliente un testo dal numero di richiesta di testo. L'archiviazione delle conversazioni è un buon modo per rimuovere confusione dai clienti che non si prevede di comunicare in futuro. Si noti che se un cliente invia sms in "STOP" per impedire l'invio di altri messaggi SMS, la conversazione viene archiviata automaticamente.
Contrassegnare un pagamento come pagato	Chiude un pagamento come "pagato". Usare questo endpoint per quando il pagamento viene pagato tramite un mezzo diverso dal portale delle richieste di pagamento. Questo chiuderà il pagamento e aggiungerà l'importo del pagamento alle statistiche. Questo endpoint non è necessario per i pagamenti pagati tramite il portale pagamenti inviato tramite richiesta di testo; che contrassegnerà automaticamente un pagamento come pagato.
Crea un nuovo gruppo	Crea un nuovo gruppo con il nome specificato.
Crea un nuovo pagamento	Crea un nuovo pagamento con il messaggio fornito al contatto fornito.
Creare o aggiornare un contatto	Crea o aggiorna un contatto (a seconda che ne esista già uno con il numero di telefono specificato).
Creare un nuovo dashboard con il nome e il numero di telefono specificati	Crea un nuovo dashboard nell'account. Dopo aver creato il dashboard, gli amministratori riceveranno un messaggio di posta elettronica sulla modifica e potranno iniziare ad assegnare gli utenti. Questo endpoint può creare un dashboard per tutti i numeri di cui è stato effettuato il provisioning. È possibile cercare numeri di cui è stato effettuato il provisioning in un codice di area specifico usando GET /dashboards/provisioning. Se il numero di telefono è già in uso, verrà generata un'eccezione Richiesta non valida.
Elimina il contatto con il numero di telefono specificato	Elimina il contatto con il numero di telefono specificato
Elimina il dashboard specificato	Elimina il dashboard specificato.
Elimina il gruppo con l'ID specificato	Elimina il gruppo con l'ID specificato. Questa operazione avrà esito positivo anche se sono presenti contatti membri del gruppo (i contatti non verranno eliminati).
Inviare un messaggio al contatto con il numero di telefono specificato	Invia un messaggio (avvio di una nuova conversazione se il numero di telefono specificato non ha cronologia messaggi).
Inviare un testo di completamento che ricorda all'utente di pagare il pagamento specificato	Invia un promemoria al contatto per pagare il pagamento specificato. Il contenuto del messaggio viene generato automaticamente. Per evitare la posta indesiderata, è possibile inviare un solo promemoria per pagamento
Ottenere i messaggi di una conversazione in base al numero di telefono di un contatto	Ottenere la conversazione tra il dashboard specificato e il numero di telefono.
Ottenere informazioni su questo dashboard specifico	Restituisce il nome e il telefono del dashboard.
Ottenere tutti i contatti che corrispondono al criterio di filtro specificato	Ottiene tutti i contatti che corrispondono al criterio di filtro specificato. Verrà eseguita la ricerca solo nel dashboard specificato; non è disponibile alcuna ricerca a livello di account per un numero.
Ottenere tutti i dashboard in un account	Ottiene tutti i dashboard in un account.
Ottenere un gruppo in base al relativo ID	Ottiene il gruppo con l'ID specificato.
Ottiene il contatto con il numero di telefono specificato	Ottiene il contatto con il numero di telefono specificato
Ottiene il pagamento con l'ID specificato	Ottiene il pagamento con l'ID specificato.
Ottiene tutte le conversazioni per questo dashboard	Ottiene tutte le conversazioni per questo dashboard e include informazioni sull'ultimo messaggio per ogni conversazione.
Ottiene tutti i campi personalizzati	Ottiene tutti i campi personalizzati per questo dashboard. I campi personalizzati sono univoci tra i dashboard.
Ottiene tutti i gruppi	Ottiene tutti i gruppi per l'account dell'utente.
Ottiene tutti i pagamenti	Ottiene tutti i pagamenti, inclusi i pagamenti annullati e pagati. Questi possono essere filtrati usando i parametri di query.
Ottiene tutti i tag	Ottiene tutti i tag per questo dashboard. I tag sono univoci tra i dashboard.

Aggiorna un gruppo con l'ID specificato

ID operazione:: UpdateGroup

Aggiorna il nome di un gruppo usando l'ID numerico del gruppo. Se l'ID del gruppo passato non esiste, la chiamata avrà esito negativo.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.
ID del gruppo	group_id	True	integer	ID numerico del gruppo da aggiornare.
Nome del gruppo	name		string	Nuovo nome del gruppo.
Nota di gruppo	notes		string	Frase breve che descrive il gruppo. Usato per praticità.

Restituisce

Nome	Percorso	Tipo	Descrizione
id	id	integer	ID numerico del gruppo.
group_member_count	group_member_count	integer	Numero di membri del gruppo.
is_keyword	is_keyword	boolean	Wheter questo gruppo è un gruppo di parole chiave. Tali gruppi vengono generati automaticamente quando un utente configura una parola chiave. I contatti vengono aggiunti automaticamente al momento della registrazione.
nome	name	string	Nome del gruppo.
note	notes	string	Eventuali note su questo gruppo.
last_message_sent_utc	last_message_sent_utc	string	Timestamp di quando è stato inviato l'ultimo messaggio di gruppo per questo gruppo.

Aggiornare il nome di un dashboard specifico

ID operazione:: UpdateDashboardsName

Aggiorna un dashboard. Questo non modifica il numero di telefono di un dashboard. Se si vuole un nuovo numero con i contatti di un altro dashboard, sarà necessario creare un nuovo dashboard con un POST e aggiungere i contatti con un'esportazione/importazione in blocco.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.
Nome dashboard	name		string	Nuovo nome del dashboard.

Restituisce

Nome	Percorso	Tipo	Descrizione
id	id	integer	ID numerico del dashboard.
nome	name	string	Nome del dashboard.
phone	phone	string	Numero di testo associato a questo dashboard.

Aggiornare in blocco i contatti

ID operazione:: BulkUpdateContacts

Solo il dashboard specificato avrà contatti aggiunti; i contatti sono organizzati in base al dashboard e non è disponibile alcuna ricerca a livello di account per un numero.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.
Numero di telefono del contatto	phone_number		string	Numero di telefono del contatto da creare o aggiornare.
Nome del contatto	first_name		string	Nuovo nome del contatto.
Cognome del contatto	last_name		string	Nuovo cognome del contatto.
Nome completo del contatto	display_name		string	Nuovo nome completo del contatto. Questo è il nome predefinito visualizzato nell'app Web quando si visualizzano i contatti.
Indica se i messaggi provenienti da questo contatto vengono eliminati	is_suppressed		boolean	Determina se le conversazioni con questo contatto vengono eliminate e pertanto non viene eseguito il push nella parte superiore della coda di messaggi al momento della ricezione.
Indica se i messaggi di questo contatto vengono archiviati	is_archived		boolean	Determina se le conversazioni con questo contatto vengono archiviate e pertanto non possono essere visualizzate quando si eseguono query su conversazioni (per impostazione predefinita).
Indica se i messaggi provenienti da questo contatto sono bloccati	is_blocked		boolean	Determina se le conversazioni con questo contatto vengono bloccate e pertanto non ricevute o archiviate.
Motivo dell'eliminazione di questo contatto	suppressed_reason		string	Frase che descrive il motivo dell'eliminazione del contatto.
Nota contatto	note		string	Breve frase che descrive il contatto. Usato per praticità. Questo non viene mai visualizzato al contatto.
Gruppi di contatti	groups		array of integer	Matrice di ID interi che fanno riferimento ai gruppi a cui appartiene questo contatto.
Tag di contatto	contact_tags		array of string	Matrice di GUID che fanno riferimento ai tag associati a questo contatto.
ID campo personalizzato	id		string	Guid che fa riferimento a un campo personalizzato.
Valore campo personalizzato	value		string	Valore del contatto per questo campo personalizzato.
Indica se la conversazione corrente con questo contatto è stata risolta	is_resolved		boolean	Determina se la conversazione corrente con questo contatto viene risolta. Tutti i nuovi testi ricevuti da questo contatto impostano questo falso.

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of object
numero_telefono	phone_number	string	Numero di telefono del contatto.
first_name	first_name	string	Nome del contatto.
last_name	last_name	string	Cognome del contatto.
display_name	display_name	string	Nome completo del contatto. Questo è il nome predefinito visualizzato nell'app Web quando si visualizzano i contatti.
is_suppressed	is_suppressed	boolean	Indica se la conversazione con questo contatto viene eliminata e pertanto non viene eseguito il push nella parte superiore della coda di messaggi quando viene ricevuta.
is_archived	is_archived	boolean	Indica se la conversazione con questo contatto è archiviata e pertanto non può essere visualizzata quando si eseguono query su conversazioni (per impostazione predefinita).
is_blocked	is_blocked	boolean	Indica se la conversazione con questo contatto è bloccata e pertanto non è stata ricevuta o archiviata.
suppressed_reason	suppressed_reason	string	Frase che descrive il motivo dell'eliminazione del contatto. Se is_suppressed è false, il valore sarà Null.
nota	note	string	Breve frase che descrive il contatto. Usato per praticità. Questo non viene mai visualizzato al contatto.
groups	groups	array of integer	Matrice di ID interi che fanno riferimento ai gruppi a cui appartiene questo contatto.
contact_tags	contact_tags	array of string	Matrice di GUID che fanno riferimento ai tag associati a questo contatto.
custom_fields	custom_fields	array of object	Matrice di ID e valori di campo personalizzati definiti per questo contatto.
id	custom_fields.id	string	Guid che fa riferimento a un campo personalizzato.
value	custom_fields.value	string	Valore del contatto per questo campo personalizzato.
is_resolved	is_resolved	boolean	Indica se la conversazione con questo contatto viene risolta. Tutti i nuovi testi ricevuti da questo contatto impostano questo falso.
first_contact_utc	first_contact_utc	string	Timestamp del momento in cui il primo messaggio è stato inviato a questo contatto.
opted_out_utc	opted_out_utc	string	Timestamp del momento in cui il contatto ha rifiutato esplicitamente di ricevere messaggi.
last_msg_sent_utc	last_msg_sent_utc	string	Timestamp di quando l'ultimo messaggio è stato inviato a questo contatto.
last_msg_received_utc	last_msg_received_utc	string	Timestamp di quando l'ultimo messaggio è stato ricevuto da questo contatto.
total_msgs_sent	total_msgs_sent	integer	Numero di messaggi totali inviati a questo contatto.
total_msgs_received	total_msgs_received	integer	Numero di messaggi totali ricevuti da questo contatto.
response_count	response_count	integer	Numero totale di messaggi di risposta dal contatto.
date_created_utc	date_created_utc	string	Timestamp del momento in cui è stato creato il contatto.
last_contact_date_utc	last_contact_date_utc	string	Timestamp di quando l'ultimo messaggio è stato inviato o ricevuto da questo contatto.
message_id	last_message.message_id	string	ID del messaggio. Questo valore è univoco per ogni messaggio.
body	last_message.body	string	Contenuto del messaggio.
message_direction	last_message.message_direction	string	Carattere singolare, R o S, che indica se il messaggio è stato ricevuto rispettivamente dal contatto o inviato.
response_by_username	last_message.response_by_username	string	Nome utente dell'utente della richiesta di testo che ha inviato un messaggio all'utente.
message_timestamp_utc	last_message.message_timestamp_utc	string	Timestamp del momento in cui il messaggio è stato inviato o ricevuto dalla richiesta di testo.
delivery_status	last_message.delivery_status	string	Stato corrente del messaggio. Può trattarsi di 'invio', 'recapitato', 'error' o 'send'.
delivery_error	last_message.delivery_error	string	Errore che ha causato il mancato recapito del messaggio. Se il delivery_status non è "error", questo valore sarà Null.
mms_media	last_message.mms_media	array of string	Elenco di URL che puntano agli allegati del messaggio. Tutti gli URL saranno URL generati da una richiesta di testo.

Annulla il pagamento specificato

ID operazione:: CancelPayment

Annulla il pagamento specificato, in cui viene scritto all'utente che il pagamento è stato annullato. Non è possibile modificare i pagamenti, quindi annullare ed emettere un nuovo pagamento è il modo migliore per correggere un pagamento.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.
ID del pagamento	payment_id	True	integer	ID numerico del pagamento da aggiornare.

Restituisce

Nome	Percorso	Tipo	Descrizione
payment_id	payment_id	integer	ID numerico del pagamento.
request_date	request_date	string	Timestamp di quando il messaggio iniziale del pagamento è stato accodato per l'invio.
destinatario	recipient	string	Nome del destinatario del pagamento. Può essere null se il contatto non ha un nome associato al numero di telefono.
descrizione	description	string	Descrizione del pagamento. Questo non viene visualizzato al contatto. Viene utilizzato solo dagli utenti interni per il contesto dei pagamenti.
customer_phone	customer_phone	string	Numero di telefono del contatto che viene inviato questo pagamento.
amount_requested	amount_requested	float	Importo in dollari richiesto da questo pagamento.
is_past_due	is_past_due	boolean	Indica se il pagamento supera la data della richiesta.
reminder_was_sent	reminder_was_sent	boolean	Indica se è già stato inviato un sms per il pagamento.
transaction_status	transaction_status	string	Stato della transazione in authvia. Questo valore inizia come Sconosciuto.
textrequest_payment_status	textrequest_payment_status	string	Stato della transazione in Richiesta di testo. Questo rappresenta lo stato visualizzato nella pagina pagamenti nell'app Richiesta di testo. Inizia come Inviato.
reference_number	reference_number	string	ID definito dall'utente quando vengono creati i pagamenti che possono essere utilizzati per trovare rapidamente i pagamenti. I numeri di riferimento non sono univoci; molti pagamenti possono avere lo stesso riferimento.

Annullare l'esecuzione di una conversazione

ID operazione:: UnarchiveConversation

Sconvolse una conversazione. Una volta che una conversazione non viene visualizzata, verrà nuovamente visualizzata nella coda. verrà visualizzato anche nelle conversazioni restituite dall'endpoint /conversations. Se una conversazione non è già selezionata, questo metodo non ha alcun effetto.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.
Numero di telefono della conversazione	phone_number	True	string	Numero di telefono della conversazione da archiviare.

Restituisce

response: string

Archiviare una conversazione

ID operazione:: ArchiveConversation

Archivia una conversazione, rimuovendola dai risultati di tutti gli endpoint di recupero della conversazione. Una conversazione verrà automaticamente annullata se il cliente invia un testo al numero di richiesta di testo o se si invia al cliente un testo dal numero di richiesta di testo. L'archiviazione delle conversazioni è un buon modo per rimuovere confusione dai clienti che non si prevede di comunicare in futuro. Si noti che se un cliente invia sms in "STOP" per impedire l'invio di altri messaggi SMS, la conversazione viene archiviata automaticamente.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.
Numero di telefono della conversazione	phone_number	True	string	Numero di telefono della conversazione da archiviare.

Restituisce

response: string

Contrassegnare un pagamento come pagato

ID operazione:: MarkPaymentPaid

Chiude un pagamento come "pagato". Usare questo endpoint per quando il pagamento viene pagato tramite un mezzo diverso dal portale delle richieste di pagamento. Questo chiuderà il pagamento e aggiungerà l'importo del pagamento alle statistiche. Questo endpoint non è necessario per i pagamenti pagati tramite il portale pagamenti inviato tramite richiesta di testo; che contrassegnerà automaticamente un pagamento come pagato.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.
ID del pagamento	payment_id	True	integer	ID numerico del pagamento da aggiornare.

Restituisce

Nome	Percorso	Tipo	Descrizione
payment_id	payment_id	integer	ID numerico del pagamento.
request_date	request_date	string	Timestamp di quando il messaggio iniziale del pagamento è stato accodato per l'invio.
destinatario	recipient	string	Nome del destinatario del pagamento. Può essere null se il contatto non ha un nome associato al numero di telefono.
descrizione	description	string	Descrizione del pagamento. Questo non viene visualizzato al contatto. Viene utilizzato solo dagli utenti interni per il contesto dei pagamenti.
customer_phone	customer_phone	string	Numero di telefono del contatto che viene inviato questo pagamento.
amount_requested	amount_requested	float	Importo in dollari richiesto da questo pagamento.
is_past_due	is_past_due	boolean	Indica se il pagamento supera la data della richiesta.
reminder_was_sent	reminder_was_sent	boolean	Indica se è già stato inviato un sms per il pagamento.
transaction_status	transaction_status	string	Stato della transazione in authvia. Questo valore inizia come Sconosciuto.
textrequest_payment_status	textrequest_payment_status	string	Stato della transazione in Richiesta di testo. Questo rappresenta lo stato visualizzato nella pagina pagamenti nell'app Richiesta di testo. Inizia come Inviato.
reference_number	reference_number	string	ID definito dall'utente quando vengono creati i pagamenti che possono essere utilizzati per trovare rapidamente i pagamenti. I numeri di riferimento non sono univoci; molti pagamenti possono avere lo stesso riferimento.

Crea un nuovo gruppo

ID operazione:: CreateGroup

Crea un nuovo gruppo con il nome specificato.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.
Nome del gruppo	name		string	Nuovo nome del gruppo.
Nota di gruppo	notes		string	Frase breve che descrive il gruppo. Usato per praticità.

Restituisce

Nome	Percorso	Tipo	Descrizione
id	id	integer	ID numerico del gruppo.
group_member_count	group_member_count	integer	Numero di membri del gruppo.
is_keyword	is_keyword	boolean	Wheter questo gruppo è un gruppo di parole chiave. Tali gruppi vengono generati automaticamente quando un utente configura una parola chiave. I contatti vengono aggiunti automaticamente al momento della registrazione.
nome	name	string	Nome del gruppo.
note	notes	string	Eventuali note su questo gruppo.
last_message_sent_utc	last_message_sent_utc	string	Timestamp di quando è stato inviato l'ultimo messaggio di gruppo per questo gruppo.

Crea un nuovo pagamento

ID operazione:: CreatePayment

Crea un nuovo pagamento con il messaggio fornito al contatto fornito.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.
Descrizione del pagamento	description		string	Descrizione del pagamento. La descrizione non viene visualizzata al contatto e viene utilizzata solo dagli utenti interni per il contesto dei pagamenti.
Numero di telefono del destinatario	customer_phone		string	Numero di telefono del contatto a cui verrà inviato il pagamento.
Importo richiesto in dollari	amount_requested		float	Importo in dollari richiesto da questo pagamento.
Corpo del testo del messaggio di pagamento	message		string	Testo del messaggio da inviare al contatto insieme al collegamento di pagamento.
Stringa di riferimento del pagamento	reference_number		string	ID definito dall'utente quando vengono creati i pagamenti che possono essere usati per trovare rapidamente i pagamenti. I numeri di riferimento non sono univoci; molti pagamenti possono avere lo stesso riferimento.

Restituisce

Nome	Percorso	Tipo	Descrizione
payment_id	payment_id	integer	ID numerico del pagamento.
request_date	request_date	string	Timestamp di quando il messaggio iniziale del pagamento è stato accodato per l'invio.
destinatario	recipient	string	Nome del destinatario del pagamento. Può essere null se il contatto non ha un nome associato al numero di telefono.
descrizione	description	string	Descrizione del pagamento. Questo non viene visualizzato al contatto. Viene utilizzato solo dagli utenti interni per il contesto dei pagamenti.
customer_phone	customer_phone	string	Numero di telefono del contatto che viene inviato questo pagamento.
amount_requested	amount_requested	float	Importo in dollari richiesto da questo pagamento.
is_past_due	is_past_due	boolean	Indica se il pagamento supera la data della richiesta.
reminder_was_sent	reminder_was_sent	boolean	Indica se è già stato inviato un sms per il pagamento.
transaction_status	transaction_status	string	Stato della transazione in authvia. Questo valore inizia come Sconosciuto.
textrequest_payment_status	textrequest_payment_status	string	Stato della transazione in Richiesta di testo. Questo rappresenta lo stato visualizzato nella pagina pagamenti nell'app Richiesta di testo. Inizia come Inviato.
reference_number	reference_number	string	ID definito dall'utente quando vengono creati i pagamenti che possono essere utilizzati per trovare rapidamente i pagamenti. I numeri di riferimento non sono univoci; molti pagamenti possono avere lo stesso riferimento.

Creare o aggiornare un contatto

ID operazione:: CreateContact

Crea o aggiorna un contatto (a seconda che ne esista già uno con il numero di telefono specificato).

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.
Numero di telefono del contatto	phone_number	True	string	Numero di telefono del contatto da creare o aggiornare.
Nome del contatto	first_name		string	Nuovo nome del contatto.
Cognome del contatto	last_name		string	Nuovo cognome del contatto.
Nome completo del contatto	display_name		string	Nuovo nome completo del contatto. Questo è il nome predefinito visualizzato nell'app Web quando si visualizzano i contatti.
Indica se i messaggi provenienti da questo contatto vengono eliminati	is_suppressed		boolean	Determina se le conversazioni con questo contatto vengono eliminate e pertanto non viene eseguito il push nella parte superiore della coda di messaggi al momento della ricezione.
Indica se i messaggi di questo contatto vengono archiviati	is_archived		boolean	Determina se le conversazioni con questo contatto vengono archiviate e pertanto non possono essere visualizzate quando si eseguono query su conversazioni (per impostazione predefinita).
Indica se i messaggi provenienti da questo contatto sono bloccati	is_blocked		boolean	Determina se le conversazioni con questo contatto vengono bloccate e pertanto non ricevute o archiviate.
Motivo dell'eliminazione di questo contatto	suppressed_reason		string	Frase che descrive il motivo dell'eliminazione del contatto.
Nota contatto	note		string	Breve frase che descrive il contatto. Usato per praticità. Questo non viene mai visualizzato al contatto.
Gruppi di contatti	groups		array of integer	Matrice di ID interi che fanno riferimento ai gruppi a cui appartiene questo contatto.
Tag contatto	contact_tags		array of string	Matrice di GUID che fanno riferimento ai tag associati a questo contatto.
ID campo personalizzato	id		string	Guid che fa riferimento a un campo personalizzato.
Valore campo personalizzato	value		string	Valore del contatto per questo campo personalizzato.
Indica se la conversazione corrente con questo contatto è stata risolta	is_resolved		boolean	Determina se la conversazione corrente con questo contatto viene risolta. Tutti i nuovi testi ricevuti da questo contatto impostano questo falso.

Restituisce

Nome	Percorso	Tipo	Descrizione
numero_telefono	phone_number	string	Numero di telefono del contatto.
first_name	first_name	string	Nome del contatto.
last_name	last_name	string	Cognome del contatto.
display_name	display_name	string	Nome completo del contatto. Questo è il nome predefinito visualizzato nell'app Web quando si visualizzano i contatti.
is_suppressed	is_suppressed	boolean	Indica se la conversazione con questo contatto viene eliminata e pertanto non viene eseguito il push nella parte superiore della coda di messaggi quando viene ricevuta.
is_archived	is_archived	boolean	Indica se la conversazione con questo contatto è archiviata e pertanto non può essere visualizzata quando si eseguono query su conversazioni (per impostazione predefinita).
is_blocked	is_blocked	boolean	Indica se la conversazione con questo contatto è bloccata e pertanto non è stata ricevuta o archiviata.
suppressed_reason	suppressed_reason	string	Frase che descrive il motivo dell'eliminazione del contatto. Se is_suppressed è false, il valore sarà Null.
nota	note	string	Breve frase che descrive il contatto. Usato per praticità. Questo non viene mai visualizzato al contatto.
groups	groups	array of integer	Matrice di ID interi che fanno riferimento ai gruppi a cui appartiene questo contatto.
contact_tags	contact_tags	array of string	Matrice di GUID che fanno riferimento ai tag associati a questo contatto.
custom_fields	custom_fields	array of object	Matrice di ID e valori di campo personalizzati definiti per questo contatto.
id	custom_fields.id	string	Guid che fa riferimento a un campo personalizzato.
value	custom_fields.value	string	Valore del contatto per questo campo personalizzato.
is_resolved	is_resolved	boolean	Indica se la conversazione con questo contatto viene risolta. Tutti i nuovi testi ricevuti da questo contatto impostano questo falso.
first_contact_utc	first_contact_utc	string	Timestamp del momento in cui il primo messaggio è stato inviato a questo contatto.
opted_out_utc	opted_out_utc	string	Timestamp del momento in cui il contatto ha rifiutato esplicitamente di ricevere messaggi.
last_msg_sent_utc	last_msg_sent_utc	string	Timestamp di quando l'ultimo messaggio è stato inviato a questo contatto.
last_msg_received_utc	last_msg_received_utc	string	Timestamp di quando l'ultimo messaggio è stato ricevuto da questo contatto.
total_msgs_sent	total_msgs_sent	integer	Numero di messaggi totali inviati a questo contatto.
total_msgs_received	total_msgs_received	integer	Numero di messaggi totali ricevuti da questo contatto.
response_count	response_count	integer	Numero totale di messaggi di risposta dal contatto.
date_created_utc	date_created_utc	string	Timestamp del momento in cui è stato creato il contatto.
last_contact_date_utc	last_contact_date_utc	string	Timestamp di quando l'ultimo messaggio è stato inviato o ricevuto da questo contatto.
message_id	last_message.message_id	string	ID del messaggio. Questo valore è univoco per ogni messaggio.
body	last_message.body	string	Contenuto del messaggio.
message_direction	last_message.message_direction	string	Carattere singolare, R o S, che indica se il messaggio è stato ricevuto rispettivamente dal contatto o inviato.
response_by_username	last_message.response_by_username	string	Nome utente dell'utente della richiesta di testo che ha inviato un messaggio all'utente.
message_timestamp_utc	last_message.message_timestamp_utc	string	Timestamp del momento in cui il messaggio è stato inviato o ricevuto dalla richiesta di testo.
delivery_status	last_message.delivery_status	string	Stato corrente del messaggio. Può trattarsi di 'invio', 'recapitato', 'error' o 'send'.
delivery_error	last_message.delivery_error	string	Errore che ha causato il mancato recapito del messaggio. Se il delivery_status non è "error", questo valore sarà Null.
mms_media	last_message.mms_media	array of string	Elenco di URL che puntano agli allegati del messaggio. Tutti gli URL saranno URL generati da una richiesta di testo.

Creare un nuovo dashboard con il nome e il numero di telefono specificati

ID operazione:: CreateDashboard

Crea un nuovo dashboard nell'account. Dopo aver creato il dashboard, gli amministratori riceveranno un messaggio di posta elettronica sulla modifica e potranno iniziare ad assegnare gli utenti. Questo endpoint può creare un dashboard per tutti i numeri di cui è stato effettuato il provisioning. È possibile cercare numeri di cui è stato effettuato il provisioning in un codice di area specifico usando GET /dashboards/provisioning. Se il numero di telefono è già in uso, verrà generata un'eccezione Richiesta non valida.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
nome	name		string	Nome del dashboard.
phone	phone		string	Numero di testo associato a questo dashboard.

Restituisce

Nome	Percorso	Tipo	Descrizione
id	id	integer	ID numerico del dashboard.
nome	name	string	Nome del dashboard.
phone	phone	string	Numero di testo associato a questo dashboard.

Elimina il contatto con il numero di telefono specificato

ID operazione:: DeleteContact

Elimina il contatto con il numero di telefono specificato

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.
Numero di telefono del contatto	phone_number	True	string	Numero di telefono del contatto da eliminare.

Restituisce

response: string

Elimina il dashboard specificato

ID operazione:: DeleteDashboard

Elimina il dashboard specificato.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.

Restituisce

response: string

Elimina il gruppo con l'ID specificato

ID operazione:: DeleteGroup

Elimina il gruppo con l'ID specificato. Questa operazione avrà esito positivo anche se sono presenti contatti membri del gruppo (i contatti non verranno eliminati).

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.
ID del gruppo	group_id	True	integer	ID numerico del gruppo da eliminare.

Restituisce

response: string

Inviare un messaggio al contatto con il numero di telefono specificato

ID operazione:: SendMessageByPhoneNumber

Invia un messaggio (avvio di una nuova conversazione se il numero di telefono specificato non ha cronologia messaggi).

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.
Numero di telefono al messaggio	phone_number	True	string	Numero di telefono del contatto a cui inviare un messaggio.
Corpo del messaggio	body		string	Contenuto del messaggio da inviare.
Nome del mittente	sender_name		string	Nome del mittente del messaggio. Questa operazione viene visualizzata nell'app Web TextRequest e nell'API durante il recupero di questo messaggio.
URL di callback per quando lo stato del messaggio viene aggiornato	status_callback		string	URL dell'app Web da raggiungere con un comando POST ogni volta che lo stato del messaggio passa da non recapitato a inviato (o errore).
URL di callback per le richieste di posizione se questo messaggio include uno	location_callback		string	Url di callback della posizione da raggiungere con un comando POST quando l'utente accede e approva la condivisione della posizione con il mittente. Per includere il collegamento, aggiungere [Richiesta di posizione] al corpo del messaggio. Questo callback non è necessario per le richieste di posizione, ma può essere utile per le API.
Allegati di supporti MMS per questo messaggio	mms_media		array of string	Matrice di allegati di supporti MMS per questo messaggio. Gli allegati devono essere url ottenuti dall'endpoint post /mms (non incluso in questo connettore). I collegamenti allegati esterni non verranno accettati.

Restituisce

Nome	Percorso	Tipo	Descrizione
message_id	message_id	string	ID del messaggio. Questo valore è univoco per ogni messaggio.
body	body	string	Contenuto del messaggio.
message_direction	message_direction	string	Carattere singolare, R o S, che indica se il messaggio è stato ricevuto rispettivamente dal contatto o inviato.
response_by_username	response_by_username	string	Nome utente dell'utente della richiesta di testo che ha inviato un messaggio all'utente.
message_timestamp_utc	message_timestamp_utc	string	Timestamp del momento in cui il messaggio è stato inviato o ricevuto dalla richiesta di testo.
delivery_status	delivery_status	string	Stato corrente del messaggio. Può trattarsi di 'invio', 'recapitato', 'error' o 'send'.
delivery_error	delivery_error	string	Errore che ha causato il mancato recapito del messaggio. Se il delivery_status non è "error", questo valore sarà Null.
mms_media	mms_media	array of string	Elenco di URL che puntano agli allegati del messaggio. Tutti gli URL saranno URL generati da una richiesta di testo.

Inviare un testo di completamento che ricorda all'utente di pagare il pagamento specificato

ID operazione:: SendPaymentReminder

Invia un promemoria al contatto per pagare il pagamento specificato. Il contenuto del messaggio viene generato automaticamente. Per evitare la posta indesiderata, è possibile inviare un solo promemoria per pagamento

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.
ID del pagamento	payment_id	True	integer	ID numerico del pagamento da aggiornare.

Restituisce

Nome	Percorso	Tipo	Descrizione
payment_id	payment_id	integer	ID numerico del pagamento.
request_date	request_date	string	Timestamp di quando il messaggio iniziale del pagamento è stato accodato per l'invio.
destinatario	recipient	string	Nome del destinatario del pagamento. Può essere null se il contatto non ha un nome associato al numero di telefono.
descrizione	description	string	Descrizione del pagamento. Questo non viene visualizzato al contatto. Viene utilizzato solo dagli utenti interni per il contesto dei pagamenti.
customer_phone	customer_phone	string	Numero di telefono del contatto che viene inviato questo pagamento.
amount_requested	amount_requested	float	Importo in dollari richiesto da questo pagamento.
is_past_due	is_past_due	boolean	Indica se il pagamento supera la data della richiesta.
reminder_was_sent	reminder_was_sent	boolean	Indica se è già stato inviato un sms per il pagamento.
transaction_status	transaction_status	string	Stato della transazione in authvia. Questo valore inizia come Sconosciuto.
textrequest_payment_status	textrequest_payment_status	string	Stato della transazione in Richiesta di testo. Questo rappresenta lo stato visualizzato nella pagina pagamenti nell'app Richiesta di testo. Inizia come Inviato.
reference_number	reference_number	string	ID definito dall'utente quando vengono creati i pagamenti che possono essere utilizzati per trovare rapidamente i pagamenti. I numeri di riferimento non sono univoci; molti pagamenti possono avere lo stesso riferimento.

Ottenere i messaggi di una conversazione in base al numero di telefono di un contatto

ID operazione:: GetMessagesByContactPhone

Ottenere la conversazione tra il dashboard specificato e il numero di telefono.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Pagina numero da ottenere	page	True	integer	Pagina delle entità da ottenere. Quando si ottengono valori, è presente una dimensione massima per pagina, definita da page_size. Se la pagina è maggiore dell'ultima pagina, verrà restituita una matrice vuota.
Quantità di ogni entità da ottenere per pagina	page_size	True	integer	Dimensioni di ogni pagina da ottenere. Quando si ottengono valori, si tratta di una dimensione massima per pagina, con l'accesso alle pagine successive eseguite dal parametro page.
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.
Numero di telefono del contatto da cercare	phone_number	True	string	Numero di telefono del contatto per cui ricevere messaggi.

Restituisce

Nome	Percorso	Tipo	Descrizione
page	meta.page	integer	Pagina delle entità ottenute. La quantità di entità in questa pagina viene definita da page_size.
page_size	meta.page_size	integer	Numero di entità ottenute in questa pagina.
total_items	meta.total_items	integer	Numero di entità disponibili nel database, indipendentemente dalle dimensioni o dal numero della pagina. Per visualizzare le altre pagine, modificare il numero di pagina nella richiesta.
items	items	array of object	Elenco di entità messaggio ottenute da Richiesta di testo.
message_id	items.message_id	string	ID del messaggio. Questo valore è univoco per ogni messaggio.
body	items.body	string	Contenuto del messaggio.
message_direction	items.message_direction	string	Carattere singolare, R o S, che indica se il messaggio è stato ricevuto rispettivamente dal contatto o inviato.
response_by_username	items.response_by_username	string	Nome utente dell'utente della richiesta di testo che ha inviato un messaggio all'utente.
message_timestamp_utc	items.message_timestamp_utc	string	Timestamp del momento in cui il messaggio è stato inviato o ricevuto dalla richiesta di testo.
delivery_status	items.delivery_status	string	Stato corrente del messaggio. Può trattarsi di 'invio', 'recapitato', 'error' o 'send'.
delivery_error	items.delivery_error	string	Errore che ha causato il mancato recapito del messaggio. Se il delivery_status non è "error", questo valore sarà Null.
mms_media	items.mms_media	array of string	Elenco di URL che puntano agli allegati del messaggio. Tutti gli URL saranno URL generati da una richiesta di testo.

Ottenere informazioni su questo dashboard specifico

ID operazione:: GetDashboard

Restituisce il nome e il telefono del dashboard.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.

Restituisce

Nome	Percorso	Tipo	Descrizione
id	id	integer	ID numerico del dashboard.
nome	name	string	Nome del dashboard.
phone	phone	string	Numero di testo associato a questo dashboard.

Ottenere tutti i contatti che corrispondono al criterio di filtro specificato

ID operazione:: GetContacts

Ottiene tutti i contatti che corrispondono al criterio di filtro specificato. Verrà eseguita la ricerca solo nel dashboard specificato; non è disponibile alcuna ricerca a livello di account per un numero.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Numero di telefono del contatto da cercare	contact_phone_number		string	Numero di telefono per cui filtrare i contatti.
Timestamp di ricerca 'Last-message-time sent before' (Ora dell'ultimo messaggio inviato prima) nell'ora UTC	last_message_timestamp_before_utc		date-time	Tempo di cutoff per la ricerca dei contatti dall'ultimo messaggio inviato o ricevuto. Non verranno visualizzati contatti che hanno inviato messaggi dopo questa volta.
Timestamp di ricerca 'Last-message-time sent after' (Ora dell'ultimo messaggio inviato dopo) nell'ora UTC	last_message_timestamp_after_utc		date-time	Tempo di cutoff per la ricerca dei contatti dall'ultimo messaggio inviato o ricevuto. Non verranno visualizzati contatti il cui ultimo messaggio inviato è prima di questa volta.
Timestamp di ricerca 'Created before'	contact_created_before		date-time	Tempo di scadenza per la ricerca dei contatti al momento della creazione. Non verranno visualizzati contatti creati dopo questa volta.
Timestamp di ricerca 'Created after'	contact_created_after		date-time	Tempo di scadenza per la ricerca dei contatti al momento della creazione. Non verranno visualizzati contatti creati prima di questa volta.
Indica se la conversazione del contatto viene risolta	is_resolved		boolean	Indica se cercare contatti le cui conversazioni sono state risolte.
Indica se il contatto è bloccato	is_blocked		boolean	Indica se cercare contatti bloccati.
Indica se il contatto è archiviato	is_archived		boolean	Indica se cercare i contatti che sono stati archiviati.
Indica se il contatto viene eliminato	is_suppressed		boolean	Indica se cercare i contatti che sono stati eliminati.
Indica se il contatto ha rifiutato esplicitamente	has_opted_out		boolean	Se cercare contatti che hanno rifiutato esplicitamente di ricevere testi.
Timestamp di ricerca 'Last-message-time sent before'	last_message_sent_before		date-time	Tempo di cutoff per la ricerca dei contatti quando l'ultimo messaggio è stato inviato al cliente. Non verranno visualizzati contatti che hanno inviato messaggi dopo questa volta. Usa il timestamp come ora locale. Per filtrare in base al timestamp nell'ora UTC, usare last_message_sent_before_utc
Timestamp di ricerca 'Last-message-time sent after'	last_message_sent_after		date-time	Tempo di cutoff per la ricerca dei contatti quando l'ultimo messaggio è stato inviato al cliente. Non verranno visualizzati contatti il cui ultimo messaggio inviato è prima di questa volta. Usa il timestamp come ora locale. Per filtrare in base al timestamp nell'ora UTC, usare last_message_sent_after_utc
Timestamp di ricerca 'Last-message-time received before'	last_message_received_before		date-time	Tempo di cutoff per la ricerca dei contatti dall'ultimo messaggio ricevuto dal cliente. Non verranno visualizzati contatti che hanno ricevuto messaggi dopo questa volta. Usa il timestamp come ora locale. Per filtrare in base al timestamp nell'ora UTC, usare last_message_sent_before_utc
Timestamp di ricerca 'Last-message-time received after'	last_message_received_after		date-time	Tempo di cutoff per la ricerca dei contatti dall'ultimo messaggio ricevuto dal cliente. Non verranno visualizzati contatti il cui ultimo messaggio inviato è prima di questa volta. Usa il timestamp come ora locale. Per filtrare in base al timestamp nell'ora UTC, usare last_message_sent_before_utc
Tag contatto	tags		string	Elenco delimitato da virgole di guid che fanno riferimento ai tag per filtrare i contatti.
Gruppi di contatti	groups		string	Elenco delimitato da virgole di ID interi che fanno riferimento a gruppi per filtrare i contatti.
ID del campo personalizzato da filtrare in base	custom_field_id_1		string	Guid che fa riferimento al campo personalizzato per filtrare i contatti.
Valore del campo personalizzato da filtrare in base	custom_field_value_1		string	Valore che fa riferimento al campo personalizzato per filtrare i contatti.
ID del secondo campo personalizzato da filtrare in base	custom_field_id_2		string	Guid che fa riferimento al secondo campo personalizzato per filtrare i contatti.
Valore del secondo campo personalizzato da filtrare in base	custom_field_value_2		string	Valore che fa riferimento al secondo campo personalizzato per filtrare i contatti.
ID del terzo campo personalizzato da filtrare in base	custom_field_id_3		string	Guid che fa riferimento al terzo campo personalizzato per filtrare i contatti.
Valore del terzo campo personalizzato da filtrare in base	custom_field_value_3		string	Valore che fa riferimento al terzo campo personalizzato per filtrare i contatti.
Pagina numero da ottenere	page	True	integer	Pagina delle entità da ottenere. Quando si ottengono valori, è presente una dimensione massima per pagina, definita da page_size. Se la pagina è maggiore dell'ultima pagina, verrà restituita una matrice vuota.
Quantità di ogni entità da ottenere per pagina	page_size	True	integer	Dimensioni di ogni pagina da ottenere. Quando si ottengono valori, si tratta di una dimensione massima per pagina, con l'accesso alle pagine successive eseguite dal parametro page.
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.

Restituisce

Nome	Percorso	Tipo	Descrizione
page	meta.page	integer	Pagina delle entità ottenute. La quantità di entità in questa pagina viene definita da page_size.
page_size	meta.page_size	integer	Numero di entità ottenute in questa pagina.
total_items	meta.total_items	integer	Numero di entità disponibili nel database, indipendentemente dalle dimensioni o dal numero della pagina. Per visualizzare le altre pagine, modificare il numero di pagina nella richiesta.
items	items	array of object	Elenco di entità contatto ottenute dalla richiesta di testo.
numero_telefono	items.phone_number	string	Numero di telefono del contatto.
first_name	items.first_name	string	Nome del contatto.
last_name	items.last_name	string	Cognome del contatto.
display_name	items.display_name	string	Nome completo del contatto. Questo è il nome predefinito visualizzato nell'app Web quando si visualizzano i contatti.
is_suppressed	items.is_suppressed	boolean	Indica se la conversazione con questo contatto viene eliminata e pertanto non viene eseguito il push nella parte superiore della coda di messaggi quando viene ricevuta.
is_archived	items.is_archived	boolean	Indica se la conversazione con questo contatto è archiviata e pertanto non può essere visualizzata quando si eseguono query su conversazioni (per impostazione predefinita).
is_blocked	items.is_blocked	boolean	Indica se la conversazione con questo contatto è bloccata e pertanto non è stata ricevuta o archiviata.
suppressed_reason	items.suppressed_reason	string	Frase che descrive il motivo dell'eliminazione del contatto. Se is_suppressed è false, il valore sarà Null.
nota	items.note	string	Breve frase che descrive il contatto. Usato per praticità. Questo non viene mai visualizzato al contatto.
groups	items.groups	array of integer	Matrice di ID interi che fanno riferimento ai gruppi a cui appartiene questo contatto.
contact_tags	items.contact_tags	array of string	Matrice di GUID che fanno riferimento ai tag associati a questo contatto.
custom_fields	items.custom_fields	array of object	Matrice di ID e valori di campo personalizzati definiti per questo contatto.
id	items.custom_fields.id	string	Guid che fa riferimento a un campo personalizzato.
value	items.custom_fields.value	string	Valore del contatto per questo campo personalizzato.
is_resolved	items.is_resolved	boolean	Indica se la conversazione con questo contatto viene risolta. Tutti i nuovi testi ricevuti da questo contatto impostano questo falso.
first_contact_utc	items.first_contact_utc	string	Timestamp del momento in cui il primo messaggio è stato inviato a questo contatto.
opted_out_utc	items.opted_out_utc	string	Timestamp del momento in cui il contatto ha rifiutato esplicitamente di ricevere messaggi.
last_msg_sent_utc	items.last_msg_sent_utc	string	Timestamp di quando l'ultimo messaggio è stato inviato a questo contatto.
last_msg_received_utc	items.last_msg_received_utc	string	Timestamp di quando l'ultimo messaggio è stato ricevuto da questo contatto.
total_msgs_sent	items.total_msgs_sent	integer	Numero di messaggi totali inviati a questo contatto.
total_msgs_received	items.total_msgs_received	integer	Numero di messaggi totali ricevuti da questo contatto.
response_count	items.response_count	integer	Numero totale di messaggi di risposta dal contatto.
date_created_utc	items.date_created_utc	string	Timestamp del momento in cui è stato creato il contatto.
last_contact_date_utc	items.last_contact_date_utc	string	Timestamp di quando l'ultimo messaggio è stato inviato o ricevuto da questo contatto.
message_id	items.last_message.message_id	string	ID del messaggio. Questo valore è univoco per ogni messaggio.
body	items.last_message.body	string	Contenuto del messaggio.
message_direction	items.last_message.message_direction	string	Carattere singolare, R o S, che indica se il messaggio è stato ricevuto rispettivamente dal contatto o inviato.
response_by_username	items.last_message.response_by_username	string	Nome utente dell'utente della richiesta di testo che ha inviato un messaggio all'utente.
message_timestamp_utc	items.last_message.message_timestamp_utc	string	Timestamp del momento in cui il messaggio è stato inviato o ricevuto dalla richiesta di testo.
delivery_status	items.last_message.delivery_status	string	Stato corrente del messaggio. Può trattarsi di 'invio', 'recapitato', 'error' o 'send'.
delivery_error	items.last_message.delivery_error	string	Errore che ha causato il mancato recapito del messaggio. Se il delivery_status non è "error", questo valore sarà Null.
mms_media	items.last_message.mms_media	array of string	Elenco di URL che puntano agli allegati del messaggio. Tutti gli URL saranno URL generati da una richiesta di testo.

Ottenere tutti i dashboard in un account

ID operazione:: GetDashboards

Ottiene tutti i dashboard in un account.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Pagina numero da ottenere	page		integer	Pagina delle entità da ottenere. Quando si ottengono valori, è presente una dimensione massima per pagina, definita da page_size. Se la pagina è maggiore dell'ultima pagina, verrà restituita una matrice vuota.
Quantità di ogni entità da ottenere per pagina	page_size		integer	Dimensioni di ogni pagina da ottenere. Quando si ottengono valori, si tratta di una dimensione massima per pagina, con l'accesso alle pagine successive eseguite dal parametro page.

Restituisce

Nome	Percorso	Tipo	Descrizione
page	meta.page	integer	Pagina delle entità ottenute. La quantità di entità in questa pagina viene definita da page_size.
page_size	meta.page_size	integer	Numero di entità ottenute in questa pagina.
total_items	meta.total_items	integer	Numero di entità disponibili nel database, indipendentemente dalle dimensioni o dal numero della pagina. Per visualizzare le altre pagine, modificare il numero di pagina nella richiesta.
items	items	array of object	Elenco di entità del dashboard ottenute da Richiesta di testo.
id	items.id	integer	ID numerico del dashboard.
nome	items.name	string	Nome del dashboard.
phone	items.phone	string	Numero di testo associato a questo dashboard.

Ottenere un gruppo in base al relativo ID

ID operazione:: GetGroupById

Ottiene il gruppo con l'ID specificato.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.
ID del gruppo	group_id	True	integer	ID numerico del gruppo da ottenere.

Restituisce

Nome	Percorso	Tipo	Descrizione
id	id	integer	ID numerico del gruppo.
group_member_count	group_member_count	integer	Numero di membri del gruppo.
is_keyword	is_keyword	boolean	Wheter questo gruppo è un gruppo di parole chiave. Tali gruppi vengono generati automaticamente quando un utente configura una parola chiave. I contatti vengono aggiunti automaticamente al momento della registrazione.
nome	name	string	Nome del gruppo.
note	notes	string	Eventuali note su questo gruppo.
last_message_sent_utc	last_message_sent_utc	string	Timestamp di quando è stato inviato l'ultimo messaggio di gruppo per questo gruppo.

Ottiene il contatto con il numero di telefono specificato

ID operazione:: GetContactByPhoneNumber

Ottiene il contatto con il numero di telefono specificato

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.
Numero di telefono del contatto	phone_number	True	string	Numero di telefono del contatto da ottenere.

Restituisce

Nome	Percorso	Tipo	Descrizione
numero_telefono	phone_number	string	Numero di telefono del contatto.
first_name	first_name	string	Nome del contatto.
last_name	last_name	string	Cognome del contatto.
display_name	display_name	string	Nome completo del contatto. Questo è il nome predefinito visualizzato nell'app Web quando si visualizzano i contatti.
is_suppressed	is_suppressed	boolean	Indica se la conversazione con questo contatto viene eliminata e pertanto non viene eseguito il push nella parte superiore della coda di messaggi quando viene ricevuta.
is_archived	is_archived	boolean	Indica se la conversazione con questo contatto è archiviata e pertanto non può essere visualizzata quando si eseguono query su conversazioni (per impostazione predefinita).
is_blocked	is_blocked	boolean	Indica se la conversazione con questo contatto è bloccata e pertanto non è stata ricevuta o archiviata.
suppressed_reason	suppressed_reason	string	Frase che descrive il motivo dell'eliminazione del contatto. Se is_suppressed è false, il valore sarà Null.
nota	note	string	Breve frase che descrive il contatto. Usato per praticità. Questo non viene mai visualizzato al contatto.
groups	groups	array of integer	Matrice di ID interi che fanno riferimento ai gruppi a cui appartiene questo contatto.
contact_tags	contact_tags	array of string	Matrice di GUID che fanno riferimento ai tag associati a questo contatto.
custom_fields	custom_fields	array of object	Matrice di ID e valori di campo personalizzati definiti per questo contatto.
id	custom_fields.id	string	Guid che fa riferimento a un campo personalizzato.
value	custom_fields.value	string	Valore del contatto per questo campo personalizzato.
is_resolved	is_resolved	boolean	Indica se la conversazione con questo contatto viene risolta. Tutti i nuovi testi ricevuti da questo contatto impostano questo falso.
first_contact_utc	first_contact_utc	string	Timestamp del momento in cui il primo messaggio è stato inviato a questo contatto.
opted_out_utc	opted_out_utc	string	Timestamp del momento in cui il contatto ha rifiutato esplicitamente di ricevere messaggi.
last_msg_sent_utc	last_msg_sent_utc	string	Timestamp di quando l'ultimo messaggio è stato inviato a questo contatto.
last_msg_received_utc	last_msg_received_utc	string	Timestamp di quando l'ultimo messaggio è stato ricevuto da questo contatto.
total_msgs_sent	total_msgs_sent	integer	Numero di messaggi totali inviati a questo contatto.
total_msgs_received	total_msgs_received	integer	Numero di messaggi totali ricevuti da questo contatto.
response_count	response_count	integer	Numero totale di messaggi di risposta dal contatto.
date_created_utc	date_created_utc	string	Timestamp di quando è stato creato il contatto.
last_contact_date_utc	last_contact_date_utc	string	Timestamp di quando l'ultimo messaggio è stato inviato o ricevuto da questo contatto.
message_id	last_message.message_id	string	ID del messaggio. Questo valore è univoco per ogni messaggio.
body	last_message.body	string	Contenuto del messaggio.
message_direction	last_message.message_direction	string	Carattere singolare, R o S, che indica se il messaggio è stato ricevuto rispettivamente dal contatto o inviato.
response_by_username	last_message.response_by_username	string	Nome utente dell'utente della richiesta di testo che ha inviato un messaggio all'utente.
message_timestamp_utc	last_message.message_timestamp_utc	string	Timestamp del momento in cui il messaggio è stato inviato o ricevuto dalla richiesta di testo.
delivery_status	last_message.delivery_status	string	Stato corrente del messaggio. Può trattarsi di 'invio', 'recapitato', 'error' o 'send'.
delivery_error	last_message.delivery_error	string	Errore che ha causato il mancato recapito del messaggio. Se il delivery_status non è "error", questo valore sarà Null.
mms_media	last_message.mms_media	array of string	Elenco di URL che puntano agli allegati del messaggio. Tutti gli URL saranno URL generati da una richiesta di testo.

Ottiene il pagamento con l'ID specificato

ID operazione:: GetPayment

Ottiene il pagamento con l'ID specificato.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.
ID del pagamento	payment_id	True	integer	ID numerico del pagamento da ottenere.

Restituisce

Nome	Percorso	Tipo	Descrizione
payment_id	payment_id	integer	ID numerico del pagamento.
request_date	request_date	string	Timestamp di quando il messaggio iniziale del pagamento è stato accodato per l'invio.
destinatario	recipient	string	Nome del destinatario del pagamento. Può essere null se il contatto non ha un nome associato al numero di telefono.
descrizione	description	string	Descrizione del pagamento. Questo non viene visualizzato al contatto. Viene utilizzato solo dagli utenti interni per il contesto dei pagamenti.
customer_phone	customer_phone	string	Numero di telefono del contatto che viene inviato questo pagamento.
amount_requested	amount_requested	float	Importo in dollari richiesto da questo pagamento.
is_past_due	is_past_due	boolean	Indica se il pagamento supera la data della richiesta.
reminder_was_sent	reminder_was_sent	boolean	Indica se è già stato inviato un sms per il pagamento.
transaction_status	transaction_status	string	Stato della transazione in authvia. Questo valore inizia come Sconosciuto.
textrequest_payment_status	textrequest_payment_status	string	Stato della transazione in Richiesta di testo. Questo rappresenta lo stato visualizzato nella pagina pagamenti nell'app Richiesta di testo. Inizia come Inviato.
reference_number	reference_number	string	ID definito dall'utente quando vengono creati i pagamenti che possono essere utilizzati per trovare rapidamente i pagamenti. I numeri di riferimento non sono univoci; molti pagamenti possono avere lo stesso riferimento.

Ottiene tutte le conversazioni per questo dashboard

ID operazione:: GetConversations

Ottiene tutte le conversazioni per questo dashboard e include informazioni sull'ultimo messaggio per ogni conversazione.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Tag contatto	tags		string	Elenco delimitato da virgole di guid che fanno riferimento ai tag per filtrare le conversazioni.
Indica se visualizzare solo le conversazioni risolte	show_unresolved_only		string	Indica se cercare solo contatti le cui conversazioni sono state risolte. Se è false, verranno visualizzate sia conversazioni risolte che non risolte.
Indica se includere conversazioni archiviate	include_archived		string	Indica se includere conversazioni con contatti archiviati.
Termine per filtrare in base ai numeri di telefono e al nome del contatto	search		string	Termine di ricerca per filtrare le conversazioni in base al numero di telefono o al nome visualizzato. Se il termine di ricerca è minore di un nome completo o un numero di telefono, la ricerca restituirà tutte le conversazioni che lo corrispondono parzialmente.
Pagina numero da ottenere	page		integer	Pagina delle entità da ottenere. Quando si ottengono valori, è presente una dimensione massima per pagina, definita da page_size. Se la pagina è maggiore dell'ultima pagina, verrà restituita una matrice vuota.
Quantità di ogni entità da ottenere per pagina	page_size		integer	Dimensioni di ogni pagina da ottenere. Quando si ottengono valori, si tratta di una dimensione massima per pagina, con l'accesso alle pagine successive eseguite dal parametro page.
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.

Restituisce

Nome	Percorso	Tipo	Descrizione
page	meta.page	integer	Pagina delle entità ottenute. La quantità di entità in questa pagina viene definita da page_size.
page_size	meta.page_size	integer	Numero di entità ottenute in questa pagina.
total_items	meta.total_items	integer	Numero di entità disponibili nel database, indipendentemente dalle dimensioni o dal numero della pagina. Per visualizzare le altre pagine, modificare il numero di pagina nella richiesta.
items	items	array of object	Elenco di entità di conversazione ottenute da Richiesta di testo.
numero_telefono	items.phone_number	string	Numero di telefono del contatto.
message_id	items.last_message.message_id	string	ID del messaggio. Questo valore è univoco per ogni messaggio.
body	items.last_message.body	string	Contenuto del messaggio.
message_direction	items.last_message.message_direction	string	Carattere singolare, R o S, che indica se il messaggio è stato ricevuto rispettivamente dal contatto o inviato.
response_by_username	items.last_message.response_by_username	string	Nome utente dell'utente della richiesta di testo che ha inviato un messaggio all'utente.
message_timestamp_utc	items.last_message.message_timestamp_utc	string	Timestamp del momento in cui il messaggio è stato inviato o ricevuto dalla richiesta di testo.
delivery_status	items.last_message.delivery_status	string	Stato corrente del messaggio. Può trattarsi di 'invio', 'recapitato', 'error' o 'send'.
delivery_error	items.last_message.delivery_error	string	Errore che ha causato il mancato recapito del messaggio. Se il delivery_status non è "error", questo valore sarà Null.
mms_media	items.last_message.mms_media	array of string	Elenco di URL che puntano agli allegati del messaggio. Tutti gli URL saranno URL generati da una richiesta di testo.

Ottiene tutti i campi personalizzati

ID operazione:: GetCustomFields

Ottiene tutti i campi personalizzati per questo dashboard. I campi personalizzati sono univoci tra i dashboard.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.

Restituisce

Nome	Percorso	Tipo	Descrizione
		array of object
id	id	string	ID numerico del campo.
nome	name	string	Nome del campo personalizzato.

Ottiene tutti i gruppi

ID operazione:: GetGroups

Ottiene tutti i gruppi per l'account dell'utente.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Pagina numero da ottenere	page	True	integer	Pagina delle entità da ottenere. Quando si ottengono valori, è presente una dimensione massima per pagina, definita da page_size. Se la pagina è maggiore dell'ultima pagina, verrà restituita una matrice vuota.
Quantità di ogni entità da ottenere per pagina	page_size	True	integer	Dimensioni di ogni pagina da ottenere. Quando si ottengono valori, si tratta di una dimensione massima per pagina, con l'accesso alle pagine successive eseguite dal parametro page.
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.

Restituisce

Nome	Percorso	Tipo	Descrizione
page	meta.page	integer	Pagina delle entità ottenute. La quantità di entità in questa pagina viene definita da page_size.
page_size	meta.page_size	integer	Numero di entità ottenute in questa pagina.
total_items	meta.total_items	integer	Numero di entità disponibili nel database, indipendentemente dalle dimensioni o dal numero della pagina. Per visualizzare le altre pagine, modificare il numero di pagina nella richiesta.
items	items	array of object	Elenco di entità di gruppo ottenute da Richiesta di testo.
id	items.id	integer	ID numerico del gruppo.
group_member_count	items.group_member_count	integer	Numero di membri del gruppo.
is_keyword	items.is_keyword	boolean	Wheter questo gruppo è un gruppo di parole chiave. Tali gruppi vengono generati automaticamente quando un utente configura una parola chiave. I contatti vengono aggiunti automaticamente al momento della registrazione.
nome	items.name	string	Nome del gruppo.
note	items.notes	string	Eventuali note su questo gruppo.
last_message_sent_utc	items.last_message_sent_utc	string	Timestamp di quando è stato inviato l'ultimo messaggio di gruppo per questo gruppo.

Ottiene tutti i pagamenti

ID operazione:: GetPayments

Ottiene tutti i pagamenti, inclusi i pagamenti annullati e pagati. Questi possono essere filtrati usando i parametri di query.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Stringa di riferimento del pagamento	reference_number		string	ID definito dall'utente quando vengono creati i pagamenti che possono essere usati per trovare rapidamente i pagamenti. I numeri di riferimento non sono univoci; molti pagamenti possono avere lo stesso riferimento.
Numero di telefono di pagamento	phone_number		string	Numero di telefono del contatto a cui è stato inviato il pagamento.
Ordina per	sort_type		string	Proprietà per ordinare i pagamenti. Può essere "amount", "contact", "date", "status".
Direzione di ordinamento	sort_direction		string	Direzione per ordinare i pagamenti. Può essere "desc" per il più grande al più piccolo, o "asc" per il più piccolo al più grande.
Pagina numero da ottenere	page	True	integer	Pagina delle entità da ottenere. Quando si ottengono valori, è presente una dimensione massima per pagina, definita da page_size. Se la pagina è maggiore dell'ultima pagina, verrà restituita una matrice vuota.
Quantità di ogni entità da ottenere per pagina	page_size	True	integer	Dimensioni di ogni pagina da ottenere. Quando si ottengono valori, si tratta di una dimensione massima per pagina, con l'accesso alle pagine successive eseguite dal parametro page.
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.

Restituisce

Nome	Percorso	Tipo	Descrizione
page	meta.page	integer	Pagina delle entità ottenute. La quantità di entità in questa pagina viene definita da page_size.
page_size	meta.page_size	integer	Numero di entità ottenute in questa pagina.
total_items	meta.total_items	integer	Numero di entità disponibili nel database, indipendentemente dalle dimensioni o dal numero della pagina. Per visualizzare le altre pagine, modificare il numero di pagina nella richiesta.
items	items	array of object	Elenco delle entità di pagamento ottenute dalla richiesta di testo.
payment_id	items.payment_id	integer	ID numerico del pagamento.
request_date	items.request_date	string	Timestamp di quando il messaggio iniziale del pagamento è stato accodato per l'invio.
destinatario	items.recipient	string	Nome del destinatario del pagamento. Può essere null se il contatto non ha un nome associato al numero di telefono.
descrizione	items.description	string	Descrizione del pagamento. Questo non viene visualizzato al contatto. Viene utilizzato solo dagli utenti interni per il contesto dei pagamenti.
customer_phone	items.customer_phone	string	Numero di telefono del contatto che viene inviato questo pagamento.
amount_requested	items.amount_requested	float	Importo in dollari richiesto da questo pagamento.
is_past_due	items.is_past_due	boolean	Indica se il pagamento supera la data della richiesta.
reminder_was_sent	items.reminder_was_sent	boolean	Indica se è già stato inviato un sms per il pagamento.
transaction_status	items.transaction_status	string	Stato della transazione in authvia. Questo valore inizia come Sconosciuto.
textrequest_payment_status	items.textrequest_payment_status	string	Stato della transazione in Richiesta di testo. Questo rappresenta lo stato visualizzato nella pagina pagamenti nell'app Richiesta di testo. Inizia come Inviato.
reference_number	items.reference_number	string	ID definito dall'utente quando vengono creati i pagamenti che possono essere utilizzati per trovare rapidamente i pagamenti. I numeri di riferimento non sono univoci; molti pagamenti possono avere lo stesso riferimento.

Ottiene tutti i tag

ID operazione:: GetTags

Ottiene tutti i tag per questo dashboard. I tag sono univoci tra i dashboard.

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
ID del dashboard per effettuare questa chiamata	dashboard_id	True	integer	Dashboard dei numeri di telefono su cui lavorare. Un singolo account può avere diversi dashboard, che rappresentano linee telefoniche diverse per i clienti.
Pagina numero da ottenere	page	True	integer	Pagina delle entità da ottenere. Quando si ottengono valori, è presente una dimensione massima per pagina, definita da page_size. Se la pagina è maggiore dell'ultima pagina, verrà restituita una matrice vuota.
Quantità di ogni entità da ottenere per pagina	page_size	True	integer	Dimensioni di ogni pagina da ottenere. Quando si ottengono valori, si tratta di una dimensione massima per pagina, con l'accesso alle pagine successive eseguite dal parametro page.

Restituisce

Nome	Percorso	Tipo	Descrizione
page	meta.page	integer	Pagina delle entità ottenute. La quantità di entità in questa pagina viene definita da page_size.
page_size	meta.page_size	integer	Numero di entità ottenute in questa pagina.
total_items	meta.total_items	integer	Numero di entità disponibili nel database, indipendentemente dalle dimensioni o dal numero della pagina. Per visualizzare le altre pagine, modificare il numero di pagina nella richiesta.
items	items	array of object	Elenco di entità tag ottenute da Richiesta di testo.
id	items.id	string	ID numerico del tag.
tag_color	items.tag_color	string	Colore del tag. Deve trattarsi di un codice di colore esadecimale valido.
tag	items.tag	string	Nome del tag.

Trigger

Attiva l'invio o la ricezione di un testo

ID operazione:: TextingWebhook

Attiva l'invio o la ricezione di un testo

Parametri

Nome	Chiave	Necessario	Tipo	Descrizione
Dashboard da cui il trigger sarà in ascolto degli eventi	dashboard_id	True	string	ID del dashboard a cui aggiungere trigger
evento	event	True	string	evento

Restituisce

Nome	Percorso	Tipo	Descrizione
ID univoco messaggio	messageUniqueIdentifier	string	messageUniqueIdentifier
Account Id	account.id	integer	id
ID conversazione	yourPhoneNumber.id	integer	id
Nome dashboard	yourPhoneNumber.description	string	descrizione
Numero di telefono del dashboard	yourPhoneNumber.phoneNumber	string	numero di telefono
Dashboard Id	conversation.id	integer	id
date	conversation.date	string	date
Numero di telefono contatto	conversation.consumerPhoneNumber	string	consumerPhoneNumber
messageDirection	conversation.messageDirection	string	messageDirection
message	conversation.message	string	message
numSegments	conversation.numSegments	integer	numSegments
status	conversation.status	string	status
Conversazione richiesta da	conversation.claimedBy	string	claimedBy
Nome visualizzato contatto	conversation.consumerFriendlyName	string	consumerFriendlyName

Definizioni

corda

Si tratta del tipo di dati di base 'string'.

Condividi tramite

Richiesta di testo

Aranda Service Management Suite (ASMS)

Pre-requisites

Recupero delle credenziali

Introduzione al connettore

Risposta riuscita

Errori e rimedi comuni

Domande frequenti

Creazione di una connessione

Predefinito

Limiti per la limitazione delle richieste

Azioni

Aggiorna un gruppo con l'ID specificato

Parametri

Restituisce

Aggiornare il nome di un dashboard specifico

Parametri

Restituisce

Aggiornare in blocco i contatti

Parametri

Restituisce

Annulla il pagamento specificato

Parametri

Restituisce

Annullare l'esecuzione di una conversazione

Parametri

Restituisce

Archiviare una conversazione

Parametri

Restituisce

Contrassegnare un pagamento come pagato

Parametri

Restituisce

Crea un nuovo gruppo

Parametri

Restituisce

Crea un nuovo pagamento

Parametri

Restituisce

Creare o aggiornare un contatto

Parametri

Restituisce

Creare un nuovo dashboard con il nome e il numero di telefono specificati

Parametri

Restituisce

Elimina il contatto con il numero di telefono specificato

Parametri

Restituisce

Elimina il dashboard specificato

Parametri

Restituisce

Elimina il gruppo con l'ID specificato

Parametri

Restituisce

Inviare un messaggio al contatto con il numero di telefono specificato

Parametri

Restituisce

Inviare un testo di completamento che ricorda all'utente di pagare il pagamento specificato

Parametri

Restituisce

Ottenere i messaggi di una conversazione in base al numero di telefono di un contatto

Parametri

Restituisce

Ottenere informazioni su questo dashboard specifico

Parametri

Restituisce

Ottenere tutti i contatti che corrispondono al criterio di filtro specificato

Parametri

Restituisce

Ottenere tutti i dashboard in un account

Parametri

Restituisce

Ottenere un gruppo in base al relativo ID

Parametri

Restituisce

Ottiene il contatto con il numero di telefono specificato

Parametri

Restituisce

Ottiene il pagamento con l'ID specificato