Zoho Survey APIを使用してSMS招待をトリガーする

Zoho Survey APIを使用してSMS招待をトリガーする

お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

トリガーSMS招待とは?

トリガーは、あらかじめ定義されたイベントが発生した際に特定の操作を実行する処理です。Zoho SurveyのSMSトリガーを利用すると、ユーザーはアンケートフォームをトリガー招待として送信できます。
ユーザーは、Zoho SurveyのREST APIを利用して、任意のアプリケーション上でSMS配信(トリガーに基づく連絡先)を作成し、SMS招待を送信できます。

使用ケース

ホテル顧客フィードバック

例えば、レストラン経営者が顧客フィードバックを収集したい場合、顧客が請求書を支払った後、SMSで顧客の電話番号にアンケートを送信し、確認を取得できます。

Eコマースアンケート

商品配達後に顧客へSMSを送信し、購入の認証およびフィードバックをeコマースシステムから収集できます。

用語集:

  1. OAuth - 業界標準のプロトコルであり、ユーザーのパスワードを開示することなく、保護されたリソースへの安全なアクセスを提供します。
  2. クライアント - Zoho Surveyへリクエストを送信し、エンドユーザーの代理として招待を実行するアプリケーションです。
  3. クライアントID - Zohoでアプリケーションを登録すると受領する一意の識別子です。
  4. Clientシークレット - Zohoにアプリケーションを登録した際に作成される一意のキーで、機密情報として保持する必要があります。
  5. Grant Token - アクセストークンおよび更新トークンの生成に使用する一時的なトークンです。組織ごとのGrant Tokenの生成は一度限りです。
  6. Access Token - Zoho Survey APIに送信され、ユーザーの実行済み招待へアクセスするためのトークンです。アクセストークンはZoho Survey APIへの安全で一時的なアクセスを提供します。各アクセストークンの有効期限は1時間のみで、スコープで定義された操作にのみ利用可能です。
  7. 更新トークン - 新しいアクセストークンを取得するために使用できるトークンです。このトークンは、エンドユーザーが取り消すまで無期限で有効です。
  8. API単価制限 - API単価制限は、任意の時点で同時に有効にできるAPI通話の最大数を指します。

事前準備:

  1. 有効なZoho Surveyユーザー認証情報。
  2. Zoho Survey APIへのアクセスに有効な認証トークンまたはOAuth。
  3. Zoho SurveyポータルでSMS配信が設定されていること。

アプリケーションの登録方法:

APIトリガー招待を有効にするには、まずZoho Developer Consoleでクライアントを登録します。
  1. ZohoのDeveloper Consoleでアプリケーションを登録し、クライアントIDとClientシークレットを生成します。
  2. クライアントIDとClientシークレットが作成されると、スコープ「ZohoSurvey.invitation.create」を使用し、クライアント種類に基づいて組織専用のGrant Tokenを生成します。Grant Tokenは、セルフクライアントやサーバーベースのアプリケーションなど、特定のクライアントにのみ必要です。
  3. 生成されたGrant Tokenをコピーします。各種アプリタイプでのクライアントIDおよびClientシークレットの生成については、その他の情報をご参照ください。

Access Tokenと更新トークンの生成    

次に、Grant Tokenを使用して、ドメイン専用のZoho取引先URLでアクセストークンと更新トークンを生成します。
以下は、各ドメインと対応する取引先URLです。
  1. 米国の場合:https://取引先。Zoho。com
  2. オーストラリアの場合:https://取引先。Zoho。com。au
  3. EUの場合:https://取引先。Zoho。eu
  4. インドの場合:https://取引先。Zoho。in
  5. 中国の場合:https://取引先。Zoho。com。cn
  6. 日本の場合:https://取引先。Zoho。jp
  7. カナダの場合:https://取引先。zohocloud。ca
  8. サウジアラビアの場合:https://取引先。Zoho。sa
Notes
メモ:
  1. サーバーベースのアプリケーションの場合、アクセス権限の種類パラメータ値を'オフライン'として認証リクエストを送信してください。値がオフラインの場合、初回リクエスト時にアクセス トークンと共に更新用トークンも受け取ります。アクセス トークンが有効期限切れになった際は、更新用トークンを使って再発行できます。
  2. 各アクセス トークンの有効期限は1時間のみで、スコープ内で定義された操作のみに使用できます。
  3. 新しいアクセス トークンを生成するには、更新用トークンを使用してください。更新用トークンに有効期限はありません。アクセス トークンの有効期限が切れた際は、更新用トークンで再発行してください。

Trigger SMS招待の設定方法

Zoho SMSサービスまたはサードパーティのSMSアプリを使用して、Trigger SMS招待を設定する手順は以下の通りです。

Zoho SMSサービスを利用したSMS配信の作成

  1. Zoho Surveyポータルで、Launchタブに移動し、作成 SMSをクリックします。

  2. 次に、接続先としてZoho SMSサービスを選択します。「DLTファイルをインポート」ボタンをクリックし、SMSとして送信するカスタムメッセージが含まれたDLTファイルをアップロードしてください。

  3. アップロードしたテンプレートを選択し、「使用する」をクリックします。

  4. テンプレート内のキーを置き換える変数を選択してください。

  5. {Surveylink}変数が追加されていることを必ずご確認ください。これは必須の変数です。

  6. 変数を追加したら、保存をクリックします。

  7. テンプレートメッセージを認証し、をクリックします。

  8. 続いて、連絡先の追加に進みます。
Notes
メモ:
アップロードしたテンプレートには承認期間があります。承認後にのみ、SMS招待として送信可能です。承認期間中に却下される場合もあります。
SMSサービスでは、テンプレートの編集はできません。「既存テンプレートをコピー」をクリックすることで、既存テンプレートと差し替え、またはコピーのみ可能です。

サードパーティアプリを使用したSMS配信の作成

  1. Zoho Survey ポータルで、Launch タブに移動し、SMS の作成をクリックします。

  2. Connection 種類を選択します。ドロップダウンボタンをクリックして、さまざまな外部連携を選択できます。
  3. リッチテキストエディタを使ってカスタムメッセージを追加し、次へをクリックして連絡先の追加に進みます。

SMS 招待を送信する連絡先の選択方法

  1. 送信するToセクションで、トリガーに基づき連絡先を選択し、[次へ]をクリックします。

  2. トリガーの頻度を「一度きりの招待」または「繰り返し招待」から選択します。

    1. 一度きりの招待の場合:以下の設定から頻度を選択できます。
      1. 今すぐ - トリガーの設定後、SMS招待がすぐに送信されます。

      2. 遅延後 - トリガー発動から一定時間経過後にSMS招待が送信されるよう設定できます。

      3. 指定した日付と時間 - 招待を特定の日付と時間に送信するようにスケジュールできます。

      4. 指定した時間枠でスケジュール - トリガーをバッチ処理として、特定の時間間隔で送信するように設定できます。

    2. 繰り返し招待の場合:繰り返し招待を選択した場合は、トリガーの頻度をスケジュールしてください。



  3. [作成]をクリックすると、API情報が完了画面に表示されます。APIの詳細は、いつでもLaunch > SMS > 実行済み Invitationsから確認できます。

リクエストURLをコピーし、下記のように変数を設定してください。
Notes
メモ:
API情報は、Launch > SMS Distribution > 実行済みInvitations > 表示する > API で確認できます。
 
メソッドPOST
ヘッダーAuthorization:Zoho-oauthtoken e4af2b6xxxxxxxxxxxxxbaaba
(キー) (値)
Content-Type:application/json 
 
メソッド POST
ヘッダー Authorization:Zoho-oauthtoken e4af2b6xxxxxxxxxxxxxbaaba
(キー) (値)
Content-Type: application/json
リクエスト本文

リクエスト本文:

パラメーター
データの種類
説明
EmailAddress
string
連絡先のSMS住所を指定します。
phoneNumber*
string
連絡先の電話番号を指定します。
firstName
string
連絡先の名を指定します。
lastName
string
連絡先の姓を指定します。
variableOne
文字列
追加でデータを収集するために this variable 項目を追加可能
variableTwo
文字列
追加でデータを収集するために this variable 項目を追加可能
variableThree
文字列
追加でデータを収集するために this variable 項目を追加可能
variableFour
文字列
追加でデータを収集するために this variable 項目を追加可能
variableFive
文字列
追加でデータを収集するために this variable 項目を追加可能
variableSix
文字列
追加でデータを収集するために this variable 項目を追加可能
* 必須項目
 
Notesメモ: 1回のPOSTリクエストで複数の連絡先を追加できます。

サンプルリクエスト

以下のサンプルリクエストを参照し、API実行のためのcurlコマンドを使用してください:
-H 'Authorization: Zoho-oauthtoken 1000。e4af2b6xxxxxxxxxxxxxbaaba。xa5xxxxxxxxxxxxxxxf'
-d '@連絡先。json'
-X POST
リクエスト内の '@連絡先。json' にはサンプル入力データが含まれています。
サンプル入力
{
'contactsList': [
{
'emailAddress': 'bella@例。com',
'phoneNumber': '+1234567890',
'firstName': 'bella',
'lastName': 'steve',
'variableOne': 'variable1',
'variableTwo': 'variable2',
'variableThree': 'variable3',
'variableFour': 'variable4',
'variableFive': 'variable5',
'variableSix': 'variable6'
},
{
'emailAddress': 'john@例。com',
'phoneNumber': '+1234567890',
'firstName': 'John',
'lastName': 'steve'
}
]
}

HTTPS ステータスコード

HTTPステータス
メッセージ
説明
200 OK
 
このステータスを受信した場合、APIトリガーが正常に実行されたことを意味します。
530
ACCESS_RESTRICTED
配信がトリガー状態と一致していません。APIリクエストURLを認証するか、トリガーベースの配信を新規作成してください。
530
NEED_RECIPIENTS
連絡先が空であるか、無効なSMSアドレスが含まれています。
400
INVALID_REQUEST_METHOD
API URLへのアクセスに無効なHTTPメソッドが指定されています。有効なリクエストメソッドを指定してください。
401
OAUTH_SCOPE_MISMATCH
クライアントに必須のscopeがありません。有効なscopeを持つ新規クライアントを作成してください。
530
DISTRIBUTION_DISABLED
提供された実行済み招待は無効です。
530
INVITATION_LIMIT_REACHED
トリガー期限内での招待件数の上限に達しました。
530
DAILY_EINVITE_LIMIT_REACHED
1日の招待上限数に達しました。
530
EINVITE_BOUNCE_RATE_EXCEEDED
アカウントのバウンス単価上限に達しました。
530
EINVITE_COMPLAINT_RATE_EXCEEDED
アカウントのクレーム単価上限に達しました。

メモ事項

  1. 更新するトークンの取り消し: ドメイン専用のZoho取引先URLを使用し、更新するトークンを取り消すリクエストを送信してください。詳細はこちら
  2. トークンの有効期限: 保管できるトークン数や、一定時間内に送信可能なリクエスト数には制限があります。詳細はこちら
  3. API制限: 1分間あたりのディストリビューションごとのリクエスト合計数は60です。

    Zoho CRM 管理者向けトレーニング

    「導入したばかりで基本操作や設定に不安がある」、「短期間で集中的に運用開始できる状態にしたい」、「運用を開始しているが再度学び直したい」 といった課題を抱えられているユーザーさまに向けた少人数制のオンライントレーニングです。

    日々の営業活動を効率的に管理し、導入効果を高めるための方法を学びましょう。

    Zoho CRM Training



              Zoho Campaigns Resources

                Zoho WorkDrive Resources




                  • Desk Community Learning Series


                  • Digest


                  • Functions


                  • Meetups


                  • Kbase


                  • Resources


                  • Glossary


                  • Desk Marketplace


                  • MVP Corner


                  • Word of the Day


                  • Ask the Experts









                                  • Related Articles

                                  • Zoho Surveyのタグ付け

                                    Zoho Surveyのタグ付け機能では、タグをかんたんに作成できます。この機能により、アンケートや質問を手軽にグループ化できるだけでなく、アンケートや質問に複数のタグを付けてより詳細に分類し、効率的に管理することが可能です。 Zoho Surveyでは、タグを以下の項目に追加できます。 特定のアンケート 個々の回答 特定のアンケートへのタグ付け アンケートにタグを付けることができるのは、次の操作時です。 アンケート名を編集するとき アンケートを複製するとき ...
                                  • Zoho SurveyのPipedream連携機能

                                    Pipedreamは、Webサービスやアプリケーションでの作業を自動化できるサービスです。これにより、Zoho Surveyをさまざまなアプリと連携して、高度な自動化を一元管理することができます。また、Zoho SurveyのPipedream連携機能を使用すると、さまざまなアプリと直接連携できるため、連携機能の開発にかかる工数を削減できます。 Pipedreamを使用することで、Zoho ...
                                  • Zoho CampaignsとZoho Surveyの利点と欠点は何ですか?

                                    お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 両方のアプリケーションはCRMとの統合を提供しています。しかし、Zoho Campaignsは、連絡先をZoho CRMと同期させ、メーリングリスト全体にアンケートを同時に配布することができます。回答はCRMのZoho Surveyセクションで更新されます。Zoho ...
                                  • Zoho OneにZoho Surveyは含まれていますか?

                                    お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 確かに、Zoho SurveyはZoho Oneパッケージに含まれています。 Zoho Oneの料金表をご参照ください。
                                  • Zoho CRM と Zoho Forms、Zoho Survey は互換性がありますか?

                                    お知らせ:当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 Zoho SurveyとZoho FormsはどちらもZoho CRMと統合可能です。ただし、Zoho Surveyはより広範なアナリティクスを調査データに対して提供します。

                                  Resources

                                  Videos

                                  Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                  eBooks

                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                  Webinars

                                  Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                  CRM Tips

                                  Make the most of Zoho CRM with these useful tips.