ClickSend
ClickSend for business SMS qui est remis ; alertes, notifications, invitations, messages marketing et bien plus encore. ClickSend est un logiciel de communication métier qui permet aux entreprises de toutes formes et tailles d’envoyer et de recevoir facilement des SMS, e-mails, voix et même publier dans le monde entier via l’application web ou l’API. ClickSend a SMS à son cœur et alimente des milliards de messages dans le monde entier via des itinéraires directs, mais a développé pour offrir une suite complète de produits offrant un choix et un contexte à vos communications commerciales.
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 ClickSend SMS |
| URL | https://www.clicksend.com/au/help |
| Messagerie électronique | Support@clicksend.com |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Sinch Suède AB |
| Site internet | https://www.clicksend.com |
| Politique de confidentialité | https://www.clicksend.com/us/legal/privacy-policy |
| Catégories | Communication; Marketing |
ClickSend Connector pour Microsoft Power Automate
Créez des flux de travail automatisés entre les applications pour synchroniser des fichiers, obtenir des notifications, collecter des données et bien plus encore avec Microsoft Power Automate. Connectez ClickSend à Power Automate pour ajouter la messagerie automatisée à vos flux de travail , sur presque n’importe quel système.
Supercharger votre messagerie avec ClickSend
Le connecteur ClickSend vous permet d’intégrer de puissantes fonctionnalités de messagerie dans vos workflows automatisés. En quelques clics, vous pouvez connecter ClickSend à plus de 700 connecteurs Microsoft Power Automate pour créer des flux de communication transparents.
Principales fonctionnalités
- Envoyer des SMS : envoyez automatiquement des messages SMS déclenchés par des événements dans d’autres applications (par exemple, soumissions de formulaires, mises à jour de calendrier, e-mails).
- Envoyer MMS : partagez du contenu multimédia comme des images ou des fichiers via des flux de travail automatisés.
- Envoyer la voix : utilisez des fichiers audio ou de synthèse vocale pour transmettre des appels vocaux.
- Envoyer une télécopie : envoyez des télécopies numériques directement à partir de vos flux.
- Envoyer un billet : envoyez automatiquement des lettres ou des cartes postales par le biais de services postaux.
Exemples de cas d’usage
- Recevez un SMS lorsqu’une réunion est ajoutée ou modifiée dans votre calendrier.
- Recevez une notification texte lorsque vous recevez un e-mail d’un client VIP.
- Envoyez un MMS à partir de ClickSend lorsqu’un nouveau fichier est chargé dans Dropbox.
- Automatisez le marketing ou l’engagement client avec des flux de travail de messagerie basées sur des modèles.
- Gérez les listes de contacts ou répondez aux sms entrants avec des déclencheurs personnalisés.
Utilisez nos modèles prédéfinis pour simplifier la configuration ou créer vos propres automatisations personnalisées avec facilité.
Connexion de votre compte ClickSend
- Accédez au tableau de bord Power Automate .
- Accédez à Nouvelle connexion aux connexions > de données>.
- Recherchez ClickSend SMS.
- Entrez vos informations d’identification de l’API ClickSend :
-
username: nom d’utilisateur de votre compte ClickSend -
api_key: Votre clé API à partir du tableau de bord ClickSend
-
- Cliquez sur Créer : votre compte est maintenant connecté !
Spécifications
- Un compte ClickSend (inscrivez-vous à clicksend.com).
- Informations d’identification de l’API (nom d’utilisateur et clé API).
En savoir plus
Visitez le Portail des développeurs ClickSend pour explorer les fonctionnalités complètes de l’API et les cas d’utilisation.
Améliorez vos flux de travail avec la messagerie automatisée , alimenté par ClickSend et Microsoft Power Automate.
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 est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| Nom d’utilisateur | securestring | Nom d’utilisateur de cette API | Vrai |
| 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
| Convertir le format de fichier multimédia |
Convertir le format de fichier multimédia |
| Créer un contact |
Créer un contact |
| Créer une liste de contacts |
Créer une liste de contacts |
| Envoyer MMS |
Envoyer MMS |
| Envoyer un message vocal |
Chaque 300 caractères = 1 message vocal. Peut envoyer jusqu’à 1 200 caractères standard |
| Envoyer un SMS |
Chaque 160 caractères = 1 SMS. Peut envoyer jusqu’à 1 224 caractères standard. |
| Envoyer une carte postale |
Envoyer une ou plusieurs cartes postales |
| Envoyer une télécopie |
Envoyer une télécopie |
| Lettre d’envoi |
Lettre d’envoi |
| Obtenir des contacts dans une liste |
Obtenir tous les contacts dans une liste |
| Obtenir des listes de contacts |
Obtenir toutes les listes de contacts, sauf si elles sont spécifiées dans les options préalables |
| Rechercher des listes de contacts |
Obtenir la liste des contacts recherchés |
| Supprimer la liste |
Supprimer une liste de contacts spécifique |
| Supprimer un contact |
Supprimer un contact |
Convertir le format de fichier multimédia
Convertir le format de fichier multimédia
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Sélectionner l’action pour laquelle le fichier est nécessaire
|
convert | True | string |
Sélectionner l’action pour laquelle le fichier est nécessaire |
|
Fichier
|
content | True | byte |
Contenu du fichier (base64) |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Code de réponse
|
response_code | string |
Code de réponse |
|
Message de réponse
|
response_msg | string |
Message de réponse |
|
ID de chargement
|
data.upload_id | integer |
ID de chargement |
|
Nom du fichier
|
data.file_name | string |
Nom du fichier |
|
Date ajoutée
|
data.date_added | integer |
Date ajoutée |
|
Date de suppression
|
data.date_delete | integer |
Date de suppression |
|
ID d’utilisateur
|
data.user_id | integer |
ID d’utilisateur |
|
URL
|
data._url | string |
URL |
Créer un contact
Créer un contact
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de liste
|
list_id | True | integer |
Vous pouvez utiliser l’action Rechercher dans la liste de contacts OU obtenir l’action Liste de contacts pour obtenir l’ID de liste |
|
Prénom
|
first_name | True | string |
Prénom du contact. |
|
Nom de famille
|
last_name | True | string |
Nom du contact. |
|
Numéro de téléphone
|
phone_number | True | string |
Téléphone de contact au format local ou international, par exemple +61411111111. |
|
Messagerie électronique
|
string |
Adresse e-mail du contact. |
||
|
Numéro de télécopie
|
fax_number | string |
Numéro de télécopie du contact. |
|
|
Nom de l’organisation
|
organization_name | string |
Nom de l’organisation du contact. |
|
|
Pays
|
address_country | string |
Le pays du contact. |
|
|
État
|
address_state | string |
État |
|
|
Ville
|
address_city | string |
Ville d’adresse |
|
|
Personnalisé 1
|
custom_1 | string |
Personnalisé 1 |
|
|
Personnalisé 3
|
custom_3 | string |
Personnalisé 3 |
|
|
Code postal
|
address_postal_code | string | ||
|
Personnalisé 2
|
custom_2 | string |
Personnalisé 2 |
|
|
Personnalisé 4
|
custom_4 | string |
Personnalisé 4 |
|
|
Ligne d’adresse 1
|
address_line_1 | string |
Ligne d’adresse 1 |
|
|
Ligne d’adresse 2
|
address_line_2 | string |
Ligne d’adresse 2 |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Code de réponse
|
response_code | string |
Code de réponse |
|
Message de réponse
|
response_msg | string |
Message de réponse |
|
Identifiant de contact
|
data.contact_id | integer |
Identifiant de contact |
|
ID de liste
|
data.list_id | integer |
ID de liste |
|
Numéro de téléphone
|
data.phone_number | string |
Numéro de téléphone |
|
Prénom
|
data.first_name | string |
Prénom |
|
Nom de famille
|
data.last_name | string |
Nom de famille |
|
Personnalisé 1
|
data.custom_1 | string |
Personnalisé 1 |
|
Personnalisé 2
|
data.custom_2 | string |
Personnalisé 2 |
|
Personnalisé 3
|
data.custom_3 | string |
Personnalisé 3 |
|
Personnalisé 4
|
data.custom_4 | string |
Personnalisé 4 |
|
Date ajoutée
|
data.date_added | integer |
Date ajoutée |
|
Numéro de télécopie
|
data.fax_number | string |
Numéro de télécopie |
|
Nom de l’organisation
|
data.organization_name | string |
Nom de l’organisation |
|
Messagerie électronique
|
data.email | string |
Messagerie électronique |
|
Ligne d’adresse 1
|
data.address_line_1 | string |
Ligne d’adresse 1 |
|
Ligne d’adresse 2
|
data.address_line_2 | string |
Ligne d’adresse 2 |
|
Ville d’adresse
|
data.address_city | string |
Ville d’adresse |
|
État de l’adresse
|
data.address_state | string |
État de l’adresse |
|
Code postal d’adresse
|
data.address_postal_code | string |
Code postal d’adresse |
|
Pays d’adresse
|
data.address_country | string |
Pays d’adresse |
|
Nom de la liste
|
data._list_name | string |
Nom de la liste |
Créer une liste de contacts
Créer une liste de contacts
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de la liste
|
list_name | True | string |
Nom de votre liste de contacts |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Code de réponse
|
response_code | string |
Code de réponse |
|
Message de réponse
|
response_msg | string |
Message de réponse |
|
ID de liste
|
data.list_id | integer |
ID de liste |
|
Nom de la liste
|
data.list_name | string |
Nom de la liste |
|
ID d’e-mail de liste
|
data.list_email_id | string |
ID d’e-mail de liste |
|
Nombre de contacts
|
data._contacts_count | integer |
Nombre de contacts |
Envoyer MMS
Envoyer MMS
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
à
|
to | True | string |
Numéro de téléphone mobile. Peut être au format local ou international. Doit être au format international (E.164) s’il est envoyé à un autre pays. par exemple + 61411111111. |
|
Objet
|
subject | True | string |
Ligne d’objet. Maximum 20 caractères. |
|
Message
|
body | True | string |
Corps du message. Jusqu’à 1500 caractères ou 500 caractères Unicode |
|
Chaîne personnalisée
|
custom_string | string |
Il s’agit de votre référence. Elle s’affiche sur tous les rapports et sera renvoyée avec toutes les réponses. |
|
|
URL du média
|
media_file | True | string |
Prend en charge la taille de fichier maximale de 250 ko, Gif ne peut être pris en charge que si elle est inférieure à 100 kB. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Code de réponse
|
response_code | string |
Code de réponse |
|
Message de réponse
|
response_msg | string |
Message de réponse |
|
Prix total
|
data.total_price | float |
Prix total |
|
Nombre total
|
data.total_count | integer |
Nombre total |
|
Nombre mis en file d’attente
|
data.queued_count | integer |
Nombre mis en file d’attente |
|
messages
|
data.messages | array of object |
Msg |
|
ID de liste
|
data.messages.list_id | integer |
ID de liste |
|
Identifiant de contact
|
data.messages.contact_id | integer |
Identifiant de contact |
|
ID de message
|
data.messages.message_id | string |
ID de message |
|
À
|
data.messages.to | string |
À |
|
Sujet
|
data.messages.subject | string |
Sujet |
|
De
|
data.messages.from | string |
De |
|
Corps
|
data.messages.body | string |
Corps |
|
Pays
|
data.messages.country | string |
Pays |
|
Chaîne personnalisée
|
data.messages.custom_string | string |
Chaîne personnalisée |
|
Parties de message
|
data.messages.message_parts | integer |
Parties de message |
|
Prix du message
|
data.messages.message_price | string |
Prix du message |
|
URL du fichier multimédia
|
data.messages._media_file_url | string |
URL du fichier multimédia |
|
Statut
|
data.messages.status | string |
Statut |
Envoyer un message vocal
Chaque 300 caractères = 1 message vocal. Peut envoyer jusqu’à 1 200 caractères standard
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
À
|
to | True | string |
Numéro de téléphone mobile ou fixe au format local ou international. Doit être au format international (E.164) si vous envoyez à un autre pays, par exemple. +61411111111. |
|
Corps
|
body | True | string |
Corps du message à lire. |
|
Language
|
lang | True | string |
Choisissez la langue que vous souhaitez utiliser. |
|
Voix
|
voice | True | string |
Choisissez le message à lire dans une voix masculine de femme. |
|
Chaîne personnalisée
|
custom_string | string |
Il s’agit de votre référence. Elle s’affiche sur tous les rapports et sera renvoyée avec toutes les réponses. |
|
|
Exiger une entrée
|
require_input | integer |
Recevez une touche d’accès du destinataire. La valeur de l’indicateur doit être 1 pour oui ou 0 pour non. |
|
|
Détection des machines
|
machine_detection | integer |
Détectez la machine de réponse ou la messagerie vocale et laissez un message. La valeur de l’indicateur doit être 1 pour oui ou 0 pour non. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Code de réponse
|
response_code | string |
Code de réponse |
|
Message de réponse
|
response_msg | string |
Message de réponse |
|
Prix total
|
data.total_price | float |
Prix total |
|
Nombre total
|
data.total_count | integer |
Nombre total |
|
Nombre mis en file d’attente
|
data.queued_count | integer |
Nombre mis en file d’attente |
|
messages
|
data.messages | array of object |
messages |
|
ID d’utilisateur
|
data.messages.user_id | integer |
ID d’utilisateur |
|
ID de sous-compte
|
data.messages.subaccount_id | integer |
ID de sous-compte |
|
ID de message
|
data.messages.message_id | string |
ID de message |
|
À
|
data.messages.to | string |
À |
|
Pour taper
|
data.messages.to_type | string |
Pour taper |
|
De
|
data.messages.from | string |
De |
|
Voix
|
data.messages.voice | string |
Voix |
|
Language
|
data.messages.lang | string |
Language |
|
Corps
|
data.messages.body | string |
Bddy |
|
Transporteur
|
data.messages.carrier | string |
Transporteur |
|
Pays
|
data.messages.country | string |
Pays |
|
Chaîne personnalisée
|
data.messages.custom_string | string |
Chaîne personnalisée |
|
Calendrier
|
data.messages.schedule | integer |
Calendrier |
|
Parties de message
|
data.messages.message_parts | integer |
Parties de message |
|
Prix du message
|
data.messages.message_price | string |
Prix du message |
|
Date ajoutée
|
data.messages.date_added | integer |
Date ajoutée |
|
Exiger une entrée
|
data.messages.require_input | integer |
Exiger une entrée |
|
Détection des machines
|
data.messages.machine_detection | integer |
Détection des machines |
|
Statut
|
data.messages.status | string |
Statut |
|
Nom de devise short
|
data._currency.currency_name_short | string |
Nom de devise short |
|
Préfixe monétaire D
|
data._currency.currency_prefix_d | string |
Préfixe monétaire D |
|
Préfixe monétaire C
|
data._currency.currency_prefix_c | string |
Préfixe monétaire C |
|
Nom de la devise Long
|
data._currency.currency_name_long | string |
Nom de la devise Long |
Envoyer un SMS
Chaque 160 caractères = 1 SMS. Peut envoyer jusqu’à 1 224 caractères standard.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
À
|
to | True | string |
Numéro de téléphone mobile. Peut être au format local ou international. Doit être au format international (E.164) s’il est envoyé à un autre pays. par exemple + 61411111111. |
|
Corps
|
body | True | string |
160 caractères sont 1 SMS. Peut envoyer jusqu’à 1 224 caractères standard. |
|
Chaîne personnalisée
|
custom_string | string |
Il s’agit de votre référence. Elle s’affiche sur tous les rapports et sera renvoyée avec toutes les réponses. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Code de réponse
|
response_code | string |
Code de réponse |
|
Msg de réponse
|
response_msg | string |
Msg de réponse |
|
Prix total
|
data.total_price | float |
Prix total |
|
Nombre total
|
data.total_count | integer |
Nombre total |
|
Nombre mis en file d’attente
|
data.queued_count | integer |
Nombre mis en file d’attente |
|
messages
|
data.messages | array of object |
Message |
|
Direction
|
data.messages.direction | string |
Direction |
|
Date
|
data.messages.date | integer |
Date |
|
À
|
data.messages.to | string |
À |
|
Corps
|
data.messages.body | string |
Corps |
|
De
|
data.messages.from | string |
De |
|
Message Id
|
data.messages.message_id | string |
Message Id |
|
Parties de message
|
data.messages.message_parts | integer |
Parties de message |
|
Prix du message
|
data.messages.message_price | string |
Prix du message |
|
À partir de l’e-mail
|
data.messages.from_email | string |
À partir de l’e-mail |
|
ID de liste
|
data.messages.list_id | string |
ID de liste |
|
Chaîne personnalisée
|
data.messages.custom_string | string |
Chaîne personnalisée |
|
Contact Id
|
data.messages.contact_id | string |
Contact Id |
|
Identifiant
|
data.messages.user_id | integer |
Identifiant |
|
ID de sous-compte
|
data.messages.subaccount_id | integer |
ID de sous-compte |
|
Pays
|
data.messages.country | string |
Pays |
|
Transporteur
|
data.messages.carrier | string |
Transporteur |
|
Statut
|
data.messages.status | string |
Statut |
|
Nom de devise short
|
data._currency.currency_name_short | string |
Nom de devise short |
|
Préfixe monétaire D
|
data._currency.currency_prefix_d | string |
Préfixe monétaire D |
|
Préfixe monétaire C
|
data._currency.currency_prefix_c | string |
Préfixe monétaire C |
|
Nom de la devise Long
|
data._currency.currency_name_long | string |
Nom de la devise Long |
Envoyer une carte postale
Envoyer une ou plusieurs cartes postales
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom
|
address_name | True | string |
Nom de l’adresse |
|
Ville
|
address_city | True | string |
Ville |
|
État
|
address_state | True | string |
État |
|
Code postal
|
address_postal_code | True | string |
Code postal |
|
Pays
|
address_country | True | string |
Pays |
|
ID d’adresse de retour
|
return_address_id | True | integer |
ID d’adresse de retour à utiliser |
|
Ligne d’adresse 1
|
address_line_1 | True | string |
Première ligne d’adresse |
|
Ligne d’adresse 2
|
address_line_2 | string |
Deuxième ligne d’adresse |
|
|
file_urls
|
file_urls | True | array of string |
URL du fichier PDF |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Code de réponse
|
response_code | string |
Code de réponse |
|
Message de réponse
|
response_msg | string |
Message de réponse |
|
Prix total
|
data.total_price | double |
Prix total |
|
Nombre total
|
data.total_count | integer |
Nombre total |
|
Nombre mis en file d’attente
|
data.queued_count | integer |
Nombre mis en file d’attente |
|
destinataires
|
data.recipients | array of object |
Recipient |
|
ID d’utilisateur
|
data.recipients.user_id | integer |
ID d’utilisateur |
|
ID de sous-compte
|
data.recipients.subaccount_id | integer |
ID de sous-compte |
|
ID de message
|
data.recipients.message_id | string |
ID de message |
|
Nom de l’adresse
|
data.recipients.address_name | string |
Nom de l’adresse |
|
Ligne d’adresse 1
|
data.recipients.address_line_1 | string |
Ligne d’adresse 1 |
|
Ligne d’adresse 2
|
data.recipients.address_line_2 | string |
Ligne d’adresse 2 |
|
Ville d’adresse
|
data.recipients.address_city | string |
Ville d’adresse |
|
État de l’adresse
|
data.recipients.address_state | string |
État de l’adresse |
|
Code postal d’adresse
|
data.recipients.address_postal_code | string |
Code postal d’adresse |
|
Pays d’adresse
|
data.recipients.address_country | string |
Pays d’adresse |
|
ID d’adresse de retour
|
data.recipients.return_address_id | integer |
ID d’adresse de retour |
|
Calendrier
|
data.recipients.schedule | integer |
Calendrier |
|
Publier le prix
|
data.recipients.post_price | string |
Publier le prix |
|
Statut
|
data.recipients.status | string |
Statut |
|
Date ajoutée
|
data.recipients.date_added | integer |
Date ajoutée |
|
URL du fichier
|
data.recipients._file_url | string |
URL du fichier |
|
ID d’adresse de retour
|
data.recipients._return_address.return_address_id | integer |
ID d’adresse de retour |
|
ID d’utilisateur
|
data.recipients._return_address.user_id | integer |
ID d’utilisateur |
|
Nom de l’adresse
|
data.recipients._return_address.address_name | string |
Nom de l’adresse |
|
Ligne d’adresse 1
|
data.recipients._return_address.address_line_1 | string |
Ligne d’adresse 1 |
|
Ligne d’adresse 2
|
data.recipients._return_address.address_line_2 | string |
Ligne d’adresse 2 |
|
Ville d’adresse
|
data.recipients._return_address.address_city | string |
Ville d’adresse |
|
État de l’adresse
|
data.recipients._return_address.address_state | string |
État de l’adresse |
|
Code postal d’adresse
|
data.recipients._return_address.address_postal_code | string |
Code postal d’adresse |
|
Pays d’adresse
|
data.recipients._return_address.address_country | string |
Pays d’adresse |
|
Nom d’utilisateur de l’API
|
data.recipients._api_username | string |
Nom d’utilisateur de l’API |
|
Nom de devise short
|
data._currency.currency_name_short | string |
Nom de devise short |
|
Préfixe monétaire D
|
data._currency.currency_prefix_d | string |
Préfixe monétaire D |
|
Préfixe monétaire C
|
data._currency.currency_prefix_c | string |
Préfixe monétaire C |
|
Nom de la devise Long
|
data._currency.currency_name_long | string |
Nom de la devise Long |
Envoyer une télécopie
Envoyer une télécopie
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
À
|
to | True | string |
Numéro de téléphone au format E.164. Eg. +61261111111. |
|
Chaîne personnalisée
|
custom_string | string |
Il s’agit de votre référence. Elle s’affiche sur tous les rapports et sera renvoyée avec toutes les réponses. |
|
|
URL du fichier PDF
|
file_url | True | string |
La taille maximale du fichier est de 4 Mo. Toutes les pages doivent être en portrait. Discuter avec ClickSend Support pour obtenir des spécifications complètes |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Code de réponse
|
response_code | string |
Code de réponse |
|
Message de réponse
|
response_msg | string |
Message de réponse |
|
Prix total
|
data.total_price | float |
Prix total |
|
Nombre total
|
data.total_count | integer |
Nombre total |
|
Nombre mis en file d’attente
|
data.queued_count | integer |
Nombre mis en file d’attente |
|
messages
|
data.messages | array of object |
messages |
|
ID d’utilisateur
|
data.messages.user_id | integer |
ID d’utilisateur |
|
ID de sous-compte
|
data.messages.subaccount_id | integer |
ID de sous-compte |
|
ID de liste
|
data.messages.list_id | string |
ID de liste |
|
ID de message
|
data.messages.message_id | string |
ID de message |
|
À
|
data.messages.to | string |
À |
|
De
|
data.messages.from | string |
De |
|
Transporteur
|
data.messages.carrier | string |
Transporteur |
|
Pays
|
data.messages.country | string |
Pays |
|
Chaîne personnalisée
|
data.messages.custom_string | string |
Chaîne personnalisée |
|
Pages de messages
|
data.messages.message_pages | integer |
Pages de messages |
|
Prix du message
|
data.messages.message_price | string |
Prix du message |
|
Code de statut
|
data.messages.status_code | string |
Code de statut |
|
Texte d’état
|
data.messages.status_text | string |
Texte d’état |
|
Date ajoutée
|
data.messages.date_added | integer |
Date ajoutée |
|
À partir de l’e-mail
|
data.messages.from_email | string |
À partir de l’e-mail |
|
URL du fichier
|
data.messages._file_url | string |
URL du fichier |
|
Statut
|
data.messages.status | string |
Statut |
|
Nom de devise short
|
data._currency.currency_name_short | string |
Nom de devise short |
|
Préfixe monétaire D
|
data._currency.currency_prefix_d | string |
Préfixe monétaire D |
|
Préfixe monétaire C
|
data._currency.currency_prefix_c | string |
Préfixe monétaire C |
|
Nom de la devise Long
|
data._currency.currency_name_long | string |
Nom de la devise Long |
Lettre d’envoi
Lettre d’envoi
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
URL du fichier PDF
|
file_url | True | string |
La taille maximale du fichier est de 10 Mo. Toutes les pages doivent être en portrait. Discutez avec ClickSend Support pour obtenir des spécifications complètes. |
|
Modèle utilisé
|
template_used | integer |
Indique si vous utilisez le modèle de lettre. La valeur de l’indicateur doit être 1 pour oui ou 0 pour non. |
|
|
Couleur
|
colour | True | integer |
Choisissez d’utiliser la couleur ou l’impression B&W. (Noir & Blanc = 0, Couleur = 1) |
|
Duplex
|
duplex | True | integer |
Choisissez d’utiliser Duplex = 1 (double-sided) ou Simplex = 0(single sided) impression. |
|
Poste de priorité
|
priority_post | integer |
Indique si la lettre est prioritaire, la valeur de l’indicateur doit être 1 pour oui ou 0 pour non. |
|
|
Nom
|
address_name | True | string |
Nom de l’adresse |
|
Ville
|
address_city | True | string |
Ville |
|
État
|
address_state | True | string |
État |
|
Code postal
|
address_postal_code | True | string |
Code postal |
|
Pays
|
address_country | True | string |
Pays |
|
Sélectionner l’adresse de retour
|
return_address_id | True | integer |
ID d’adresse de retour à utiliser |
|
Ligne d’adresse 1
|
address_line_1 | True | string |
Première ligne d’adresse |
|
Ligne d’adresse 2
|
address_line_2 | string |
Deuxième ligne d’adresse |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Code de réponse
|
response_code | string |
Code de réponse |
|
Message de réponse
|
response_msg | string |
Message de réponse |
|
Prix total
|
data.total_price | float |
Prix total |
|
Nombre total
|
data.total_count | integer |
Nombre total |
|
Nombre mis en file d’attente
|
data.queued_count | integer |
Nombre mis en file d’attente |
|
destinataires
|
data.recipients | array of object |
item |
|
ID d’utilisateur
|
data.recipients.user_id | integer |
ID d’utilisateur |
|
ID de sous-compte
|
data.recipients.subaccount_id | integer |
ID de sous-compte |
|
ID de message
|
data.recipients.message_id | string |
ID de message |
|
Nom de l’adresse
|
data.recipients.address_name | string |
Nom de l’adresse |
|
Ligne d’adresse 1
|
data.recipients.address_line_1 | string |
Ligne d’adresse 1 |
|
Ligne d’adresse 2
|
data.recipients.address_line_2 | string |
Ligne d’adresse 2 |
|
Ville d’adresse
|
data.recipients.address_city | string |
Ville d’adresse |
|
État de l’adresse
|
data.recipients.address_state | string |
État de l’adresse |
|
Code postal d’adresse
|
data.recipients.address_postal_code | string |
Code postal d’adresse |
|
Pays d’adresse
|
data.recipients.address_country | string |
Pays d’adresse |
|
ID d’adresse de retour
|
data.recipients.return_address_id | integer |
ID d’adresse de retour |
|
Chaîne personnalisée
|
data.recipients.custom_string | string |
Chaîne personnalisée |
|
Origine
|
data.recipients.source | string |
Origine |
|
Couleur
|
data.recipients.colour | integer |
Couleur |
|
Duplex
|
data.recipients.duplex | integer |
Duplex |
|
Pages de publication
|
data.recipients.post_pages | integer |
Pages de publication |
|
Publier le prix
|
data.recipients.post_price | string |
Publier le prix |
|
Poste de priorité
|
data.recipients.priority_post | integer |
Poste de priorité |
|
Date ajoutée
|
data.recipients.date_added | integer |
Date ajoutée |
|
Statut
|
data.recipients.status | string |
Statut |
|
URL du fichier
|
data.recipients._file_url | string |
URL du fichier |
|
ID d’adresse de retour
|
data.recipients._return_address.return_address_id | integer |
ID d’adresse de retour |
|
ID d’utilisateur
|
data.recipients._return_address.user_id | integer |
ID d’utilisateur |
|
Nom de l’adresse
|
data.recipients._return_address.address_name | string |
Nom de l’adresse |
|
Ligne d’adresse 1
|
data.recipients._return_address.address_line_1 | string |
Ligne d’adresse 1 |
|
Ligne d’adresse 2
|
data.recipients._return_address.address_line_2 | string |
Ligne d’adresse 2 |
|
Ville d’adresse
|
data.recipients._return_address.address_city | string |
Ville d’adresse |
|
État de l’adresse
|
data.recipients._return_address.address_state | string |
État de l’adresse |
|
Code postal d’adresse
|
data.recipients._return_address.address_postal_code | string |
Code postal d’adresse |
|
Pays d’adresse
|
data.recipients._return_address.address_country | string |
Pays d’adresse |
|
Nom d’utilisateur de l’API
|
data.recipients._api_username | string |
Nom d’utilisateur de l’API |
|
Nom de devise short
|
data._currency.currency_name_short | string |
Nom de devise short |
|
Préfixe monétaire D
|
data._currency.currency_prefix_d | string |
Préfixe monétaire D |
|
Préfixe monétaire C
|
data._currency.currency_prefix_c | string |
Préfixe monétaire C |
|
Nom de la devise Long
|
data._currency.currency_name_long | string |
Nom de la devise Long |
Obtenir des contacts dans une liste
Obtenir tous les contacts dans une liste
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de liste
|
list_id | True | integer |
Vous pouvez utiliser l’action Rechercher dans la liste de contacts OU obtenir l’action Liste de contacts pour obtenir l’ID de liste |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Code de réponse
|
response_code | string |
Code de réponse |
|
Message de réponse
|
response_msg | string |
Message de réponse |
|
Total
|
data.total | integer |
Total |
|
Par page
|
data.per_page | integer |
Par page |
|
Page active
|
data.current_page | integer |
Page active |
|
Dernière page
|
data.last_page | integer |
Dernière page |
|
URL de la page suivante
|
data.next_page_url | string |
URL de la page suivante |
|
URL de la page de préversion
|
data.prev_page_url | string |
URL de la page de préversion |
|
De
|
data.from | integer |
De |
|
À
|
data.to | integer |
À |
|
données
|
data.data | array of object |
données |
|
Identifiant de contact
|
data.data.contact_id | integer |
Identifiant de contact |
|
ID de liste
|
data.data.list_id | integer |
ID de liste |
|
Numéro de téléphone
|
data.data.phone_number | string |
Numéro de téléphone |
|
Prénom
|
data.data.first_name | string |
Prénom |
|
Nom de famille
|
data.data.last_name | string |
Nom de famille |
|
Personnalisé 1
|
data.data.custom_1 | string |
Personnalisé 1 |
|
Personnalisé 2
|
data.data.custom_2 | string |
Personnalisé 2 |
|
Personnalisé 3
|
data.data.custom_3 | string |
Personnalisé 3 |
|
Personnalisé 4
|
data.data.custom_4 | string |
Personnalisé 4 |
|
date_added
|
data.data.date_added | integer |
Date ajoutée |
|
Date de mise à jour
|
data.data.date_updated | integer |
Date de mise à jour |
|
Numéro de télécopie
|
data.data.fax_number | string |
Numéro de télécopie |
|
Nom de l’organisation
|
data.data.organization_name | string |
Nom de l’organisation |
|
Messagerie électronique
|
data.data.email | string |
Messagerie électronique |
|
Ligne d’adresse 1
|
data.data.address_line_1 | string |
Ligne d’adresse 1 |
|
Ligne d’adresse 2
|
data.data.address_line_2 | string |
Ligne d’adresse 2 |
|
Ville d’adresse
|
data.data.address_city | string |
Ville d’adresse |
|
État de l’adresse
|
data.data.address_state | string |
État de l’adresse |
|
Code postal d’adresse
|
data.data.address_postal_code | string |
Code postal d’adresse |
|
Pays d’adresse
|
data.data.address_country | string |
Pays d’adresse |
|
Nom de la liste
|
data.data._list_name | string |
Nom de la liste |
Obtenir des listes de contacts
Obtenir toutes les listes de contacts, sauf si elles sont spécifiées dans les options préalables
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nombre de pages
|
page | integer |
Nombre de pages |
|
|
Nombre d’enregistrements par page
|
limit | integer |
Nombre d’enregistrements par page |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Code de réponse
|
response_code | string |
Code de réponse |
|
Message de réponse
|
response_msg | string |
Message de réponse |
|
Total
|
data.total | integer |
Total |
|
Par page
|
data.per_page | integer |
Par page |
|
Page active
|
data.current_page | integer |
Page active |
|
Dernière page
|
data.last_page | integer |
Dernière page |
|
URL de la page suivante
|
data.next_page_url | string |
URL de la page suivante |
|
URL de la page de préversion
|
data.prev_page_url | string |
URL de la page de préversion |
|
De
|
data.from | integer |
De |
|
À
|
data.to | integer |
à |
|
données
|
data.data | array of object |
données |
|
ID de liste
|
data.data.list_id | integer |
ID de liste |
|
Nom de la liste
|
data.data.list_name | string |
Nom de la liste |
|
ID d’e-mail de liste
|
data.data.list_email_id | string |
ID d’e-mail de liste |
|
Nombre de contacts
|
data.data._contacts_count | integer |
Nombre de contacts |
|
Importer des entrées
|
data.data._import_in_progress | integer |
Importer des entrées |
|
Entrée d’optout
|
data.data._optout_in_progress | integer |
Entrée d’optout |
Rechercher des listes de contacts
Obtenir la liste des contacts recherchés
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom de la liste
|
q | True | string |
Rechercher |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Code de réponse
|
response_code | string |
Code de réponse |
|
Message de réponse
|
response_msg | string |
Message de réponse |
|
Total
|
data.total | integer |
Total |
|
Par page
|
data.per_page | integer |
Par page |
|
Page active
|
data.current_page | integer |
Page active |
|
Dernière page
|
data.last_page | integer |
Dernière page |
|
URL de la page suivante
|
data.next_page_url | string |
URL de la page suivante |
|
URL de la page de préversion
|
data.prev_page_url | string |
URL de la page de préversion |
|
De
|
data.from | integer |
De |
|
À
|
data.to | integer |
À |
|
données
|
data.data | array of object |
données |
|
Id
|
data.data.id | integer |
Id |
|
Nom
|
data.data.name | string |
Nom |
|
Contact
|
data.data.contact | string |
Contact |
|
Type
|
data.data.type | string |
Type |
|
Nombre de contacts
|
data.data.contacts_count | integer |
Nombre de contacts |
Supprimer la liste
Supprimer une liste de contacts spécifique
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de liste
|
list_id | True | integer |
Vous pouvez utiliser l’action Rechercher dans la liste de contacts OU obtenir l’action Liste de contacts pour obtenir l’ID de liste |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Code de réponse
|
response_code | string |
Code de réponse |
|
Message de réponse
|
response_msg | string |
Message de réponse |
Supprimer un contact
Supprimer un contact
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de liste
|
list_id | True | integer |
Vous pouvez utiliser l’action Rechercher dans la liste de contacts OU obtenir l’action Liste de contacts pour obtenir l’ID de liste |
|
Identifiant de contact
|
contact_id | True | integer |
Identifiant de contact |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Code de réponse
|
response_code | string |
Code de réponse |
|
Message de réponse
|
response_msg | string |
Message de réponse |
Déclencheurs
| Automatisation entrante sms |
Créer une automatisation SMS entrante |
Automatisation entrante sms
Créer une automatisation SMS entrante
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Corps
|
body | string |
body |
|
À
|
to | string |
Numéro de téléphone du destinataire |
|
De
|
from | string |
ID de l’expéditeur |
|
Chaîne personnalisée
|
custom_string | string |
custom_string |
|
ID de message d’origine
|
original_message_id | string |
original_message_id |
|
Corps d’origine
|
original_body | string |
Corps d’origine |
|
Identifiant
|
user_id | integer |
ID utilisateur de l’utilisateur qui a envoyé le message. |
|
ID de sous-compte
|
subaccount_id | integer |
ID de sous-compte de l’utilisateur qui a envoyé le message. |
|
Timestamp
|
timestamp | integer |
Horodatage au format UNIX |
|
Message Id
|
message_id | string |
ID du message entrant |