Actions トリガー: custom-phone-provider - API オブジェクト

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

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

​

api.cache

キャッシュを操作します。

​

api.cache.delete(key)

指定した 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 · optional

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

非表示 options のプロパティ

expires_at · number · optional

Unix エポックからの経過時間をミリ秒で表した絶対有効期限。 キャッシュされたレコードはこれより前に削除される場合がありますが、 指定された expires_at を超えて保持されることはありません。

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

ttl · number · optional

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

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

​

api.notification

通知イベントを再試行対象とするか、破棄するかを指定します。 実際の動作の詳細については、各メソッドを参照してください。 複数回呼び出された場合は、最後の呼び出しのみが考慮されます。

​

api.notification.drop(reason)

呼び出されると、この通知イベントは復旧せずに失敗したものとして扱われます。 このイベントについてはエラーがログに記録されますが、今後この Action に再送されることはありません。 この通知イベントを再試行する必要がある場合は、代わりに retry を呼び出すことを検討してください。

reason · string

この理由はログエントリの一部となり、エラーの詳細な分析に役立ちます。このフィールドは 1024 文字に制限されており、それを超える場合は切り捨てられます。

​

api.notification.retry(reason)

呼び出されると、この通知イベントは失敗したものと見なされますが、回復可能です。 このイベントについてはエラーがログに記録され、今後数分の間に最大 5 回再試行されます。 この通知イベントを再試行すべきでない場合は、代わりに drop を呼び出してください。

reason · string

この理由はログエントリの一部となり、エラーの詳細な分析に役立ちます。なお、このフィールドは 1024 文字までに制限されており、それを超える場合は切り詰められます。