Déclencheurs Actions : send-phone-message - objet API

Découvrez l’objet API du déclencheur d’action send-phone-message.

L’objet API du déclencheur d’action send-phone-message comprend :

​

api.cache

Stocker et récupérer des données qui persistent d’une exécution à l’autre.

​

api.cache.delete(key)

Supprime l’enregistrement décrivant une valeur mise en cache associé à la clé fournie, s’il existe.

key · string

La clé de l’enregistrement du cache à supprimer.

​

api.cache.get(key)

Récupère un enregistrement décrivant une valeur mise en cache associée à la clé fournie, s’il existe. Si un enregistrement est trouvé, la valeur mise en cache se trouve dans la propriété value de l’objet retourné.

key · string

La clé de l’enregistrement stocké dans le cache.

​

api.cache.set(key, value, options)

Stocke ou met à jour une valeur de type chaîne dans le cache à la clé spécifiée.

Les valeurs stockées dans ce cache sont limitées au déclencheur d’action dans lequel elles sont définies. Elles sont assujetties aux Actions Cache Limits.

Les valeurs stockées de cette façon auront une durée de vie pouvant aller jusqu’à la valeur ttl ou expires_at spécifiée. Si aucune durée de vie n’est précisée, une durée de vie par défaut de 15 minutes sera utilisée. Les durées de vie ne peuvent pas dépasser la durée maximale indiquée dans Actions Cache Limits.

Important : Ce cache est conçu pour des données éphémères de courte durée. Il se peut que des éléments ne soient pas disponibles lors de transactions ultérieures, même s’ils sont encore dans leur période de validité.

key · string

La clé de l’enregistrement à stocker.

value · string

La valeur de l’enregistrement à stocker.

options · cachesetoptions · optional

Options permettant d’ajuster le comportement du cache.

Masquer propriétés de options

expires_at · number · optional

L’heure d’expiration absolue, en millisecondes depuis l’époque Unix. Bien que les enregistrements mis en cache puissent être évincés plus tôt, ils ne seront jamais conservés au-delà de la valeur expires_at fournie.

Remarque : Cette valeur ne doit pas être fournie si une valeur a aussi été fournie pour ttl. Si les deux options sont fournies, la date d’expiration la plus rapprochée des deux sera utilisée.

ttl · number · optional

La durée de vie de cette entrée de cache, en millisecondes. Bien que les valeurs mises en cache puissent être évincées plus tôt, elles ne seront jamais conservées au-delà de la valeur ttl fournie.

Remarque : Cette valeur ne doit pas être fournie si une valeur a aussi été fournie pour expires_at. Si les deux options sont fournies, la date d’expiration la plus rapprochée des deux sera utilisée.