Zoho Survey APIでSMS招待をトリガーする方法
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。
トリガー SMS 招待とは？
トリガーとは、あらかじめ定義されたイベントが発生したときに、特定の処理や操作を実行させる仕組みです。Zoho Survey の SMS トリガーを使用すると、アンケートフォームをトリガー招待として SMS で送信できます。
ユーザーは、Zoho Survey の REST API を使用して、任意のアプリケーション上で SMS 配信（トリガーに基づく連絡先配信）を作成し、SMS 招待を送信できます。
利用シーン
ホテルの顧客フィードバック
たとえば、レストラン経営者として顧客のフィードバックを収集したいとします。顧客が請求書の支払いを完了したら、その顧客の電話番号宛に SMS でアンケートを送信し、フィードバックを回収できます。
EC サイトでのアンケート
顧客に商品が配送された後に SMS を送信し、購入内容を確認するとともに、EC システムから顧客のフィードバックを収集できます。
用語集 :
- OAuth - ユーザーのパスワードを開示することなく、保護されたリソースへの安全なアクセスを提供する業界標準のプロトコルです。
- クライアント - エンドユーザーに代わって、実行済み招待にアクセスするために Zoho Survey にリクエストを送信するアプリケーションです。
- クライアント ID - アプリケーションを Zoho に登録した際に発行される一意の識別子です。
- クライアントシークレット - アプリケーションを Zoho に登録した際に作成される一意のキーです。機密情報として取り扱う必要があります。
- グラントトークン - アクセストークンとリフレッシュトークンを生成するために使用される一時的なトークンです。組織ごとのグラントトークンの生成は 1 回のみ行えばよい操作です。
- アクセストークン - ユーザーの実行済み招待にアクセスするために Zoho Survey API に送信されるトークンです。アクセストークンは Zoho Survey API への安全かつ一時的なアクセスを提供します。各アクセストークンの有効期間は 1 時間で、スコープで定義された一連の操作にのみ使用できます。
- リフレッシュトークン - 新しいアクセストークンを取得するために使用できるトークンです。エンドユーザーによって取り消されない限り、有効期限はありません。
- API レート制限 - API レート制限とは、任意の時点で同時に有効にできる API コールの最大数を指します。
前提条件:
- 有効な Zoho Survey ユーザーの認証情報。
- Zoho Survey API にアクセスするための有効な認証トークンまたは OAuth。
- Zoho Survey ポータルで SMS 配信が設定済みであること。
アプリケーションを登録する方法:
API トリガー招待を有効にするには、まず Zoho Developer Console でクライアントを登録します。
- Zoho の Developer Console でアプリケーションを登録し、クライアント ID とクライアントシークレットを生成します。
- クライアント ID とクライアントシークレットが作成されたら、スコープ「ZohoSurvey.invitation.CREATE」を使用し、クライアント種別に応じて組織ごとのグラントトークンを生成します。グラントトークンは、セルフクライアントやサーバーベースのアプリケーションなど、特定のクライアントでのみ必要です。
- 作成されたグラントトークンをコピーします。さまざまなアプリ種別におけるクライアント ID とクライアントシークレットの生成方法については、関連ドキュメントを参照してください。
アクセストークンとリフレッシュトークンを生成する
次に、グラントトークンを使用して、ドメインごとの Zoho アカウント URL でアクセストークンとリフレッシュトークンを生成します。
以下は、各ドメインと対応するアカウント URL です。
- US: https://accounts.zoho.com
- AU: https://accounts.zoho.com.au
- EU: https://accounts.zoho.eu
- IN: https://accounts.zoho.in
- CN: https://accounts.zoho.com.cn
- JP: https://accounts.zoho.jp
- CA（カナダ）: https://accounts.zohocloud.ca
- SA（サウジアラビア）: https://accounts.zoho.sa
メモ:
- サーバーベースのアプリケーションの場合は、authorization リクエストを送信する際に、access_type パラメーターの値を offline に設定してください。値が offline の場合、最初のリクエスト時にアクセストークンとあわせてリフレッシュトークンが発行されます。アクセストークンの有効期限が切れたら、リフレッシュトークンを使用して再生成できます。
- 各アクセストークンの有効期間は 1 時間で、スコープで定義された操作にのみ使用できます。
- 新しいアクセストークンを生成するには、リフレッシュトークンを使用します。リフレッシュトークン自体には有効期限はありません。有効期限切れのアクセストークンを再生成する際に、リフレッシュトークンを使用してください。
トリガー SMS 招待を設定する方法
Zoho SMS サービスまたはサードパーティ製 SMS アプリを使用してトリガー SMS 招待を設定するには、以下の手順に従ってください。
Zoho SMS サービスを使用して SMS 配信を作成する
- Zoho Survey ポータルで［配信］タブに移動し、［SMS を作成］をクリックします。
- 接続として Zoho SMS サービスを選択します。［DLT ファイルをインポート］ボタンをクリックし、SMS として送信するカスタムメッセージを含む DLT ファイルをアップロードします。
- アップロードしたテンプレートを選択し、［使用する］をクリックします。
- テンプレート内のキーを置き換えるために使用する変数を選択します。
- 必須変数である {Surveylink} 変数が追加されていることを確認します。
- 変数を追加したら、［保存］をクリックします。
- テンプレートメッセージを確認し、［次へ］をクリックします。
- 続いて、連絡先を追加します。
メモ:
アップロードしたテンプレートには承認期間があり、その期間を過ぎて承認されて初めて SMS 招待として送信できます。承認期間中に却下される場合もあります。
SMS サービスでは、テンプレートを編集することはできません。既存のテンプレートからコピーするか、別のテンプレートに差し替えることのみ可能です。既存テンプレートをコピーするには、［既存テンプレートをコピー］をクリックします。
サードパーティアプリを使用して SMS 配信を作成する
- Zoho Survey ポータルで［配信］タブに移動し、［SMS を作成］をクリックします。
- 接続タイプを選択します。ドロップダウンボタンをクリックして、さまざまな外部連携を選択できます。
- リッチテキストエディターを使用してカスタムメッセージを追加し、［次へ］をクリックして連絡先の追加に進みます。
SMS 招待を送信する連絡先を選択する方法
- ［送信先］セクションで、トリガーに基づいて連絡先を選択し、［次へ］をクリックします。
- トリガーの頻度として、「1 回のみ招待」または「繰り返し招待」を選択します。
-
1 回のみ招待の場合: 以下の設定から選択して、送信タイミングを指定します。
- 今すぐ - トリガーを設定すると、SMS 招待がすぐに送信されます。
- 遅延後 - トリガー開始から一定時間経過後に SMS 招待が送信されるように設定できます。
- 指定した日付と時刻 - 招待を特定の日付と時刻に送信するようにスケジュールできます。
- 指定した時間帯 - 特定の時間間隔でバッチとしてトリガーを実行するように設定できます。
-
繰り返し招待の場合: 繰り返し招待を選択した場合は、トリガーの実行頻度をスケジュールします。
- ［作成］をクリックすると、完了画面に API 情報が表示されます。この情報は、いつでも［配信 > SMS > 実行済み招待］から API 詳細として確認できます。
リクエスト URL をコピーし、以下のように変数を設定します。
メモ:
API 情報は、［Launch］>［SMS Distribution］>［実行済み Invitations］>［表示する］>［API］で確認できます。
API 情報は、［Launch］>［SMS Distribution］>［実行済み Invitations］>［表示する］>［API］で確認できます。
メソッド POST
ヘッダーAuthorization: Zoho-oauthtoken e4af2b6xxxxxxxxxxxxxbaaba
(キー) (値)
コンテンツの種類: application/json
メソッド POST
ヘッダー Authorization:Zoho-oauthtoken e4af2b6xxxxxxxxxxxxxbaaba
(キー) (値)
コンテンツの種類: application/json
リクエスト本文
リクエスト本文:
|
パラメーター
|
データの種類
|
説明
|
|
EmailAddress
|
string
|
連絡先の SMS アドレスを指定します。
|
|
phoneNumber*
|
string
|
連絡先の電話番号を指定します。
|
|
firstName
|
string
|
連絡先の名を指定します。
|
|
lastName
|
string
|
連絡先の姓を指定します。
|
|
variableOne
|
string
|
追加データを収集するための変数項目を追加できます。
|
|
variableTwo
|
string
|
追加データを収集するための変数項目を追加できます。
|
|
variableThree
|
string
|
追加データを収集するための変数項目を追加できます。
|
|
variableFour
|
string
|
追加データを収集するための変数項目を追加できます。
|
|
variableFive
|
string
|
追加データを収集するための変数項目を追加できます。
|
|
variableSix
|
string
|
追加データを収集するための変数項目を追加できます。
|
* 必須 項目
メモ: 1 回の POST リクエストで複数の連絡先を追加できます。
サンプルリクエスト
以下のサンプルリクエストを参照し、curl コマンドを使用して API を実行してください。
-H 'Authorization: Zoho-oauthtoken 1000。e4af2b6xxxxxxxxxxxxxbaaba。xa5xxxxxxxxxxxxxxxf'
-d '@連絡先。json'
-X POST
リクエスト内の「@連絡先。json」には、サンプルの入力データが含まれています。
サンプル入力
{
'contactsList': [
{
'emailAddress': 'bella@example.com',
'phoneNumber': '+1234567890',
'firstName': 'bella',
'lastName': 'steve',
'variableOne': 'variable1',
'variableTwo': 'variable2',
'variableThree': 'variable3',
'variableFour': 'variable4',
'variableFive': 'variable5',
'variableSix': 'variable6'
},
{
'emailAddress': 'john@example.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
|
クライアントに必要なスコープがありません。有効なスコープを指定して新しいクライアントを作成してください。
|
|
530
|
DISTRIBUTION_DISABLED
|
指定された配信済み招待は無効です。
|
|
530
|
INVITATION_LIMIT_REACHED
|
このトリガーの招待送信数の上限に達しています。
|
|
530
|
DAILY_EINVITE_LIMIT_REACHED
|
1 日あたりの招待送信数の上限に達しています。
|
|
530
|
EINVITE_BOUNCE_RATE_EXCEEDED
|
アカウントのバウンス率の上限を超えています。
|
|
530
|
EINVITE_COMPLAINT_RATE_EXCEEDED
|
アカウントの苦情率の上限を超えています。
|
注意事項
- リフレッシュトークンの取り消し：ドメイン固有の Zoho アカウント URL を使用し、リフレッシュトークンを取り消すリクエストを送信して、リフレッシュトークンを無効化する必要があります。詳細はこちら。
- トークンの有効期限：保存できるトークン数および、一定時間内に送信できるリクエスト数には制限があります。詳細はこちら。
- 1 つの配信に対する 1 分あたりのAPI リクエスト数の上限は 60 件です。
Zoho CRM 管理者向けトレーニング
「導入したばかりで基本操作や設定に不安がある」、「短期間で集中的に運用開始できる状態にしたい」、「運用を開始しているが再度学び直したい」 といった課題を抱えられているユーザーさまに向けた少人数制のオンライントレーニングです。
日々の営業活動を効率的に管理し、導入効果を高めるための方法を学びましょう。
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
Zoho Campaigns Resources
Zoho WorkDrive Resources
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
Related Articles
Zoho Surveyの概要
Zoho Surveyの概要 Zoho Surveyを使用することで、フィードバックから投票まで、さまざまな種類のアンケートや調査を一元管理できます。多様な質問形式やテンプレートを使用して、対象者に適切な質問を提示し、その回答データを意思決定に活用できます。 Zoho Surveyのメリット Zoho ...Zoho SurveyのHubSpot連携
Zoho SurveyとHubSpotの連携により、Zoho SurveyのアンケートのデータをHubSpot ...Zoho SurveyのPipedream連携機能
Pipedreamは、Webサービスやアプリケーションでの作業を自動化できるサービスです。これにより、Zoho Surveyをさまざまなアプリと連携して、高度な自動化を一元管理することができます。また、Zoho SurveyのPipedream連携機能を使用すると、さまざまなアプリと直接連携できるため、連携機能の開発にかかる工数を削減できます。 Pipedreamを使用することで、Zoho ...Zoho Surveyのアカウントとデータの削除
Zoho Surveyでは、データとプライバシーの保護の観点から、使用しなくなったアカウントやデータは、一定期間の経過後に削除されます。 具体的には、Zoho Surveyのアカウントを削除すると、データはその6か月後にデータベースから削除されます。データベースから削除されたデータは、3か月後にバックアップからも削除されます。 アカウントの削除に関する詳細については、こちらをご参照ください。 データのプライバシーとセキュリティに関する詳細については、こちらをご参照ください。Zoho Survey アクセシビリティ設定
お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 このドキュメントでは、詳細に用意されている各種アクセシビリティ設定と、それらをどのように利用して、すべての人にとって使いやすいフォーム入力体験を実現できるかを説明します。 ここでは、Zoho Survey ...