Box Developerドキュメント
ログイン

デフォルトのBox Sign通知の抑制

ガイド Box Sign デフォルトのBox Sign通知の抑制

デフォルトのBox Sign通知の抑制

Box Sign APIを使用すると、Signのワークフローの中で送信されるデフォルトのBoxメール通知を抑制できます。この機能により、以下のようにBox Sign通知の管理を容易にします。

  • 全面的にカスタマイズしたメール通知テンプレートを使用して、自社のドメインからメールを送信できます。
  • メールとは別に、プッシュ通知またはテキストメッセージを送信できます。​

Boxメール通知を抑制することを選択すると、組織は、該当する場合に、使用される配信方法に対して署名者の同意を得ることを含め、適用されるすべての法律と規制に従い、署名プロセスにおいて適切なタイミングで適切な内容を含むすべての通知を署名者に確実に配信する責任を負うことになります。

Box Sign APIを使用したデフォルトの通知の抑制

Box Signのメール通知を抑制するには、以下のパラメータを設定する必要があります。

  1. signersオブジェクトのsuppress_notificationsパラメータをtrueに設定して、通知をオフにします。
  2. embed_url_external_user_idパラメータを設定して、通知を送信しないユーザーを指定します。

この構成により、指定したユーザーに対するBox Signの自動メール通知は無効になります。その結果、独自の通知を構成して送信できます。

curl -i -X POST "https://api.box.com/2.0/sign_requests" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
       "signers": [
          {    
            "role": "signer",
            "email": "example_email@box.com"
            "suppress_notifications": true
            "embed_url_external_user_id": "1234"
          }
        ],
       "source_files": [
          {
            "type": "file",
            "id": "123456789"
          }
       ],
       "parent_folder": 
          {
            "type": "folder",
            "id": "0987654321"
          }
     }'

署名ログのエントリ

Box Signのデフォルトの通知が抑制されると、署名ログには、送信者によってすべてのBox Sign通知が抑制されたことが記録されます。また、このログには、API統合を介してBox Signに提供される、通知配信の目的で使用されるシステムに関する情報や組織のシステムにおける署名者のユーザーIDも記録されます。