API オブジェクト

send-phone-message Action トリガーの API オブジェクトについて説明します。

send-phone-message Actions トリガーの API オブジェクトには、以下が含まれます。

​

api.cache

実行をまたいで保持されるデータを保存・取得します。

​

api.cache.delete(key)

指定されたキーにキャッシュ値を表すレコードが存在する場合、そのレコードを削除します。

パラメータ

非表示 パラメータ

key · string

削除するキャッシュレコードのキー。

​

api.cache.get(key)

指定されたキーに対応するキャッシュ値のレコードが存在する場合は、それを取得します。レコードが見つかった場合、キャッシュ値は返されるオブジェクトの value プロパティに格納されています。

パラメータ

非表示 パラメータ

key · string

キャッシュに保存されているレコードのキー。

​

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

指定したキーに文字列値をキャッシュへ保存または更新します。

このキャッシュに保存される値は、設定されたトリガーのスコープ内でのみ使用されます。 これらの値には、Actions Cache Limits が適用されます。

この方法で保存された値の有効期間は、指定された ttl または expires_at の値を上限とします。有効期間が指定されていない場合は、デフォルトの 有効期間として15分が使用されます。有効期間は、Actions Cache Limits に記載されている最大 期間を超えることはできません。

重要: このキャッシュは、短期間の一時的なデータ用に設計されています。指定された有効期間内であっても、後続のトランザクションでは 項目を利用できない場合があります。

パラメータ

非表示 パラメータ

key · string

保存するレコードのキー。

value · string

保存するレコードの値。

options · cachesetoptions

キャッシュの動作を調整するためのオプション。 省略可能。

表示 options プロパティ

expires_at · number

unix epoch からのミリ秒単位の絶対的な有効期限。 キャッシュされたレコードはそれより前に削除される場合がありますが、 指定された expires_at を超えて保持されることはありません。

注: ttl の値も 指定されている場合は、この値を指定しないでください。両方のオプションが指定された場合は、 2つのうち早い方の有効期限が使用されます。 省略可能。

ttl · number

このキャッシュエントリのミリ秒単位の有効期間。 キャッシュ値はそれより前に削除される場合がありますが、 指定された ttl を超えて保持されることはありません。

注: expires_at の値も 指定されている場合は、この値を指定しないでください。両方のオプションが指定された場合は、 2つのうち早い方の有効期限が使用されます。 省略可能。