Déclencheurs d’Actions : custom-phone-provider - objet API

Découvrez l’objet API du déclencheur custom-phone-provider d’Actions.

L’objet API du déclencheur custom-phone-provider d’Actions comprend :

​

api.cache

Modifiez le cache.

​

api.cache.delete(key)

Supprime l’enregistrement associé à la valeur mise en cache pour 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 la valeur mise en cache à 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 renvoyé.

key · string

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

​

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

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

Les valeurs stockées dans ce cache sont propres au Trigger dans lequel elles sont définies. Elles sont assujetties aux limites du cache d’Actions.

Les valeurs stockées de cette façon auront une durée de vie pouvant aller jusqu’aux valeurs ttl ou expires_at spécifiées. 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 limites du cache d’Actions.

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 dans des transactions ultérieures, même s’ils sont encore dans leur durée de vie prévue.

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 des options

expires_at · number · optional

L’heure d’expiration absolue en millisecondes depuis l’époque Unix. Même si les enregistrements mis en cache peuvent ê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 plus rapprochée des deux échéances sera utilisée.

ttl · number · optional

La durée de vie de cette entrée de cache en millisecondes. Même si les valeurs mises en cache peuvent ê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 plus rapprochée des deux échéances sera utilisée.

​

api.notification

Indique si l’événement de notification doit être relancé ou abandonné. Consultez chacune de ces méthodes pour en savoir plus sur le comportement réel. Si plusieurs appels sont effectués, seul le dernier est pris en compte.

​

api.notification.drop(reason)

Lorsqu’elle est appelée, l’événement de notification est considéré comme ayant échoué, sans possibilité de récupération : Nous consignerons une erreur pour cet événement dans le journal, mais nous ne l’enverrons plus à l’Action par la suite. Si vous devez réessayer cet événement de notification, envisagez plutôt d’appeler retry.

reason · string

cette raison fera partie de l’entrée du journal, ce qui vous aidera à approfondir l’analyse de l’erreur. Veuillez noter que ce champ est limité à 1024 caractères et sera tronqué s’il dépasse cette longueur.

​

api.notification.retry(reason)

Lorsqu’elle est appelée, l’événement de notification est considéré comme ayant échoué, mais comme récupérable : Une erreur sera consignée pour cet événement, mais nous effectuerons jusqu’à 5 nouvelles tentatives au cours des prochaines minutes. Si vous jugez que cet événement de notification ne doit pas être retenté, appelez plutôt drop.

reason · string

ce motif sera inclus dans l’entrée du journal, ce qui vous aidera à analyser l’erreur plus en détail. Veuillez noter que ce champ est limité à 1024 caractères et sera tronqué s’il dépasse cette limite.