Demande de texte

La demande de texte est une plateforme de texte métier conçue pour déclencher l’engagement des clients. Nous avons créé une solution de messagerie plug-and-play pour vos problèmes de communication quotidiens, afin que vous puissiez couper le bruit et vous connecter avec les clients à tout moment, n’importe où. Apprenez-en davantage sur la façon dont nous aidons les chefs d’entreprise occupés comme vous.

Ce connecteur est disponible dans les produits et régions suivants :

Service	classe	Régions
Copilot Studio	Premium	Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)
Applications logiques	Norme	Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD)
Power Apps	Premium	Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)
Power Automate	Premium	Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD)

Contact
Nom	Prise en charge de l’API de demande de texte
URL	https://www.textrequest.com/contact
Messagerie électronique	apidev@textrequest.com

Métadonnées du connecteur
Éditeur	Demande de texte
Site web	https://www.textrequest.com/
Politique de confidentialité	https://www.textrequest.com/privacy-policy/
Catégories	Communication; Ventes et CRM

Aranda Service Management Suite (ASMS)

Améliorez la productivité de votre entreprise et transformez l’expérience de vos utilisateurs avec Aranda Service Management Suite, la solution mutualisée qui vous permet de gérer, d’intégrer et d’automatiser les processus et services métier. Créez, recherchez et mettez à jour des enregistrements stockés dans n’importe quel espace de travail (projet) d’ASMS, y compris les incidents, les exigences et les modifications, entre autres.

Conditions préalables

Gardez à l’esprit les conditions préalables suivantes pour continuer :

Un abonnement et une instance d’Aranda Service Management Suite (ASMS). Commencez ici : https://arandasoft.com/
Un abonnement Microsoft Power Automate actif avec des fonctionnalités de connecteur Premium.

Obtention des informations d’identification

Pour effectuer l’authentification, utilisez le jeton d’intégration. Dans le lien suivant, vous trouverez des informations sur la façon d’obtenir le jeton d’intégration

Bien démarrer avec votre connecteur

Nécessite un abonnement à Aranda Service Management Suite (ASMS).
Obtenir le jeton d’intégration
Obtenez l’URL de l’instance de l’API ASMS Gestion des services Aranda (ApiAsms).
Établissez une connexion avec le connecteur Aranda Service Management Suite.
Sélectionnez l’une des fonctions suivantes offertes par le connecteur :
Pour obtenir une documentation détaillée sur le connecteur, reportez-vous à https://docs.arandasoft.com/connectors

Vous pouvez utiliser ce connecteur dans les cas suivants :

Créez, recherchez et mettez à jour des tickets, entre autres actions disponibles.
Obtenez la traçabilité des tickets.
Téléchargez les pièces jointes associées à un ticket.
Recherchez des articles de base de connaissances dans Aranda Service Management Suite.
Téléchargez des pièces jointes à partir d’articles de la base de connaissances (Ko).
Créez, recherchez et mettez à jour des éléments de configuration (CIS).
Elle permet aux organisations de résoudre leurs demandes de support interne, de gérer et de rationaliser le processus de résolution des problèmes techniques.
Permet le suivi des communications entre les demandeurs et les agents de support.
Proposez des réponses automatisées pour informer les demandeurs de l’état de leur ticket.

Réponse réussie

Code	Nom	Descriptif
200	Ok	La requête a été acceptée
204	NoContent	Aucune donnée trouvée dans la requête

Erreurs courantes et solutions

Code	Nom	Descriptif	Solution
400	Requête incorrecte	CriteriaNeedsSomeArguments	Vérifier que les paramètres de recherche ne sont pas vides
400	Requête incorrecte	InvalidAdditionalFieldId	Vérifiez que les ID des champs supplémentaires sont corrects
400	Requête incorrecte	InvalidItemType	Le type de cas est incorrect, modifiez l’ID de type de cas
400	Requête incorrecte	InvalidProjectId	L’ID de projet est incorrect, modifiez l’ID de projet auquel vous associerez le cas
400	Requête incorrecte	InvalidStateId	Vérifier l’état ajouté lors de la création ou de la mise à jour d’un ticket
400	Requête incorrecte	InvalidUploadType	Une erreur s’est produite lors de l’attachement d’un fichier, demander de l’aide auprès d’un administrateur système
400	Requête incorrecte	RequestNeedsSomeArguments	Vérifiez les champs requis du ticket et ajoutez la valeur correspondante dans le connecteur.
400	Requête incorrecte	SearchListIsRequired	Demander de l’aide auprès d’un administrateur système
400	Requête incorrecte	Nom du paramètre : {Name parameter}	Vérifiez que les propriétés mentionnées dans l’erreur ne sont pas null
400	Requête incorrecte	Nom du paramètre Null : {Name parameter}	Vérifiez que les propriétés mentionnées dans l’erreur ne sont pas null
400	Requête incorrecte	ItemTypeIsRequired	Ajouter un type de cas
400	Requête incorrecte	ModelIdIsEmpty	Ajoutez le paramètre modelId. C'est requis.
400	Requête incorrecte	StateIdIsEmpty	Ajoutez le paramètre stateId. C'est requis.
400	Requête incorrecte	ServiceIdIsEmpty	Ajoutez le paramètre serviceId. C'est requis.
400	Requête incorrecte	CategoryIdIsEmpty	Ajoutez le paramètre categoryId. C'est requis.
400	Requête incorrecte	TypesListNeedsSomeArguments	Nécessite l’ajout du type de cas lors de la recherche de tickets, demander de l’aide auprès d’un administrateur système
400	Requête incorrecte	'{PARAMETER_NAME}' AdditionalFieldIsRequired	Le champ supplémentaire « {PARAMETER_NAME} » est obligatoire
400	Requête incorrecte	ModelNotActive	Le modèle associé au cas n’est pas actif
400	Requête incorrecte	FailedToCloseTaskPendingCloseTasksPredecessors	Si vous essayez de fermer le cas et que le cas parent a des tâches en attente à fermer
400	Requête incorrecte	DuplicatedObject	Ci existe déjà dans la base de données
400	Requête incorrecte	Nom du paramètre EmptyValue : {PARAMETER_NAME}	Le paramètre {PARAMETER_NAME} est requis
400	Requête incorrecte	Nom du paramètre EmptyEnumeration : {PARAMETER_NAME}	Le paramètre {PARAMETER_NAME} est une liste et est requis
4:03	Interdit	DoNotHavePermissionForThisAction	Communiquer avec votre administrateur système pour attribuer des autorisations

Code	Nom	Descriptif	Solution
500	Erreur Interne du Serveur		Demander de l’aide auprès d’un administrateur système
500	Erreur Interne du Serveur	FailureExportExcel	Demander de l’aide auprès d’un administrateur système
500	Erreur Interne du Serveur	FailureGetAdditionalFields	Demander de l’aide auprès d’un administrateur système
500	Erreur Interne du Serveur	FailureGetCategoriesByService	Demander de l’aide auprès d’un administrateur système
500	Erreur Interne du Serveur	FailureGetChangeFSC	Demander de l’aide auprès d’un administrateur système
500	Erreur Interne du Serveur	FailureGetFields	Demander de l’aide auprès d’un administrateur système
500	Erreur Interne du Serveur	FailureGetFieldsList	Demander de l’aide auprès d’un administrateur système
500	Erreur Interne du Serveur	FailureGetFiles	Demander de l’aide auprès d’un administrateur système
500	Erreur Interne du Serveur	FailureGetLookupValues	Demander de l’aide auprès d’un administrateur système
500	Erreur Interne du Serveur	FailureGetMailTemplates	Demander de l’aide auprès d’un administrateur système
500	Erreur Interne du Serveur	FailureGetModelByCategory	Demander de l’aide auprès d’un administrateur système
500	Erreur Interne du Serveur	FailureGetOperators	Demander de l’aide auprès d’un administrateur système
500	Erreur Interne du Serveur	FailureGetReassignmentReasons	Demander de l’aide auprès d’un administrateur système
500	Erreur Interne du Serveur	FailureGetSimilarItems	Demander de l’aide auprès d’un administrateur système
500	Erreur Interne du Serveur	FailureSearchQuickManagement	Demander de l’aide auprès d’un administrateur système

Questions fréquentes (FAQ)

Comment récupérer les ID des attributs requis pour utiliser les différentes actions du connecteur (par exemple, projet, service, catégorie, groupe, spécialiste) ?

Les ID peuvent être récupérés de plusieurs façons :
- À l’aide d’Aranda Query Manager, vous pouvez créer un rapport qui interroge la table Aranda Service Management Suite (ASMS) où se trouvent les données requises. Si vous avez besoin d’aide sur les objets de données dans la solution, consultez le lien https://docs.arandasoft.com/docs/database.html suivant et identifiez la version de base de données Aranda correspondant à votre installation ASMS.
- Si vous utilisez une installation ASMS On Premises, vous pouvez interroger la table ASMS où se trouvent les données requises via un client SQL.
- Via le Centre de support Aranda, en créant une demande de support via les canaux de contact indiqués sur le site web suivant.
Quelle est la taille maximale des fichiers à joindre lors de l’utilisation de l’action « Ajouter une pièce jointe » ?

La taille maximale dépend de la configuration spécifique de votre instance/installation ASMS. Demandez à votre administrateur ASMS.
Quel est le niveau d’accès aux données requis par le compte de technicien dont le jeton est utilisé dans la configuration de la connexion ASMS requise par le connecteur ?

Le niveau d’accès est le même que le compte de technicien utilisé régulièrement dans ASMS. En d’autres termes, en fonction des rôles et des autorisations du technicien correspondant dans ASMS, les données sont accessibles avec le connecteur.
Le compte de technicien dont le jeton sera utilisé dans le connecteur doit-il être nommé ou simultané ?

Étant donné que le connecteur peut accéder à l’instance ASMS associée plusieurs fois par heure, il est fortement recommandé que le compte soit un type nommé.
La création ou la modification de cas à l’aide du connecteur suivent-elles les mêmes règles de validation des données présentes dans l’interface ASMS ?

Oui, il suit les mêmes règles de validation. Par exemple, lors de la création d’un cas pour un projet, un service et une catégorie spécifiques, si des champs natifs et supplémentaires doivent être renseignés, ces données sont également requises lors de l’envoi de la casse via le connecteur.
Le connecteur peut-il être utilisé pour les instances ASMS dans les environnements cloud et local ?

Oui, il peut être utilisé dans les installations cloud et locales d’ASMS. Dans les installations locales, vous devez prendre en compte la connectivité entre le serveur ASMS et votre environnement Power Automate.
J’ai une licence Power Automate qui me permet uniquement d’utiliser des connecteurs Standard. Puis-je utiliser le connecteur ASMS ?

Il n’est pas possible, le connecteur ASMS est de type Premium.
Je souhaite créer des flux dans Power Automate qui commencent à partir d’événements dans ASMS (par exemple, lorsqu’un cas a été créé, lorsqu’un cas est affecté à un groupe spécifique). Est-il possible d’utiliser des déclencheurs qui commencent à partir d’événements se produisant dans ASMS ?

Oui, il est possible. Les étapes suivantes sont recommandées :
- Initialisez un déclencheur « Lorsqu’une requête HTTP est reçue » et créez un schéma JSON du corps de la requête contenant la structure de données attendue à recevoir d’ASMS. Une fois le déclencheur créé, vous obtenez une URL HTTP POST (URL WebHook) à utiliser dans votre instance ASMS. N’oubliez pas d’envisager le mécanisme d’authentification pour accéder à l’URL du WebHook (par exemple, Jeton).
- Créez une règle métier dans ASMS pour l’ensemble de conditions qui, lorsqu’elles sont remplies, doit lancer le flux dans Power Automate. En tant qu’action dans la règle, sélectionnez « Invoke Webhook » et, dans l’URL de destination d’appel, entrez l’URL du WebHook précédemment obtenue, les paramètres à envoyer et le corps de la requête (qui doit correspondre au schéma JSON du corps de la requête). Pour plus d’informations sur l’appel d’un Webhook à partir d’une règle dans ASMS, consultez le lien suivant : règle webhook
- Testez la règle créée et validez une requête HTTP envoyée à l’URL du WebHook et initialise le flux dans Power Automate.
Puis-je appeler des points de terminaison d’API REST ASMS en tant qu’actions à partir de flux dans Power Automate ?

Oui, il est possible. Utilisez l’action « HTTP » et renseignez les données requises (URI, Méthode, En-têtes, Corps, entre autres).

Création d’une connexion

Le connecteur prend en charge les types d’authentification suivants :


Par défaut	Paramètres de création de connexion.	Toutes les régions	Non partageable

Faire défaut

Applicable : Toutes les régions

Paramètres de création de connexion.

Cette connexion n’est pas partageable. Si l’application Power est partagée avec un autre utilisateur, un autre utilisateur sera invité à créer explicitement une nouvelle connexion.

Nom	Type	Descriptif	Obligatoire
Clé d’API	securestring	Clé API pour cette API	Vrai

Limitations

Nom	Appels	Période de renouvellement
Appels d’API par connexion	100	60 secondes

Actions

Annule le paiement spécifié	Annule le paiement spécifié, en texteant l’utilisateur sur lequel le paiement a été annulé. Les paiements ne peuvent pas être modifiés, de sorte que l’annulation et l’émission d’un nouveau paiement constituent le meilleur moyen de corriger un paiement.
Annuler l’archivage d’une conversation	Annule une conversation. Une fois qu’une conversation n’est pasarchivée, elle apparaît à nouveau dans la file d’attente. il apparaît également dans les conversations retournées par le point de terminaison /conversations. Si une conversation est déjà nonarchivée, cette méthode n’a aucun effet.
Archiver une conversation	Archive une conversation, la supprimant des résultats de tous les points de terminaison de récupération de conversation. Une conversation est automatiquement nonarchivée si le client envoie un texte à votre numéro de demande de texte ou si vous envoyez au client un texte à partir de votre numéro de demande de texte. L’archivage des conversations est un bon moyen de supprimer l’encombrement des clients que vous ne prévoyez pas de parler à l’avenir. Notez que si un client texte dans « STOP » pour vous empêcher d’envoyer d’autres sms, la conversation est automatiquement archivée.
Crée un groupe	Crée un groupe avec le nom fourni.
Crée un paiement	Crée un paiement avec le message fourni au contact fourni.
Créer ou mettre à jour un contact	Crée ou met à jour un contact (selon qu’il existe déjà avec le numéro de téléphone donné).
Créer un tableau de bord avec le nom et le numéro de téléphone donnés	Crée un tableau de bord dans le compte. Une fois le tableau de bord créé, les administrateurs sont envoyé par e-mail à propos de la modification et peuvent commencer à affecter des utilisateurs. Ce point de terminaison peut créer un tableau de bord pour tous les numéros provisionnés. Vous pouvez rechercher des numéros provisionnés dans un code de zone spécifique à l’aide de GET /dashboards/provisioning. Si le numéro de téléphone est déjà utilisé, une exception de demande incorrecte est levée.
Envoyer un message au contact avec le numéro de téléphone donné	Envoie un message (en commençant une nouvelle conversation si le numéro de téléphone donné n’a pas d’historique des messages).
Envoyer un texte de suivi rappelant à l’utilisateur de payer le paiement spécifié	Envoie un rappel au contact pour payer le paiement spécifié. Le contenu du message est généré automatiquement. Pour éviter le courrier indésirable, un seul rappel peut être envoyé par paiement
Marquer un paiement comme payé	Ferme un paiement en tant que « payé ». Utilisez ce point de terminaison lorsque le paiement est payé via un moyen autre que le portail de demande de paiement. Cela ferme le paiement et ajoute son montant de paiement à vos statistiques. Ce point de terminaison n’est pas requis pour les paiements payés via le portail de paiements envoyés par le biais d’une demande de texte ; qui marque automatiquement un paiement comme payé.
Met à jour un groupe avec l’ID donné	Met à jour le nom d’un groupe à l’aide de l’ID numérique du groupe. Si l’ID de groupe passé n’existe pas, l’appel échoue.
Mettre à jour en bloc les contacts	Seul le tableau de bord spécifié aura des contacts ajoutés ; les contacts sont organisés par tableau de bord et il n’existe aucune recherche au niveau du compte pour un nombre disponible.
Mettre à jour le nom d’un tableau de bord spécifique	Met à jour un tableau de bord. Cela ne modifie pas le numéro de téléphone d’un tableau de bord. Si vous souhaitez un nouveau numéro avec les contacts d’un autre tableau de bord, vous devez créer un tableau de bord avec une publication post et ajouter les contacts avec une exportation/importation en bloc.
Obtenir des informations sur ce tableau de bord spécifique	Retourne le nom et le téléphone du tableau de bord.
Obtenir les messages d’une conversation par numéro de téléphone d’un contact	Obtenez la conversation entre le tableau de bord et le numéro de téléphone spécifiés.
Obtenir tous les contacts qui correspondent au critère de filtrage spécifié	Obtient tous les contacts qui correspondent au critère de filtrage spécifié. Seul le tableau de bord spécifié sera recherché ; il n’existe aucune recherche au niveau du compte pour un nombre disponible.
Obtenir tous les tableaux de bord dans un compte	Obtient tous les tableaux de bord d’un compte.
Obtenir un groupe par son ID	Obtient le groupe avec l’ID spécifié.
Obtient le contact avec le numéro de téléphone spécifié	Obtient le contact avec le numéro de téléphone spécifié
Obtient le paiement avec l’ID spécifié	Obtient le paiement avec l’ID spécifié.
Obtient tous les champs personnalisés	Obtient tous les champs personnalisés pour ce tableau de bord. Les champs personnalisés sont uniques entre les tableaux de bord.
Obtient tous les groupes	Obtient tous les groupes pour le compte de l’utilisateur.
Obtient tous les paiements	Obtient tous les paiements, y compris les paiements annulés et payés. Ceux-ci peuvent être filtrés à l’aide des paramètres de requête.
Obtient toutes les balises	Obtient toutes les balises pour ce tableau de bord. Les balises sont uniques entre les tableaux de bord.
Obtient toutes les conversations pour ce tableau de bord	Obtient toutes les conversations pour ce tableau de bord et inclut des informations sur le dernier message de chaque conversation.
Supprime le contact avec le numéro de téléphone spécifié	Supprime le contact avec le numéro de téléphone spécifié
Supprime le groupe avec l’ID spécifié	Supprime le groupe avec l’ID spécifié. Cela réussit même s’il existe des contacts membres du groupe (les contacts ne seront pas supprimés).
Supprime le tableau de bord spécifié	Supprime le tableau de bord spécifié.

Annule le paiement spécifié

ID d’opération :: CancelPayment

Annule le paiement spécifié, en texteant l’utilisateur sur lequel le paiement a été annulé. Les paiements ne peuvent pas être modifiés, de sorte que l’annulation et l’émission d’un nouveau paiement constituent le meilleur moyen de corriger un paiement.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.
ID du paiement	payment_id	True	integer	ID numérique du paiement à mettre à jour.

Retours

Nom	Chemin d’accès	Type	Description
payment_id	payment_id	integer	ID numérique du paiement.
request_date	request_date	string	Horodatage de l’envoi du message initial de ce paiement.
destinataire	recipient	string	Nom du destinataire du paiement. Cela peut être null si le contact n’a pas de nom associé à son numéro de téléphone.
descriptif	description	string	Description du paiement. Cela n’est pas affiché au contact. Il est utilisé uniquement par les utilisateurs internes pour le contexte des paiements.
customer_phone	customer_phone	string	Numéro de téléphone du contact en cours d’envoi de ce paiement.
amount_requested	amount_requested	float	Montant en dollars demandé par ce paiement.
is_past_due	is_past_due	boolean	Indique si ce paiement est antérieur à la date de demande.
reminder_was_sent	reminder_was_sent	boolean	Indique si un rappel texte a déjà été envoyé pour ce paiement.
transaction_status	transaction_status	string	État de la transaction dans authvia. Cette valeur commence par Unknown.
textrequest_payment_status	textrequest_payment_status	string	État de la transaction dans la demande de texte. Cela représente cet état affiché dans la page paiements de l’application Demande de texte. Il commence comme Envoyé.
reference_number	reference_number	string	ID défini par l’utilisateur défini lors de la création des paiements qui peuvent être utilisés pour rechercher rapidement les paiements. Les numéros de référence ne sont pas uniques ; de nombreux paiements peuvent avoir la même référence.

Annuler l’archivage d’une conversation

ID d’opération :: UnarchiveConversation

Annule une conversation. Une fois qu’une conversation n’est pasarchivée, elle apparaît à nouveau dans la file d’attente. il apparaît également dans les conversations retournées par le point de terminaison /conversations. Si une conversation est déjà nonarchivée, cette méthode n’a aucun effet.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.
Numéro de téléphone de la conversation	phone_number	True	string	Numéro de téléphone de la conversation à archiver.

Retours

response: string

Archiver une conversation

ID d’opération :: ArchiveConversation

Archive une conversation, la supprimant des résultats de tous les points de terminaison de récupération de conversation. Une conversation est automatiquement nonarchivée si le client envoie un texte à votre numéro de demande de texte ou si vous envoyez au client un texte à partir de votre numéro de demande de texte. L’archivage des conversations est un bon moyen de supprimer l’encombrement des clients que vous ne prévoyez pas de parler à l’avenir. Notez que si un client texte dans « STOP » pour vous empêcher d’envoyer d’autres sms, la conversation est automatiquement archivée.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.
Numéro de téléphone de la conversation	phone_number	True	string	Numéro de téléphone de la conversation à archiver.

Retours

response: string

Crée un groupe

ID d’opération :: CreateGroup

Crée un groupe avec le nom fourni.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.
Nom du groupe	name		string	Nouveau nom du groupe.
Note de groupe	notes		string	Phrase courte décrivant le groupe. Utilisé pour des raisons pratiques.

Retours

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	ID numérique du groupe.
group_member_count	group_member_count	integer	Nombre de membres du groupe.
is_keyword	is_keyword	boolean	Wheter ce groupe est un groupe de mots clés. Ces groupes sont générés automatiquement lorsqu’un utilisateur configure un mot clé. Les contacts sont automatiquement ajoutés lorsqu’ils s’inscrivent.
nom	name	string	Nom de ce groupe.
Remarques	notes	string	Toutes les notes de ce groupe.
last_message_sent_utc	last_message_sent_utc	string	Horodatage de l’envoi du dernier message de groupe pour ce groupe.

Crée un paiement

ID d’opération :: CreatePayment

Crée un paiement avec le message fourni au contact fourni.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.
Description du paiement	description		string	Description du paiement. La description n’est pas présentée au contact et est utilisée uniquement par les utilisateurs internes pour le contexte des paiements.
Numéro de téléphone du destinataire	customer_phone		string	Numéro de téléphone du contact à l’envoi de ce paiement.
Montant demandé en dollars	amount_requested		float	Montant en dollars demandé par ce paiement.
Corps du texte du message de paiement	message		string	Texte du message à envoyer au contact, ainsi que le lien de paiement.
Chaîne de référence du paiement	reference_number		string	ID défini par l’utilisateur défini lorsque les paiements sont créés, qui peuvent être utilisés pour rechercher rapidement les paiements. Les numéros de référence ne sont pas uniques ; de nombreux paiements peuvent avoir la même référence.

Retours

Nom	Chemin d’accès	Type	Description
payment_id	payment_id	integer	ID numérique du paiement.
request_date	request_date	string	Horodatage de l’envoi du message initial de ce paiement.
destinataire	recipient	string	Nom du destinataire du paiement. Cela peut être null si le contact n’a pas de nom associé à son numéro de téléphone.
descriptif	description	string	Description du paiement. Cela n’est pas affiché au contact. Il est utilisé uniquement par les utilisateurs internes pour le contexte des paiements.
customer_phone	customer_phone	string	Numéro de téléphone du contact en cours d’envoi de ce paiement.
amount_requested	amount_requested	float	Montant en dollars demandé par ce paiement.
is_past_due	is_past_due	boolean	Indique si ce paiement est antérieur à la date de demande.
reminder_was_sent	reminder_was_sent	boolean	Indique si un rappel texte a déjà été envoyé pour ce paiement.
transaction_status	transaction_status	string	État de la transaction dans authvia. Cette valeur commence par Unknown.
textrequest_payment_status	textrequest_payment_status	string	État de la transaction dans la demande de texte. Cela représente cet état affiché dans la page paiements de l’application Demande de texte. Il commence comme Envoyé.
reference_number	reference_number	string	ID défini par l’utilisateur défini lors de la création des paiements qui peuvent être utilisés pour rechercher rapidement les paiements. Les numéros de référence ne sont pas uniques ; de nombreux paiements peuvent avoir la même référence.

Créer ou mettre à jour un contact

ID d’opération :: CreateContact

Crée ou met à jour un contact (selon qu’il existe déjà avec le numéro de téléphone donné).

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.
Numéro de téléphone du contact	phone_number	True	string	Numéro de téléphone du contact à créer ou à mettre à jour.
Prénom du contact	first_name		string	Nouveau nom du contact.
Nom du contact	last_name		string	Nouveau nom du contact.
Nom complet du contact	display_name		string	Nouveau nom complet du contact. Il s’agit du nom par défaut affiché dans l’application web lors de l’affichage des contacts.
Indique si les messages de ce contact sont supprimés	is_suppressed		boolean	Détermine si les conversations avec ce contact sont supprimées et, par conséquent, ne sont pas envoyées en haut de la file d’attente de messages lorsqu’elles sont reçues.
Indique si les messages de ce contact sont archivés	is_archived		boolean	Détermine si les conversations avec ce contact sont archivées et ne peuvent donc pas être consultées lors de l’interrogation des conversations (par défaut).
Indique si les messages de ce contact sont bloqués	is_blocked		boolean	Détermine si les conversations avec ce contact sont bloquées et ne sont donc pas reçues ou stockées.
Raison de la suppression de ce contact	suppressed_reason		string	Expression décrivant la raison de la suppression du contact.
Contact Note	note		string	Phrase courte décrivant le contact. Utilisé pour des raisons pratiques. Cela n’est jamais montré au contact.
Groupes de contacts	groups		array of integer	Tableau d’ID entiers faisant référence aux groupes auxquels ce contact appartiendra.
Balises de contact	contact_tags		array of string	Tableau de guid faisant référence à des balises attachées à ce contact.
ID de champ personnalisé	id		string	Guid faisant référence à un champ personnalisé.
Valeur de champ personnalisée	value		string	Valeur de ce contact pour ce champ personnalisé.
Indique si la conversation actuelle avec ce contact a été résolue	is_resolved		boolean	Détermine si la conversation actuelle avec ce contact est résolue. Tous les nouveaux textes reçus par ce contact définissent cette valeur false.

Retours

Nom	Chemin d’accès	Type	Description
phone_number	phone_number	string	Numéro de téléphone de ce contact.
first_name	first_name	string	Prénom de ce contact.
last_name	last_name	string	Nom de ce contact.
display_name	display_name	string	Nom complet de ce contact. Il s’agit du nom par défaut affiché dans l’application web lors de l’affichage des contacts.
is_suppressed	is_suppressed	boolean	Indique si la conversation avec ce contact est supprimée et n’est donc pas envoyée en haut de la file d’attente de messages lorsqu’elle est reçue.
is_archived	is_archived	boolean	Indique si la conversation avec ce contact est archivée et ne peut donc pas être vue lors de l’interrogation des conversations (par défaut).
is_blocked	is_blocked	boolean	Indique si la conversation avec ce contact est bloquée et n’est donc pas reçue ou stockée.
suppressed_reason	suppressed_reason	string	Expression décrivant la raison de la suppression du contact. Si is_suppressed a la valeur false, cette valeur est null.
note	note	string	Phrase courte décrivant le contact. Utilisé pour des raisons pratiques. Cela n’est jamais montré au contact.
groups	groups	array of integer	Tableau d’ID entiers faisant référence aux groupes auxquels appartient ce contact.
contact_tags	contact_tags	array of string	Tableau de guid faisant référence à des balises attachées à ce contact.
custom_fields	custom_fields	array of object	Tableau d’ID et de valeurs de champ personnalisés définis pour ce contact.
pièce d'identité	custom_fields.id	string	Guid faisant référence à un champ personnalisé.
value	custom_fields.value	string	Valeur de ce contact pour ce champ personnalisé.
is_resolved	is_resolved	boolean	Indique si la conversation avec ce contact est résolue. Tous les nouveaux textes reçus par ce contact définissent cette valeur false.
first_contact_utc	first_contact_utc	string	Horodatage de l’envoi du premier message à ce contact.
opted_out_utc	opted_out_utc	string	Horodatage du moment où ce contact a choisi de recevoir des messages.
last_msg_sent_utc	last_msg_sent_utc	string	Horodatage de l’envoi du dernier message à ce contact.
last_msg_received_utc	last_msg_received_utc	string	Horodatage de l’heure de réception du dernier message de ce contact.
total_msgs_sent	total_msgs_sent	integer	Nombre total de messages envoyés à ce contact.
total_msgs_received	total_msgs_received	integer	Nombre total de messages reçus de ce contact.
response_count	response_count	integer	Nombre total de messages de réponse du contact.
date_created_utc	date_created_utc	string	Horodatage de la création du contact ths.
last_contact_date_utc	last_contact_date_utc	string	Horodatage de l’envoi ou de la réception du dernier message de ce contact.
message_id	last_message.message_id	string	ID du message. Cette valeur est unique pour chaque message.
body	last_message.body	string	Contenu de ce message.
message_direction	last_message.message_direction	string	Caractère singulier, R ou S, indiquant si ce message a été reçu du contact ou envoyé à eux, respectivement.
response_by_username	last_message.response_by_username	string	Nom d’utilisateur de l’utilisateur demande de texte qui a envoyé un message pour la dernière fois à cet utilisateur.
message_timestamp_utc	last_message.message_timestamp_utc	string	Horodatage de l’envoi ou de la réception du message par demande de texte.
delivery_status	last_message.delivery_status	string	État actuel de ce message. Il peut s’agir de l’option « envoi », « remise », « erreur » ou « envoi ».
delivery_error	last_message.delivery_error	string	Erreur qui a provoqué la remise de ce message. Si le delivery_status n’est pas « error », cette valeur est null.
mms_media	last_message.mms_media	array of string	Liste d’URL pointant vers les pièces jointes de ce message. Toutes les URL seront des URL générées par une requête de texte.

Créer un tableau de bord avec le nom et le numéro de téléphone donnés

ID d’opération :: CreateDashboard

Crée un tableau de bord dans le compte. Une fois le tableau de bord créé, les administrateurs sont envoyé par e-mail à propos de la modification et peuvent commencer à affecter des utilisateurs. Ce point de terminaison peut créer un tableau de bord pour tous les numéros provisionnés. Vous pouvez rechercher des numéros provisionnés dans un code de zone spécifique à l’aide de GET /dashboards/provisioning. Si le numéro de téléphone est déjà utilisé, une exception de demande incorrecte est levée.

Paramètres

Nom	Clé	Obligatoire	Type	Description
nom	name		string	Nom du tableau de bord.
phone	phone		string	Numéro de texte associé à ce tableau de bord.

Retours

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	ID numérique du tableau de bord.
nom	name	string	Nom du tableau de bord.
phone	phone	string	Numéro de texte associé à ce tableau de bord.

Envoyer un message au contact avec le numéro de téléphone donné

ID d’opération :: SendMessageByPhoneNumber

Envoie un message (en commençant une nouvelle conversation si le numéro de téléphone donné n’a pas d’historique des messages).

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.
Numéro de téléphone à message	phone_number	True	string	Numéro de téléphone du contact à laquelle envoyer un message.
Corps du message	body		string	Contenu du message à envoyer.
Nom de l’expéditeur	sender_name		string	Nom de l’expéditeur du message. Cela s’affiche dans l’application web TextRequest et l’API lors de la récupération de ce message.
URL de rappel pour le moment où l’état du message est mis à jour	status_callback		string	URL de l’application web à atteindre avec une commande POST chaque fois que l’état de ce message passe d’un message non remis à envoyé (ou erreur).
URL de rappel pour les demandes d’emplacement si ce message inclut un	location_callback		string	URL de rappel d’emplacement à atteindre avec une commande POST lorsque l’utilisateur accède et approuve le partage de son emplacement avec l’expéditeur. Pour inclure le lien, ajoutez [Demande d’emplacement] au corps du message. Ce rappel n’est pas nécessaire pour les demandes d’emplacement, mais il peut être utile pour les API.
Pièces jointes multimédias MMS pour ce message	mms_media		array of string	Tableau de pièces jointes multimédias MMS pour ce message. Les pièces jointes doivent être des URL extraites du point de terminaison post/mms (non incluses dans ce connecteur). Les liens de pièce jointe externe ne sont pas acceptés.

Retours

Nom	Chemin d’accès	Type	Description
message_id	message_id	string	ID du message. Cette valeur est unique pour chaque message.
body	body	string	Contenu de ce message.
message_direction	message_direction	string	Caractère singulier, R ou S, indiquant si ce message a été reçu du contact ou envoyé à eux, respectivement.
response_by_username	response_by_username	string	Nom d’utilisateur de l’utilisateur demande de texte qui a envoyé un message pour la dernière fois à cet utilisateur.
message_timestamp_utc	message_timestamp_utc	string	Horodatage de l’envoi ou de la réception du message par demande de texte.
delivery_status	delivery_status	string	État actuel de ce message. Il peut s’agir de l’option « envoi », « remise », « erreur » ou « envoi ».
delivery_error	delivery_error	string	Erreur qui a provoqué la remise de ce message. Si le delivery_status n’est pas « error », cette valeur est null.
mms_media	mms_media	array of string	Liste d’URL pointant vers les pièces jointes de ce message. Toutes les URL seront des URL générées par une requête de texte.

Envoyer un texte de suivi rappelant à l’utilisateur de payer le paiement spécifié

ID d’opération :: SendPaymentReminder

Envoie un rappel au contact pour payer le paiement spécifié. Le contenu du message est généré automatiquement. Pour éviter le courrier indésirable, un seul rappel peut être envoyé par paiement

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.
ID du paiement	payment_id	True	integer	ID numérique du paiement à mettre à jour.

Retours

Nom	Chemin d’accès	Type	Description
payment_id	payment_id	integer	ID numérique du paiement.
request_date	request_date	string	Horodatage de l’envoi du message initial de ce paiement.
destinataire	recipient	string	Nom du destinataire du paiement. Cela peut être null si le contact n’a pas de nom associé à son numéro de téléphone.
descriptif	description	string	Description du paiement. Cela n’est pas affiché au contact. Il est utilisé uniquement par les utilisateurs internes pour le contexte des paiements.
customer_phone	customer_phone	string	Numéro de téléphone du contact en cours d’envoi de ce paiement.
amount_requested	amount_requested	float	Montant en dollars demandé par ce paiement.
is_past_due	is_past_due	boolean	Indique si ce paiement est antérieur à la date de demande.
reminder_was_sent	reminder_was_sent	boolean	Indique si un rappel texte a déjà été envoyé pour ce paiement.
transaction_status	transaction_status	string	État de la transaction dans authvia. Cette valeur commence par Unknown.
textrequest_payment_status	textrequest_payment_status	string	État de la transaction dans la demande de texte. Cela représente cet état affiché dans la page paiements de l’application Demande de texte. Il commence comme Envoyé.
reference_number	reference_number	string	ID défini par l’utilisateur défini lors de la création des paiements qui peuvent être utilisés pour rechercher rapidement les paiements. Les numéros de référence ne sont pas uniques ; de nombreux paiements peuvent avoir la même référence.

Marquer un paiement comme payé

ID d’opération :: MarkPaymentPaid

Ferme un paiement en tant que « payé ». Utilisez ce point de terminaison lorsque le paiement est payé via un moyen autre que le portail de demande de paiement. Cela ferme le paiement et ajoute son montant de paiement à vos statistiques. Ce point de terminaison n’est pas requis pour les paiements payés via le portail de paiements envoyés par le biais d’une demande de texte ; qui marque automatiquement un paiement comme payé.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.
ID du paiement	payment_id	True	integer	ID numérique du paiement à mettre à jour.

Retours

Nom	Chemin d’accès	Type	Description
payment_id	payment_id	integer	ID numérique du paiement.
request_date	request_date	string	Horodatage de l’envoi du message initial de ce paiement.
destinataire	recipient	string	Nom du destinataire du paiement. Cela peut être null si le contact n’a pas de nom associé à son numéro de téléphone.
descriptif	description	string	Description du paiement. Cela n’est pas affiché au contact. Il est utilisé uniquement par les utilisateurs internes pour le contexte des paiements.
customer_phone	customer_phone	string	Numéro de téléphone du contact en cours d’envoi de ce paiement.
amount_requested	amount_requested	float	Montant en dollars demandé par ce paiement.
is_past_due	is_past_due	boolean	Indique si ce paiement est antérieur à la date de demande.
reminder_was_sent	reminder_was_sent	boolean	Indique si un rappel texte a déjà été envoyé pour ce paiement.
transaction_status	transaction_status	string	État de la transaction dans authvia. Cette valeur commence par Unknown.
textrequest_payment_status	textrequest_payment_status	string	État de la transaction dans la demande de texte. Cela représente cet état affiché dans la page paiements de l’application Demande de texte. Il commence comme Envoyé.
reference_number	reference_number	string	ID défini par l’utilisateur défini lors de la création des paiements qui peuvent être utilisés pour rechercher rapidement les paiements. Les numéros de référence ne sont pas uniques ; de nombreux paiements peuvent avoir la même référence.

Met à jour un groupe avec l’ID donné

ID d’opération :: UpdateGroup

Met à jour le nom d’un groupe à l’aide de l’ID numérique du groupe. Si l’ID de groupe passé n’existe pas, l’appel échoue.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.
ID du groupe	group_id	True	integer	ID numérique du groupe à mettre à jour.
Nom du groupe	name		string	Nouveau nom du groupe.
Note de groupe	notes		string	Phrase courte décrivant le groupe. Utilisé pour des raisons pratiques.

Retours

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	ID numérique du groupe.
group_member_count	group_member_count	integer	Nombre de membres du groupe.
is_keyword	is_keyword	boolean	Wheter ce groupe est un groupe de mots clés. Ces groupes sont générés automatiquement lorsqu’un utilisateur configure un mot clé. Les contacts sont automatiquement ajoutés lorsqu’ils s’inscrivent.
nom	name	string	Nom de ce groupe.
Remarques	notes	string	Toutes les notes de ce groupe.
last_message_sent_utc	last_message_sent_utc	string	Horodatage de l’envoi du dernier message de groupe pour ce groupe.

Mettre à jour en bloc les contacts

ID d’opération :: BulkUpdateContacts

Seul le tableau de bord spécifié aura des contacts ajoutés ; les contacts sont organisés par tableau de bord et il n’existe aucune recherche au niveau du compte pour un nombre disponible.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.
Numéro de téléphone du contact	phone_number		string	Numéro de téléphone du contact à créer ou à mettre à jour.
Prénom du contact	first_name		string	Nouveau nom du contact.
Nom du contact	last_name		string	Nouveau nom du contact.
Nom complet du contact	display_name		string	Nouveau nom complet du contact. Il s’agit du nom par défaut affiché dans l’application web lors de l’affichage des contacts.
Indique si les messages de ce contact sont supprimés	is_suppressed		boolean	Détermine si les conversations avec ce contact sont supprimées et, par conséquent, ne sont pas envoyées en haut de la file d’attente de messages lorsqu’elles sont reçues.
Indique si les messages de ce contact sont archivés	is_archived		boolean	Détermine si les conversations avec ce contact sont archivées et ne peuvent donc pas être consultées lors de l’interrogation des conversations (par défaut).
Indique si les messages de ce contact sont bloqués	is_blocked		boolean	Détermine si les conversations avec ce contact sont bloquées et ne sont donc pas reçues ou stockées.
Raison de la suppression de ce contact	suppressed_reason		string	Expression décrivant la raison de la suppression du contact.
Note de contact	note		string	Phrase courte décrivant le contact. Utilisé pour des raisons pratiques. Cela n’est jamais montré au contact.
Groupes de contacts	groups		array of integer	Tableau d’ID entiers faisant référence aux groupes auxquels ce contact appartiendra.
Balises de contact	contact_tags		array of string	Tableau de guid faisant référence à des balises attachées à ce contact.
ID de champ personnalisé	id		string	Guid faisant référence à un champ personnalisé.
Valeur de champ personnalisée	value		string	Valeur de ce contact pour ce champ personnalisé.
Indique si la conversation actuelle avec ce contact a été résolue	is_resolved		boolean	Détermine si la conversation actuelle avec ce contact est résolue. Tous les nouveaux textes reçus par ce contact définissent cette valeur false.

Retours

Nom	Chemin d’accès	Type	Description
		array of object
phone_number	phone_number	string	Numéro de téléphone de ce contact.
first_name	first_name	string	Prénom de ce contact.
last_name	last_name	string	Nom de ce contact.
display_name	display_name	string	Nom complet de ce contact. Il s’agit du nom par défaut affiché dans l’application web lors de l’affichage des contacts.
is_suppressed	is_suppressed	boolean	Indique si la conversation avec ce contact est supprimée et n’est donc pas envoyée en haut de la file d’attente de messages lorsqu’elle est reçue.
is_archived	is_archived	boolean	Indique si la conversation avec ce contact est archivée et ne peut donc pas être vue lors de l’interrogation des conversations (par défaut).
is_blocked	is_blocked	boolean	Indique si la conversation avec ce contact est bloquée et n’est donc pas reçue ou stockée.
suppressed_reason	suppressed_reason	string	Expression décrivant la raison de la suppression du contact. Si is_suppressed a la valeur false, cette valeur est null.
note	note	string	Phrase courte décrivant le contact. Utilisé pour des raisons pratiques. Cela n’est jamais montré au contact.
groups	groups	array of integer	Tableau d’ID entiers faisant référence aux groupes auxquels appartient ce contact.
contact_tags	contact_tags	array of string	Tableau de guid faisant référence à des balises attachées à ce contact.
custom_fields	custom_fields	array of object	Tableau d’ID et de valeurs de champ personnalisés définis pour ce contact.
pièce d'identité	custom_fields.id	string	Guid faisant référence à un champ personnalisé.
value	custom_fields.value	string	Valeur de ce contact pour ce champ personnalisé.
is_resolved	is_resolved	boolean	Indique si la conversation avec ce contact est résolue. Tous les nouveaux textes reçus par ce contact définissent cette valeur false.
first_contact_utc	first_contact_utc	string	Horodatage de l’envoi du premier message à ce contact.
opted_out_utc	opted_out_utc	string	Horodatage du moment où ce contact a choisi de recevoir des messages.
last_msg_sent_utc	last_msg_sent_utc	string	Horodatage de l’envoi du dernier message à ce contact.
last_msg_received_utc	last_msg_received_utc	string	Horodatage de l’heure de réception du dernier message de ce contact.
total_msgs_sent	total_msgs_sent	integer	Nombre total de messages envoyés à ce contact.
total_msgs_received	total_msgs_received	integer	Nombre total de messages reçus de ce contact.
response_count	response_count	integer	Nombre total de messages de réponse du contact.
date_created_utc	date_created_utc	string	Horodatage de la création du contact ths.
last_contact_date_utc	last_contact_date_utc	string	Horodatage de l’envoi ou de la réception du dernier message de ce contact.
message_id	last_message.message_id	string	ID du message. Cette valeur est unique pour chaque message.
body	last_message.body	string	Contenu de ce message.
message_direction	last_message.message_direction	string	Caractère singulier, R ou S, indiquant si ce message a été reçu du contact ou envoyé à eux, respectivement.
response_by_username	last_message.response_by_username	string	Nom d’utilisateur de l’utilisateur demande de texte qui a envoyé un message pour la dernière fois à cet utilisateur.
message_timestamp_utc	last_message.message_timestamp_utc	string	Horodatage de l’envoi ou de la réception du message par demande de texte.
delivery_status	last_message.delivery_status	string	État actuel de ce message. Il peut s’agir de l’option « envoi », « remise », « erreur » ou « envoi ».
delivery_error	last_message.delivery_error	string	Erreur qui a provoqué la remise de ce message. Si le delivery_status n’est pas « error », cette valeur est null.
mms_media	last_message.mms_media	array of string	Liste d’URL pointant vers les pièces jointes de ce message. Toutes les URL seront des URL générées par une requête de texte.

Mettre à jour le nom d’un tableau de bord spécifique

ID d’opération :: UpdateDashboardsName

Met à jour un tableau de bord. Cela ne modifie pas le numéro de téléphone d’un tableau de bord. Si vous souhaitez un nouveau numéro avec les contacts d’un autre tableau de bord, vous devez créer un tableau de bord avec une publication post et ajouter les contacts avec une exportation/importation en bloc.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.
Nom du tableau de bord	name		string	Nouveau nom du tableau de bord.

Retours

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	ID numérique du tableau de bord.
nom	name	string	Nom du tableau de bord.
phone	phone	string	Numéro de texte associé à ce tableau de bord.

Obtenir des informations sur ce tableau de bord spécifique

ID d’opération :: GetDashboard

Retourne le nom et le téléphone du tableau de bord.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.

Retours

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	ID numérique du tableau de bord.
nom	name	string	Nom du tableau de bord.
phone	phone	string	Numéro de texte associé à ce tableau de bord.

Obtenir les messages d’une conversation par numéro de téléphone d’un contact

ID d’opération :: GetMessagesByContactPhone

Obtenez la conversation entre le tableau de bord et le numéro de téléphone spécifiés.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Page numéro à obtenir	page	True	integer	Page des entités à obtenir. Lorsque vous obtenez des valeurs, il existe une taille maximale par page, définie par page_size. Si la page est supérieure à la dernière page, un tableau vide est retourné.
Quantité de chaque entité à obtenir par page	page_size	True	integer	Taille de chaque page à obtenir. Lorsque vous obtenez des valeurs, il s’agit d’une taille maximale par page, avec l’accès aux pages suivantes effectuées par le paramètre de page.
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.
Numéro de téléphone du contact à rechercher par	phone_number	True	string	Numéro de téléphone du contact pour lequel obtenir des messages.

Retours

Nom	Chemin d’accès	Type	Description
page	meta.page	integer	Page des entités obtenu. La quantité d’entités de cette page est définie par page_size.
page_size	meta.page_size	integer	Nombre d’entités obtenu dans cette page.
total_items	meta.total_items	integer	Nombre d’entités disponibles dans la base de données, quelle que soit la taille ou le nombre de pages. Pour afficher les autres pages, modifiez le numéro de page dans la demande.
items	items	array of object	Liste des entités de message extraites de la demande de texte.
message_id	items.message_id	string	ID du message. Cette valeur est unique pour chaque message.
body	items.body	string	Contenu de ce message.
message_direction	items.message_direction	string	Caractère singulier, R ou S, indiquant si ce message a été reçu du contact ou envoyé à eux, respectivement.
response_by_username	items.response_by_username	string	Nom d’utilisateur de l’utilisateur demande de texte qui a envoyé un message pour la dernière fois à cet utilisateur.
message_timestamp_utc	items.message_timestamp_utc	string	Horodatage de l’envoi ou de la réception du message par demande de texte.
delivery_status	items.delivery_status	string	État actuel de ce message. Il peut s’agir de l’option « envoi », « remise », « erreur » ou « envoi ».
delivery_error	items.delivery_error	string	Erreur qui a provoqué la remise de ce message. Si le delivery_status n’est pas « error », cette valeur est null.
mms_media	items.mms_media	array of string	Liste d’URL pointant vers les pièces jointes de ce message. Toutes les URL seront des URL générées par une requête de texte.

Obtenir tous les contacts qui correspondent au critère de filtrage spécifié

ID d’opération :: GetContacts

Obtient tous les contacts qui correspondent au critère de filtrage spécifié. Seul le tableau de bord spécifié sera recherché ; il n’existe aucune recherche au niveau du compte pour un nombre disponible.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Numéro de téléphone du contact à rechercher par	contact_phone_number		string	Numéro de téléphone par lequel filtrer les contacts.
'Last-message-time sent before' search timestamp in UTC time	last_message_timestamp_before_utc		date-time	Délai d’arrêt pour la recherche de contacts par le dernier message envoyé ou reçu. Aucun contact qui a envoyé des messages après cette heure ne s’affiche.
'Last-message-time sent after' search timestamp in UTC time	last_message_timestamp_after_utc		date-time	Délai d’arrêt pour la recherche de contacts par le dernier message envoyé ou reçu. Aucun contact dont le dernier message envoyé est avant cette heure sera affiché.
Horodatage de recherche 'Créé avant'	contact_created_before		date-time	Délai d’arrêt pour la recherche de contacts lors de leur création. Aucun contact créé après cette heure n’apparaît.
Horodatage de recherche 'Créé après'	contact_created_after		date-time	Délai d’arrêt pour la recherche de contacts lors de leur création. Aucun contact créé avant cette heure n’apparaît.
Indique si la conversation du contact est résolue	is_resolved		boolean	Indique s’il faut rechercher des contacts dont les conversations ont été résolues.
Indique si le contact est bloqué	is_blocked		boolean	Indique s’il faut rechercher les contacts qui ont été bloqués.
Indique si le contact est archivé	is_archived		boolean	Indique s’il faut rechercher des contacts qui ont été archivés.
Indique si le contact est supprimé	is_suppressed		boolean	Indique s’il faut rechercher des contacts qui ont été supprimés.
Indique si le contact a refusé	has_opted_out		boolean	Indique s’il faut rechercher des contacts qui ont refusé de recevoir des textes.
'Last-message-time sent before' search timestamp	last_message_sent_before		date-time	Délai d’arrêt pour la recherche de contacts par le moment où le dernier message a été envoyé au client. Aucun contact qui a envoyé des messages après cette heure ne s’affiche. Utilise l’horodatage comme heure locale. Pour filtrer par horodatage dans l’heure UTC, utilisez last_message_sent_before_utc
'Last-message-time sent after' search timestamp	last_message_sent_after		date-time	Délai d’arrêt pour la recherche de contacts par le moment où le dernier message a été envoyé au client. Aucun contact dont le dernier message envoyé est avant cette heure sera affiché. Utilise l’horodatage comme heure locale. Pour filtrer par horodatage dans l’heure UTC, utilisez last_message_sent_after_utc
'Last-message-time received before' search timestamp	last_message_received_before		date-time	Délai d’arrêt pour la recherche de contacts par le dernier message reçu du client. Aucun contact qui a reçu des messages après cette heure ne s’affiche. Utilise l’horodatage comme heure locale. Pour filtrer par horodatage dans l’heure UTC, utilisez last_message_sent_before_utc
'Last-message-time received after' search timestamp	last_message_received_after		date-time	Délai d’arrêt pour la recherche de contacts par le dernier message reçu du client. Aucun contact dont le dernier message envoyé est avant cette heure sera affiché. Utilise l’horodatage comme heure locale. Pour filtrer par horodatage dans l’heure UTC, utilisez last_message_sent_before_utc
Balises de contact	tags		string	Liste de guid séparés par des virgules faisant référence à des balises pour filtrer les contacts par.
Groupes de contacts	groups		string	Liste séparée par des virgules d’ID entiers faisant référence à des groupes pour filtrer les contacts par.
ID du champ personnalisé à filtrer par	custom_field_id_1		string	Guid faisant référence à un champ personnalisé pour filtrer les contacts par.
Valeur du champ personnalisé à filtrer par	custom_field_value_1		string	Valeur faisant référence au champ personnalisé par lequel filtrer les contacts.
ID du deuxième champ personnalisé à filtrer par	custom_field_id_2		string	Guid faisant référence au deuxième champ personnalisé par lequel filtrer les contacts.
Valeur du deuxième champ personnalisé à filtrer par	custom_field_value_2		string	Valeur faisant référence au deuxième champ personnalisé par lequel filtrer les contacts.
ID du troisième champ personnalisé à filtrer par	custom_field_id_3		string	Guid faisant référence au troisième champ personnalisé par lequel filtrer les contacts.
Valeur du troisième champ personnalisé à filtrer par	custom_field_value_3		string	Valeur faisant référence au troisième champ personnalisé par lequel filtrer les contacts.
Page numéro à obtenir	page	True	integer	Page des entités à obtenir. Lorsque vous obtenez des valeurs, il existe une taille maximale par page, définie par page_size. Si la page est supérieure à la dernière page, un tableau vide est retourné.
Quantité de chaque entité à obtenir par page	page_size	True	integer	Taille de chaque page à obtenir. Lorsque vous obtenez des valeurs, il s’agit d’une taille maximale par page, avec l’accès aux pages suivantes effectuées par le paramètre de page.
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.

Retours

Nom	Chemin d’accès	Type	Description
page	meta.page	integer	Page des entités obtenu. La quantité d’entités de cette page est définie par page_size.
page_size	meta.page_size	integer	Nombre d’entités obtenu dans cette page.
total_items	meta.total_items	integer	Nombre d’entités disponibles dans la base de données, quelle que soit la taille ou le nombre de pages. Pour afficher les autres pages, modifiez le numéro de page dans la demande.
items	items	array of object	Liste des entités de contact extraites de la demande de texte.
phone_number	items.phone_number	string	Numéro de téléphone de ce contact.
first_name	items.first_name	string	Prénom de ce contact.
last_name	items.last_name	string	Nom de ce contact.
display_name	items.display_name	string	Nom complet de ce contact. Il s’agit du nom par défaut affiché dans l’application web lors de l’affichage des contacts.
is_suppressed	items.is_suppressed	boolean	Indique si la conversation avec ce contact est supprimée et n’est donc pas envoyée en haut de la file d’attente de messages lorsqu’elle est reçue.
is_archived	items.is_archived	boolean	Indique si la conversation avec ce contact est archivée et ne peut donc pas être vue lors de l’interrogation des conversations (par défaut).
is_blocked	items.is_blocked	boolean	Indique si la conversation avec ce contact est bloquée et n’est donc pas reçue ou stockée.
suppressed_reason	items.suppressed_reason	string	Expression décrivant la raison de la suppression du contact. Si is_suppressed a la valeur false, cette valeur est null.
note	items.note	string	Phrase courte décrivant le contact. Utilisé pour des raisons pratiques. Cela n’est jamais montré au contact.
groups	items.groups	array of integer	Tableau d’ID entiers faisant référence aux groupes auxquels appartient ce contact.
contact_tags	items.contact_tags	array of string	Tableau de guid faisant référence à des balises attachées à ce contact.
custom_fields	items.custom_fields	array of object	Tableau d’ID et de valeurs de champ personnalisés définis pour ce contact.
pièce d'identité	items.custom_fields.id	string	Guid faisant référence à un champ personnalisé.
value	items.custom_fields.value	string	Valeur de ce contact pour ce champ personnalisé.
is_resolved	items.is_resolved	boolean	Indique si la conversation avec ce contact est résolue. Tous les nouveaux textes reçus par ce contact définissent cette valeur false.
first_contact_utc	items.first_contact_utc	string	Horodatage de l’envoi du premier message à ce contact.
opted_out_utc	items.opted_out_utc	string	Horodatage du moment où ce contact a choisi de recevoir des messages.
last_msg_sent_utc	items.last_msg_sent_utc	string	Horodatage de l’envoi du dernier message à ce contact.
last_msg_received_utc	items.last_msg_received_utc	string	Horodatage de l’heure de réception du dernier message de ce contact.
total_msgs_sent	items.total_msgs_sent	integer	Nombre total de messages envoyés à ce contact.
total_msgs_received	items.total_msgs_received	integer	Nombre total de messages reçus de ce contact.
response_count	items.response_count	integer	Nombre total de messages de réponse du contact.
date_created_utc	items.date_created_utc	string	Horodatage de la création du contact ths.
last_contact_date_utc	items.last_contact_date_utc	string	Horodatage de l’envoi ou de la réception du dernier message de ce contact.
message_id	items.last_message.message_id	string	ID du message. Cette valeur est unique pour chaque message.
body	items.last_message.body	string	Contenu de ce message.
message_direction	items.last_message.message_direction	string	Caractère singulier, R ou S, indiquant si ce message a été reçu du contact ou envoyé à eux, respectivement.
response_by_username	items.last_message.response_by_username	string	Nom d’utilisateur de l’utilisateur demande de texte qui a envoyé un message pour la dernière fois à cet utilisateur.
message_timestamp_utc	items.last_message.message_timestamp_utc	string	Horodatage de l’envoi ou de la réception du message par demande de texte.
delivery_status	items.last_message.delivery_status	string	État actuel de ce message. Il peut s’agir de l’option « envoi », « remise », « erreur » ou « envoi ».
delivery_error	items.last_message.delivery_error	string	Erreur qui a provoqué la remise de ce message. Si le delivery_status n’est pas « error », cette valeur est null.
mms_media	items.last_message.mms_media	array of string	Liste d’URL pointant vers les pièces jointes de ce message. Toutes les URL seront des URL générées par une requête de texte.

Obtenir tous les tableaux de bord dans un compte

ID d’opération :: GetDashboards

Obtient tous les tableaux de bord d’un compte.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Page numéro à obtenir	page		integer	Page des entités à obtenir. Lorsque vous obtenez des valeurs, il existe une taille maximale par page, définie par page_size. Si la page est supérieure à la dernière page, un tableau vide est retourné.
Quantité de chaque entité à obtenir par page	page_size		integer	Taille de chaque page à obtenir. Lorsque vous obtenez des valeurs, il s’agit d’une taille maximale par page, avec l’accès aux pages suivantes effectuées par le paramètre de page.

Retours

Nom	Chemin d’accès	Type	Description
page	meta.page	integer	Page des entités obtenu. La quantité d’entités de cette page est définie par page_size.
page_size	meta.page_size	integer	Nombre d’entités obtenu dans cette page.
total_items	meta.total_items	integer	Nombre d’entités disponibles dans la base de données, quelle que soit la taille ou le nombre de pages. Pour afficher les autres pages, modifiez le numéro de page dans la demande.
items	items	array of object	Liste des entités de tableau de bord extraites de la requête de texte.
pièce d'identité	items.id	integer	ID numérique du tableau de bord.
nom	items.name	string	Nom du tableau de bord.
phone	items.phone	string	Numéro de texte associé à ce tableau de bord.

Obtenir un groupe par son ID

ID d’opération :: GetGroupById

Obtient le groupe avec l’ID spécifié.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.
ID du groupe	group_id	True	integer	ID numérique du groupe à obtenir.

Retours

Nom	Chemin d’accès	Type	Description
pièce d'identité	id	integer	ID numérique du groupe.
group_member_count	group_member_count	integer	Nombre de membres du groupe.
is_keyword	is_keyword	boolean	Wheter ce groupe est un groupe de mots clés. Ces groupes sont générés automatiquement lorsqu’un utilisateur configure un mot clé. Les contacts sont automatiquement ajoutés lorsqu’ils s’inscrivent.
nom	name	string	Nom de ce groupe.
Remarques	notes	string	Toutes les notes de ce groupe.
last_message_sent_utc	last_message_sent_utc	string	Horodatage de l’envoi du dernier message de groupe pour ce groupe.

Obtient le contact avec le numéro de téléphone spécifié

ID d’opération :: GetContactByPhoneNumber

Obtient le contact avec le numéro de téléphone spécifié

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.
Numéro de téléphone du contact	phone_number	True	string	Numéro de téléphone du contact à obtenir.

Retours

Nom	Chemin d’accès	Type	Description
phone_number	phone_number	string	Numéro de téléphone de ce contact.
first_name	first_name	string	Prénom de ce contact.
last_name	last_name	string	Nom de ce contact.
display_name	display_name	string	Nom complet de ce contact. Il s’agit du nom par défaut affiché dans l’application web lors de l’affichage des contacts.
is_suppressed	is_suppressed	boolean	Indique si la conversation avec ce contact est supprimée et n’est donc pas envoyée en haut de la file d’attente de messages lorsqu’elle est reçue.
is_archived	is_archived	boolean	Indique si la conversation avec ce contact est archivée et ne peut donc pas être vue lors de l’interrogation des conversations (par défaut).
is_blocked	is_blocked	boolean	Indique si la conversation avec ce contact est bloquée et n’est donc pas reçue ou stockée.
suppressed_reason	suppressed_reason	string	Expression décrivant la raison de la suppression du contact. Si is_suppressed a la valeur false, cette valeur est null.
note	note	string	Phrase courte décrivant le contact. Utilisé pour des raisons pratiques. Cela n’est jamais montré au contact.
groups	groups	array of integer	Tableau d’ID entiers faisant référence aux groupes auxquels appartient ce contact.
contact_tags	contact_tags	array of string	Tableau de guid faisant référence à des balises attachées à ce contact.
custom_fields	custom_fields	array of object	Tableau d’ID et de valeurs de champ personnalisés définis pour ce contact.
pièce d'identité	custom_fields.id	string	Guid faisant référence à un champ personnalisé.
value	custom_fields.value	string	Valeur de ce contact pour ce champ personnalisé.
is_resolved	is_resolved	boolean	Indique si la conversation avec ce contact est résolue. Tous les nouveaux textes reçus par ce contact définissent cette valeur false.
first_contact_utc	first_contact_utc	string	Horodatage de l’envoi du premier message à ce contact.
opted_out_utc	opted_out_utc	string	Horodatage du moment où ce contact a choisi de recevoir des messages.
last_msg_sent_utc	last_msg_sent_utc	string	Horodatage de l’envoi du dernier message à ce contact.
last_msg_received_utc	last_msg_received_utc	string	Horodatage de l’heure de réception du dernier message de ce contact.
total_msgs_sent	total_msgs_sent	integer	Nombre total de messages envoyés à ce contact.
total_msgs_received	total_msgs_received	integer	Nombre total de messages reçus de ce contact.
response_count	response_count	integer	Nombre total de messages de réponse du contact.
date_created_utc	date_created_utc	string	Horodatage de la création du contact ths.
last_contact_date_utc	last_contact_date_utc	string	Horodatage de l’envoi ou de la réception du dernier message de ce contact.
message_id	last_message.message_id	string	ID du message. Cette valeur est unique pour chaque message.
body	last_message.body	string	Contenu de ce message.
message_direction	last_message.message_direction	string	Caractère singulier, R ou S, indiquant si ce message a été reçu du contact ou envoyé à eux, respectivement.
response_by_username	last_message.response_by_username	string	Nom d’utilisateur de l’utilisateur demande de texte qui a envoyé un message pour la dernière fois à cet utilisateur.
message_timestamp_utc	last_message.message_timestamp_utc	string	Horodatage de l’envoi ou de la réception du message par demande de texte.
delivery_status	last_message.delivery_status	string	État actuel de ce message. Il peut s’agir de l’option « envoi », « remise », « erreur » ou « envoi ».
delivery_error	last_message.delivery_error	string	Erreur qui a provoqué la remise de ce message. Si le delivery_status n’est pas « error », cette valeur est null.
mms_media	last_message.mms_media	array of string	Liste d’URL pointant vers les pièces jointes de ce message. Toutes les URL seront des URL générées par une requête de texte.

Obtient le paiement avec l’ID spécifié

ID d’opération :: GetPayment

Obtient le paiement avec l’ID spécifié.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.
ID du paiement	payment_id	True	integer	ID numérique du paiement à obtenir.

Retours

Nom	Chemin d’accès	Type	Description
payment_id	payment_id	integer	ID numérique du paiement.
request_date	request_date	string	Horodatage de l’envoi du message initial de ce paiement.
destinataire	recipient	string	Nom du destinataire du paiement. Cela peut être null si le contact n’a pas de nom associé à son numéro de téléphone.
descriptif	description	string	Description du paiement. Cela n’est pas affiché au contact. Il est utilisé uniquement par les utilisateurs internes pour le contexte des paiements.
customer_phone	customer_phone	string	Numéro de téléphone du contact en cours d’envoi de ce paiement.
amount_requested	amount_requested	float	Montant en dollars demandé par ce paiement.
is_past_due	is_past_due	boolean	Indique si ce paiement est antérieur à la date de demande.
reminder_was_sent	reminder_was_sent	boolean	Indique si un rappel texte a déjà été envoyé pour ce paiement.
transaction_status	transaction_status	string	État de la transaction dans authvia. Cette valeur commence par Unknown.
textrequest_payment_status	textrequest_payment_status	string	État de la transaction dans la demande de texte. Cela représente cet état affiché dans la page paiements de l’application Demande de texte. Il commence comme Envoyé.
reference_number	reference_number	string	ID défini par l’utilisateur défini lors de la création des paiements qui peuvent être utilisés pour rechercher rapidement les paiements. Les numéros de référence ne sont pas uniques ; de nombreux paiements peuvent avoir la même référence.

Obtient tous les champs personnalisés

ID d’opération :: GetCustomFields

Obtient tous les champs personnalisés pour ce tableau de bord. Les champs personnalisés sont uniques entre les tableaux de bord.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.

Retours

Nom	Chemin d’accès	Type	Description
		array of object
pièce d'identité	id	string	ID numérique du champ.
nom	name	string	Nom du champ personnalisé.

Obtient tous les groupes

ID d’opération :: GetGroups

Obtient tous les groupes pour le compte de l’utilisateur.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Page numéro à obtenir	page	True	integer	Page des entités à obtenir. Lorsque vous obtenez des valeurs, il existe une taille maximale par page, définie par page_size. Si la page est supérieure à la dernière page, un tableau vide est retourné.
Quantité de chaque entité à obtenir par page	page_size	True	integer	Taille de chaque page à obtenir. Lorsque vous obtenez des valeurs, il s’agit d’une taille maximale par page, avec l’accès aux pages suivantes effectuées par le paramètre de page.
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.

Retours

Nom	Chemin d’accès	Type	Description
page	meta.page	integer	Page des entités obtenu. La quantité d’entités de cette page est définie par page_size.
page_size	meta.page_size	integer	Nombre d’entités obtenu dans cette page.
total_items	meta.total_items	integer	Nombre d’entités disponibles dans la base de données, quelle que soit la taille ou le nombre de pages. Pour afficher les autres pages, modifiez le numéro de page dans la demande.
items	items	array of object	Liste des entités de groupe extraites de la requête de texte.
pièce d'identité	items.id	integer	ID numérique du groupe.
group_member_count	items.group_member_count	integer	Nombre de membres du groupe.
is_keyword	items.is_keyword	boolean	Wheter ce groupe est un groupe de mots clés. Ces groupes sont générés automatiquement lorsqu’un utilisateur configure un mot clé. Les contacts sont automatiquement ajoutés lorsqu’ils s’inscrivent.
nom	items.name	string	Nom de ce groupe.
Remarques	items.notes	string	Toutes les notes de ce groupe.
last_message_sent_utc	items.last_message_sent_utc	string	Horodatage de l’envoi du dernier message de groupe pour ce groupe.

Obtient tous les paiements

ID d’opération :: GetPayments

Obtient tous les paiements, y compris les paiements annulés et payés. Ceux-ci peuvent être filtrés à l’aide des paramètres de requête.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Chaîne de référence du paiement	reference_number		string	ID défini par l’utilisateur défini lorsque les paiements sont créés, qui peuvent être utilisés pour rechercher rapidement les paiements. Les numéros de référence ne sont pas uniques ; de nombreux paiements peuvent avoir la même référence.
Numéro de téléphone de paiement	phone_number		string	Numéro de téléphone du contact à qui ce paiement a été envoyé.
Trier par	sort_type		string	Propriété par laquelle trier les paiements. Peut être « amount », « contact », « date », « status ».
Direction du tri	sort_direction		string	Direction pour trier les paiements. Peut être « desc » pour le plus petit au plus petit, ou « asc » pour le plus petit au plus grand.
Page numéro à obtenir	page	True	integer	Page des entités à obtenir. Lorsque vous obtenez des valeurs, il existe une taille maximale par page, définie par page_size. Si la page est supérieure à la dernière page, un tableau vide est retourné.
Quantité de chaque entité à obtenir par page	page_size	True	integer	Taille de chaque page à obtenir. Lorsque vous obtenez des valeurs, il s’agit d’une taille maximale par page, avec l’accès aux pages suivantes effectuées par le paramètre de page.
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.

Retours

Nom	Chemin d’accès	Type	Description
page	meta.page	integer	Page des entités obtenu. La quantité d’entités de cette page est définie par page_size.
page_size	meta.page_size	integer	Nombre d’entités obtenu dans cette page.
total_items	meta.total_items	integer	Nombre d’entités disponibles dans la base de données, quelle que soit la taille ou le nombre de pages. Pour afficher les autres pages, modifiez le numéro de page dans la demande.
items	items	array of object	Liste des entités de paiement extraites de la demande de texte.
payment_id	items.payment_id	integer	ID numérique du paiement.
request_date	items.request_date	string	Horodatage de l’envoi du message initial de ce paiement.
destinataire	items.recipient	string	Nom du destinataire du paiement. Cela peut être null si le contact n’a pas de nom associé à son numéro de téléphone.
descriptif	items.description	string	Description du paiement. Cela n’est pas affiché au contact. Il est utilisé uniquement par les utilisateurs internes pour le contexte des paiements.
customer_phone	items.customer_phone	string	Numéro de téléphone du contact en cours d’envoi de ce paiement.
amount_requested	items.amount_requested	float	Montant en dollars demandé par ce paiement.
is_past_due	items.is_past_due	boolean	Indique si ce paiement est antérieur à la date de demande.
reminder_was_sent	items.reminder_was_sent	boolean	Indique si un rappel texte a déjà été envoyé pour ce paiement.
transaction_status	items.transaction_status	string	État de la transaction dans authvia. Cette valeur commence par Unknown.
textrequest_payment_status	items.textrequest_payment_status	string	État de la transaction dans la demande de texte. Cela représente cet état affiché dans la page paiements de l’application Demande de texte. Il commence comme Envoyé.
reference_number	items.reference_number	string	ID défini par l’utilisateur défini lors de la création des paiements qui peuvent être utilisés pour rechercher rapidement les paiements. Les numéros de référence ne sont pas uniques ; de nombreux paiements peuvent avoir la même référence.

Obtient toutes les balises

ID d’opération :: GetTags

Obtient toutes les balises pour ce tableau de bord. Les balises sont uniques entre les tableaux de bord.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.
Page numéro à obtenir	page	True	integer	Page des entités à obtenir. Lorsque vous obtenez des valeurs, il existe une taille maximale par page, définie par page_size. Si la page est supérieure à la dernière page, un tableau vide est retourné.
Quantité de chaque entité à obtenir par page	page_size	True	integer	Taille de chaque page à obtenir. Lorsque vous obtenez des valeurs, il s’agit d’une taille maximale par page, avec l’accès aux pages suivantes effectuées par le paramètre de page.

Retours

Nom	Chemin d’accès	Type	Description
page	meta.page	integer	Page des entités obtenu. La quantité d’entités de cette page est définie par page_size.
page_size	meta.page_size	integer	Nombre d’entités obtenu dans cette page.
total_items	meta.total_items	integer	Nombre d’entités disponibles dans la base de données, quelle que soit la taille ou le nombre de pages. Pour afficher les autres pages, modifiez le numéro de page dans la demande.
items	items	array of object	Liste des entités d’étiquettes extraites de la demande de texte.
pièce d'identité	items.id	string	ID numérique de la balise.
tag_color	items.tag_color	string	Couleur de la balise. Il doit s’agir d’un code de couleur hexadécimal valide.
tag	items.tag	string	Nom de la balise.

Obtient toutes les conversations pour ce tableau de bord

ID d’opération :: GetConversations

Obtient toutes les conversations pour ce tableau de bord et inclut des informations sur le dernier message de chaque conversation.

Paramètres

Nom	Clé	Obligatoire	Type	Description
Balises de contact	tags		string	Liste séparée par des virgules de guid faisant référence à des balises pour filtrer les conversations par.
Indique s’il faut afficher uniquement les conversations résolues	show_unresolved_only		string	Indique s’il faut rechercher uniquement des contacts dont les conversations ont été résolues. S’il s’agit d’une valeur false, les conversations résolues et non résolues sont affichées.
Indique s’il faut inclure des conversations archivées	include_archived		string	Indique s’il faut inclure des conversations avec des contacts qui ont été archivés.
Terme à filtrer par numéro de téléphone et nom de contact	search		string	Terme de recherche pour filtrer les conversations par numéro de téléphone ou nom complet. Si le terme de recherche est inférieur à un nom complet ou un numéro de téléphone, la recherche retourne toutes les conversations qui correspondent partiellement à celle-ci.
Page numéro à obtenir	page		integer	Page des entités à obtenir. Lorsque vous obtenez des valeurs, il existe une taille maximale par page, définie par page_size. Si la page est supérieure à la dernière page, un tableau vide est retourné.
Quantité de chaque entité à obtenir par page	page_size		integer	Taille de chaque page à obtenir. Lorsque vous obtenez des valeurs, il s’agit d’une taille maximale par page, avec l’accès aux pages suivantes effectuées par le paramètre de page.
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.

Retours

Nom	Chemin d’accès	Type	Description
page	meta.page	integer	Page des entités obtenu. La quantité d’entités de cette page est définie par page_size.
page_size	meta.page_size	integer	Nombre d’entités obtenu dans cette page.
total_items	meta.total_items	integer	Nombre d’entités disponibles dans la base de données, quelle que soit la taille ou le nombre de pages. Pour afficher les autres pages, modifiez le numéro de page dans la demande.
items	items	array of object	Liste des entités de conversation extraites de la demande de texte.
phone_number	items.phone_number	string	Numéro de téléphone du contact.
message_id	items.last_message.message_id	string	ID du message. Cette valeur est unique pour chaque message.
body	items.last_message.body	string	Contenu de ce message.
message_direction	items.last_message.message_direction	string	Caractère singulier, R ou S, indiquant si ce message a été reçu du contact ou envoyé à eux, respectivement.
response_by_username	items.last_message.response_by_username	string	Nom d’utilisateur de l’utilisateur demande de texte qui a envoyé un message pour la dernière fois à cet utilisateur.
message_timestamp_utc	items.last_message.message_timestamp_utc	string	Horodatage de l’envoi ou de la réception du message par demande de texte.
delivery_status	items.last_message.delivery_status	string	État actuel de ce message. Il peut s’agir de l’option « envoi », « remise », « erreur » ou « envoi ».
delivery_error	items.last_message.delivery_error	string	Erreur qui a provoqué la remise de ce message. Si le delivery_status n’est pas « error », cette valeur est null.
mms_media	items.last_message.mms_media	array of string	Liste d’URL pointant vers les pièces jointes de ce message. Toutes les URL seront des URL générées par une requête de texte.

Supprime le contact avec le numéro de téléphone spécifié

ID d’opération :: DeleteContact

Supprime le contact avec le numéro de téléphone spécifié

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.
Numéro de téléphone du contact	phone_number	True	string	Numéro de téléphone du contact à supprimer.

Retours

response: string

Supprime le groupe avec l’ID spécifié

ID d’opération :: DeleteGroup

Supprime le groupe avec l’ID spécifié. Cela réussit même s’il existe des contacts membres du groupe (les contacts ne seront pas supprimés).

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.
ID du groupe	group_id	True	integer	ID numérique du groupe à supprimer.

Retours

response: string

Supprime le tableau de bord spécifié

ID d’opération :: DeleteDashboard

Supprime le tableau de bord spécifié.

Paramètres

Nom	Clé	Obligatoire	Type	Description
ID du tableau de bord sur lequel effectuer cet appel	dashboard_id	True	integer	Tableau de bord du numéro de téléphone sur lequel travailler. Un seul compte peut avoir plusieurs tableaux de bord, représentant différentes lignes téléphoniques pour les clients.

Retours

response: string

Déclencheurs

Se déclenche lorsqu’un texte est envoyé ou reçu

ID d’opération :: TextingWebhook

Se déclenche lorsqu’un texte est envoyé ou reçu

Paramètres

Nom	Clé	Obligatoire	Type	Description
Le tableau de bord du déclencheur écoute les événements à partir de	dashboard_id	True	string	ID du tableau de bord à ajouter un déclencheur à
événement	event	True	string	événement

Retours

Nom	Chemin d’accès	Type	Description
Message Unique Id	messageUniqueIdentifier	string	messageUniqueIdentifier
ID de compte	account.id	integer	pièce d'identité
ID de la conversation	yourPhoneNumber.id	integer	pièce d'identité
Nom du tableau de bord	yourPhoneNumber.description	string	descriptif
Numéro de téléphone du tableau de bord	yourPhoneNumber.phoneNumber	string	numéro de téléphone
ID du tableau de bord	conversation.id	integer	pièce d'identité
date	conversation.date	string	date
Numéro de téléphone du contact	conversation.consumerPhoneNumber	string	consumerPhoneNumber
messageDirection	conversation.messageDirection	string	messageDirection
Message	conversation.message	string	Message
numSegments	conversation.numSegments	integer	numSegments
status	conversation.status	string	status
Conversation revendiquée par	conversation.claimedBy	string	claimedBy
Nom complet du contact	conversation.consumerFriendlyName	string	consumerFriendlyName

Définitions

ficelle

Il s’agit du type de données de base « string ».

Partager via

Demande de texte

Aranda Service Management Suite (ASMS)

Conditions préalables

Obtention des informations d’identification

Bien démarrer avec votre connecteur

Réponse réussie

Erreurs courantes et solutions

Questions fréquentes (FAQ)

Création d’une connexion

Faire défaut

Limitations

Actions

Annule le paiement spécifié

Paramètres

Retours

Annuler l’archivage d’une conversation

Paramètres

Retours

Archiver une conversation

Paramètres

Retours

Crée un groupe

Paramètres

Retours

Crée un paiement

Paramètres

Retours

Créer ou mettre à jour un contact

Paramètres

Retours

Créer un tableau de bord avec le nom et le numéro de téléphone donnés

Paramètres

Retours

Envoyer un message au contact avec le numéro de téléphone donné

Paramètres

Retours

Envoyer un texte de suivi rappelant à l’utilisateur de payer le paiement spécifié

Paramètres

Retours

Marquer un paiement comme payé

Paramètres

Retours

Met à jour un groupe avec l’ID donné

Paramètres

Retours

Mettre à jour en bloc les contacts

Paramètres

Retours

Mettre à jour le nom d’un tableau de bord spécifique

Paramètres

Retours

Obtenir des informations sur ce tableau de bord spécifique

Paramètres

Retours

Obtenir les messages d’une conversation par numéro de téléphone d’un contact

Paramètres

Retours

Obtenir tous les contacts qui correspondent au critère de filtrage spécifié

Paramètres

Retours

Obtenir tous les tableaux de bord dans un compte

Paramètres

Retours

Obtenir un groupe par son ID

Paramètres

Retours

Obtient le contact avec le numéro de téléphone spécifié

Paramètres

Retours

Obtient le paiement avec l’ID spécifié

Paramètres

Retours

Obtient tous les champs personnalisés

Paramètres

Retours

Obtient tous les groupes

Paramètres

Retours

Obtient tous les paiements