メニュー

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Widgetライブラリー

This page documents all of the widgets available in the Studio drag and drop environment. New to Studio and want to learn about it? Jump to the Usage guide homepage!

Widgetライブラリー

現在使用できるWidget:

Trigger

Send & Wait For Reply

Split Based On...

Send Message

Say/Play

Gather Input On Call

Run Function

Make Outgoing Call

Connect Call To

HTTP Request

Record Voicemail

Enqueue Call

Send to Flex

Capture Payments

Set Variables

💥 Trigger (Start)

Studio Trigger Widget

説明:

すべてのFlowはTrigger Widgetを持っています。 これはFlowの開始となるWidgetです。 他のWidgetは着信通話、REST API、そして受信メッセージという3つの取りうるトリガーイベントの内ひとつに接続されます。 このWidgetは削除できません。

必須の構成:

Flow Name is required, and defaults to the name entered when you create the Flow. You may modify this at any time.

FlowのWebhook URL (読み取り専用) です。 下記の形式で構成パネルに表示されます:

https://webhooks.twilio.com/v1/Accounts/<account_sid>/Flows/<flow_sid>

クリップボードにFlowのURLをコピーして、これをTwilio電話番号に接続したり、REST APIリクエストを送信したりできます。

Transitions: Trigger Widgetに接続される3つの初期イベントがあります。 着信通話、受信メッセージ、およびREST API(受信リクエスト)の3つです。 Trigger WidgetではカスタムTransitionイベントは認められていません。

変数:

Inbound Message(受信メッセージ) Trigger

Account SID trigger.message.AccountSid
Body trigger.message.Body
From trigger.message.From
FromCity trigger.message.FromCity
FromCountry trigger.message.FromCountry
FromState trigger.message.FromState
FromZip trigger.message.FromZip
Message SID trigger.message.MessageSid
Messaging Service SID trigger.message.MessagingServiceSid
Number of Media Items trigger.message.NumMedia
To trigger.message.To
ToCity trigger.message.ToCity
ToCountry trigger.message.ToCountry
ToState trigger.message.ToState
ToZip trigger.message.ToZip

Inbound Call(着信通話) Trigger

Account SID trigger.call.AccountSid
ApiVersion trigger.call.ApiVersion
Called trigger.call.Called
caller trigger.call.Caller
CallStatus trigger.call.CallStatus
Direction trigger.call.Direction
From trigger.call.From
FromCity trigger.call.FromCity
FromCountry trigger.call.FromCountry
FromState trigger.call.FromState
FromZip trigger.call.FromZip
Caller City trigger.call.CallerCity
Caller Country trigger.call.CallerCountry
Caller State trigger.call.CallerState
Caller ZIP trigger.call.CallerZip

Call SID

trigger.call.CallSid
Called City trigger.call.CalledCity
Called Country trigger.call.CalledCountry
Called State trigger.call.CalledState
Called ZIP trigger.call.CalledZip
To trigger.call.To
ToCity trigger.call.ToCity
ToCountry trigger.call.ToCountry
ToState trigger.call.ToState
ToZip trigger.call.ToZip

REST API Trigger

Variables passed in via REST API trigger will be available as Flow Data and accessible via {{flow.data.MY_CUSTOM_VARIABLE}} syntax. See the REST API page for more details.

⚙ Send & Wait For Reply

Send & Wait For Reply Widget

説明:

Send & Wait For Reply allows you to send an outgoing message, wait for a reply, and collect the user’s response. Use this Widget to collect replies to your messages, such as a YES to confirm an appointment or answering survey questions. You can also configure a timeout to wait for the response, after which we will assume "No Reply" and transition accordingly. You can use this to send a followup reminder message, trigger an outgoing voice call, or update your database with no response.

Results: Adds the following variables to the Execution context (where MY_WIDGET_NAME is the name of your actual widget):

変数:

outbound [Studioがエンドユーザーに送信するメッセージ]:

Sid

widgets.MY_WIDGET_NAME.outbound.Sid

External_id

widgets.MY_WIDGET_NAME.outbound.External_id

To

widgets.MY_WIDGET_NAME.outbound.To

From

widgets.MY_WIDGET_NAME.outbound.From

Body

widgets.MY_WIDGET_NAME.outbound.Body

Status

widgets.MY_WIDGET_NAME.outbound.Status

ErrorCode

widgets.MY_WIDGET_NAME.outbound.ErrorCode

ErrorMessage

widgets.MY_WIDGET_NAME.outbound.ErrorMessage

inbound [エンドユーザーがStudioに返送する応答メッセージ]:

Sid

widgets.MY_WIDGET_NAME.inbound.Sid

External_id

widgets.MY_WIDGET_NAME.inbound.External_id

To

widgets.MY_WIDGET_NAME.inbound.To

From

widgets.MY_WIDGET_NAME.inbound.From

Body

widgets.MY_WIDGET_NAME.inbound.Body

MediaUrl{N}

widgets.MY_WIDGET_NAME.inbound.MediaUrl0

If more than one media element is indicated by NumMedia than MediaUrl{N} will be used, where N is the zero-based index of the Media (e.g. MediaUrl0)



⚙ Split Based On...

Split Based On... Widget

説明:

Split Based On...を使用すると、Flowを分割してユーザーの条件に基づいて特定のWidgetに接続できます。 このWidgetを使用して、ユーザーがSMSに対して「はい」と返信したり、通話中にプッシュボタンの「1」を押したり、といった条件を扱います。

メモ: Studioの条件は大文字と小文字を区別せず、値の前後の空白文字は自動的に切り詰められます。

必須の構成:

名前

概要

初期値

Variable To Test

テストに使用する値(または式)です。

たとえば、メッセージ本文で分岐させたい場合、入力はメッセージ内に保存する変数になります。

ドロップダウンから定義済みの変数を選択するか、中括弧でくくって動的な変数を直接入力します: {{widgets.http_1.parsed.foo}}

{{widgets.send_message_1.message.Body}}

該当なし



Transitions:

You’ll define the event(s) that trigger transitions from this Widget. You get No Match for free once you set a branch.

名前

概要

初期値

Condition Matches

例: テキストが「はい」と一致した際の「YES」

NEW TRANSITION

noMatch

入力がユーザー定義の条件のどれとも一致しなかった

noMatch

条件は「subject (主語) predicate (述語) [value (値)]の形式を取り、右側のパネルで設定できます。

subject: 入力として定義された構成パラメーターです。

predicate: 使用する演算子です -- 等号、大なりイコール、などです。

[value]: 比較対象の値です。 定数、変数、および式がサポートされます。 値は「blank」や「has any value」といった特定の条件に対してnullに設定できます。

下記の例では、ユーザーに対してリマインダーを受信したいかどうか尋ねます。 Send & Wait For Reply Widgetの後続は、ユーザーのレスポンスを評価するSplit Based On... Widgetです。

3つの条件があります:

  1. プロンプト時にユーザーが「Y(YES)」を入力する
  2. プロンプト時にユーザーが「N(NO)」を入力する
  3. ユーザーが他の値を入力する(NO MATCH)

Subject (主語)

Predicate (述語)

{{widgets.reminders_response.inbound.Body}}

Equals

Y

{{widgets.reminders_response.inbound.Body}}

Equals

N

条件「YES」は、REMINDERS_CONFIRMという名前のSend SMS Widgetへの遷移 (Transition) し、一方「NO」および「NO MATCH」の条件はREMINDERS_OPTOUTという名前のSend SMS WidgetにTransitionします。

その他の条件についての使用例をいくつかご紹介します:

Subject (主語)

Predicate (述語)

{{flow.data.appointment_date}

Is After Date

2017-09-04

{{flow.data.appointment_time}

Is Before Time 16:35

{{flow.data.reward_points}}

Greater Than

1000

{{flow.data.first_name}}

Is Blank

{{trigger.message.Body}}

Matches Any Of yes,yeah,yup

{{flow.data.survey_result}}

Regex

[1-5]

Note: Omit leading and trailing slashes. Matching is case-insensitive.



⚙ Send Message

Send Message Widget

説明:

Send Messageを使用するとユーザーに対してメッセージを送信できます。このWidgetを使用して他のアクションに先立ってユーザーにメッセージを送信します。メッセージの後にユーザーからの入力をリクエストしたい場合は、代わりにSend & Wait For Reply Widgetを使用します。



必須の構成

名前

概要

初期値

Message Body

送信するメッセージのテキストです。

Send Message From

「From」番号です。 From電話番号、MessagingServiceSid、OTT Idからひとつ選択します

Flow Default flow.channel.address

Send Message To

The "to" number, or recipient of the message

Flow Default contact.channel.address

オプションの構成

名前

概要

初期値

MediaUrl

The URL of the media you wish you send out with the message (i.e. https://demo.twilio.com/owl.png)

Programmable Chat Service

Only applies for Flows working with Twilio Programmable Chat. A Chat service is where all the Channels, Messages, Users and other resources within a Chat deployment live. See the Chat Services REST API docs for more information.

trigger.message.InstanceSid

Programmable Chat Channel

Only applies for Flows working with Twilio Programmable Chat. Channels are the center of all chat activity within a Chat Service. Chat messages are sent to a particular channel. See the Chat Channels REST API docs for more information.

trigger.message.ChannelSid

Message Attributes

Only applies for Flows working with Twilio Programmable Chat. An optional string metadata field you can use to store any data you wish along with the sent message. The string value must contain structurally valid JSON if specified. See the Chat Mesages REST API docs for more information.

Using Programmable Chat:

Messages from a user in a Programmable Chat Channel can be received by Studio and responded to using the Send Message widget. To enable incoming Chat messages, add the Studio Flow's webhook URL as a Chat Channel webhook.

例:

curl -X POST https://chat.twilio.com/v2/Services/ISxxxxxxxx/Channels/CHxxxxxxxxxx/Webhooks \
--data-urlencode "Type=studio" \
--data-urlencode "Configuration.FlowSid=FWxxxxxxxxx" \
-u ACCOUNT_SID:AUTH_TOKEN

New messages posted in the Chat Channel will create a new Studio Execution, enabling the Studio Flow to interact with the Chat user.

変数:

発信

Sid widgets.MY_WIDGET_NAME.outbound.Sid
To widgets.MY_WIDGET_NAME.outbound.To
From widgets.MY_WIDGET_NAME.outbound.From
Body widgets.MY_WIDGET_NAME.outbound.Body
Status widgets.MY_WIDGET_NAME.outbound.Status

⚙ Say/Play

Say / Play Widget

説明:

Say/Playを使用すると、通話中のユーザーに録音済みメッセージを再生したり、テキストを読み上げたりできます。 このWidgetを使用して後続のアクションに先立ってユーザーに対して情報を読み上げたり再生したりします。 メッセージの後にユーザーに入力を要求したい場合は、代わりにGather Widgetを使用してください。

条件付き構成

下記のうちどれかひとつが必須です:

名前

概要

初期値

Say or Play Message

録音済みのメッセージをー再生するか、テキストを読み上げるかを選択します。

say

オプションの構成

名前

概要

初期値

Text To Say

(Sayの場合)読み上げるテキストです。 テンプレートがサポートされており、「こんにちは、{{first_name}}」といったような読み上げが可能です。

ヒント: 空白文字に囲まれたピリオドを追加すると、以下のようにスピーチに一時停止を追加します: 「Hello . . . {{first_name}}」。 およそ15個の空白で囲まれたピリオドは1秒間の無音に相当します。

Message Voice

(Sayの場合)ドロップダウンから希望する声を選択します。

Alice

URL of Audio File

(Playの場合)再生するメディアのURLです。 https://api.twilio.com/cowbell.mp3 などです。

サポートされるMIMEタイプ: <Play>

Language

(Sayの場合)ドロップダウンから希望する言語を選択します。

en

Number of Loops

メッセージのループ回数を選択します。

1




⚙ Gather Input On Call

Gather input on call widget

説明:

Gather Input On Call allows you to gather a user’s input while they are on call. Use this Widget to collect DTMF information. This can then be saved (great for collecting data) or sent to another Widget (such as a Split Based On... Widget) to send the user down the right path.

Gather Widgetには必須の構成はありません。

オプションの構成

名前

概要

サポートされる値

初期値

Say or Play a Message

録音済みのメッセージを再生するか、テキストを読み上げるかを選択します)Say/Playと同様です)。

Say a Message、Play a Message

メッセージを読み上げる

Text To Say

(Sayの場合)読み上げるテキストです。 テンプレートがサポートされており、「こんにちは、{{first_name}}」といったような読み上げが可能です。

Language

(if Say) Language and regional dialect for the message being said.

See dropdown list on the widget

en

Message Voice

(Sayの場合)ドロップダウンから希望する声を選択します。

Varies based on language selected

Alice

URL of Audio File

(Playの場合)再生するメディアのURLです。 https://api.twilio.com/cowbell.mp3 などです。

Number of Loops

メッセージのループ回数を選択します。

1

Stop Gathering After ___ Seconds

Time to wait for the caller to press a key.

1秒〜30秒

5秒

Speech Recognition Language

Language the speech engine will try to recognize.

See complete list en-US

Speech Recognition Hints

カンマで区切られたヒントの値の一覧です。

Stop Gathering On Keypress?

If Twilio should listen for a specific keypress to stop gathering digits. If set to "No," all keypresses will be gathered and submited once the the Stop Gathering After timeout is reached or the expected Number of Digits are collected.

Yes/No

はい

Stop Gathering On Keypress ___

A value that will submit the received data as soon as it’s pressed. Note: This is a control key and its value is not submitted with the rest of the gathered digits.

0〜9、#、* または空白文字

#

Stop Gathering After Number Of Digits

想定している数字の数であり、(押されたプッシュボタンが)その回数に達するとただちに送信を行います。

0〜9 または空白文字



変数:

Account SID widgets.MY_WIDGET_NAME.AccountSid
ApiVersion widgets.MY_WIDGET_NAME.ApiVersion
Called widgets.MY_WIDGET_NAME.Called
caller widgets.MY_WIDGET_NAME.Caller
CallStatus widgets.MY_WIDGET_NAME.CallStatus
Direction widgets.MY_WIDGET_NAME.Direction
From widgets.MY_WIDGET_NAME.From
FromCity widgets.MY_WIDGET_NAME.FromCity
FromCountry widgets.MY_WIDGET_NAME.FromCountry
FromState widgets.MY_WIDGET_NAME.FromState
FromZip widgets.MY_WIDGET_NAME.FromZip
Caller City widgets.MY_WIDGET_NAME.CallerCity
Caller Country widgets.MY_WIDGET_NAME.CallerCountry
Caller State widgets.MY_WIDGET_NAME.CallerState
Caller ZIP widgets.MY_WIDGET_NAME.CallerZip
Call SID widgets.MY_WIDGET_NAME.CallSid
Called City widgets.MY_WIDGET_NAME.CalledCity
Called Country widgets.MY_WIDGET_NAME.CalledCountry
Called State widgets.MY_WIDGET_NAME.CalledState
Called ZIP widgets.MY_WIDGET_NAME.CalledZip
To widgets.MY_WIDGET_NAME.To
ToCity widgets.MY_WIDGET_NAME.ToCity
ToCountry widgets.MY_WIDGET_NAME.ToCountry
ToState widgets.MY_WIDGET_NAME.ToState
ToZip widgets.MY_WIDGET_NAME.ToZip
Confidence widgets.MY_WIDGET_NAME.Confidence
Digits widgets.MY_WIDGET_NAME.Digits
Speech Result widgets.MY_WIDGET_NAME.SpeechResult
Unstable Speech Result widgets.MY_WIDGET_NAME.UnstableSpeechResult

⚙ Run Function

Run function widget

説明:

Run Functionを使用すると、Twilio Function(クラウド上で実行される軽量でサーバーレスなコード)を実行できます。 このWidgetを使用してStudioのWidgetと協調動作するビジネスロジックを記述してアプリケーションを仕上げます。

Functionを呼び出す際の変数の使用にあたっては、下記の2つの選択肢があります: (!) Flowの変数をパラメーターとしてFunctionに渡す(例: flow.data.foo)ことができます。 そして (2) Functionから返されるデータ(TwiMLまたはJSONを返すことができます)をFlow変数に設定できます。

メモ: すべてのRun FunctionのリクエストはContent-Type: application/x-www-form-urlencodedといsて送信されます。

必須の構成

Function Widgetで唯一必須の構成は、呼び出したいFunctionのURLのみです。 ドロップダウンから選択するか、Functionを名前で検索できます。

名前

概要

初期値

Function URL

呼び出したいFunctionです。

Hello SMS

なし

オプションの構成

Function Widgetにはオプションの構成がいくつかあります:

名前

概要

初期値

Function Parameters

key/valueの組みとして表現される、Functionに渡される0個以上の追加パラメーターです。 文字列定数と変数がサポートされます。

なし

Transitions:

このWidgetにはTransitionをトリガーする2つのイベントがあります。

名前

概要

success

Functionの返りに成功した場合 (HTTP 20X)

Fail

FUnctionの返りに失敗した場合 (またはエラーがありました)

レスポンス:

The HTTP response from the Function must return a 2xx status code within 5 seconds, and the response body must not exceed 64kB.

レスポンス Recommendation 注釈
Status Code 200 or 204 3xx redirection is supported. 4xx or 5xx status code will transition to "failed" in the widget.
Content Type application/json Content-Type header is not required if Status Code is 204 No Content. Other content types are supported, such as plain text or XML. But only application/json objects (e.g. {"foo":"bar"}) will be automatically parsed into Studio variables.
Body valid JSON Body content must match the Content-Type header.
Response Time 5 seconds or less Studio will timeout the request at 5 seconds and transition to "failed" in the widget.
Response Size Maximum 64kb Studio can only process responses up to 64kB.


変数:

Twiml: If your function returns Twiml, the twiml will be returned to the calling client.

Json: FunctionがJsonを返す場合、widgets.MY_WIDGET_NAME.parsed経由でアクセスできます。

たとえば{"message": "Hi", "person": {"name": "Bob", "age": 40}}を返すと、後続のWidget内で下記のように参照できます:

widgets.MY_WIDGET_NAME.parsed.message

widgets.MY_WIDGET_NAME.parsed.person.name

widgets.MY_WIDGET_NAME.parsed.person.age

すべての返り値の型については下記の変数があります:

widgets.MY_WIDGET_NAME.body

widgets.MY_WIDGET_NAME.status_code

widgets.MY_WIDGET_NAME.content_type

⚙ Make Outgoing Call

Make outgoing call widget

説明:

Make Outgoing Callを使用すると、Flow中でContactの電話番号に通話を発信できます。 このWidgetを使用して自動通話でContactに連絡したり、ボイメッセージを追加してフォローアップを行えます。

必須の構成:

The required fields for this Widget are To and From. The To must be the Contact's phone number and cannot be changed, but the From can be variables or hard-coded phone numbers.

名前

概要

初期値

Number To Call

Contactの電話番号 (変更できません)

Flowの既定 contact.channel.address

Number to Make Call From

発信者番号として使用する電話番号です

Flowの既定 flow.channel.address

オプションの構成:

名前

概要

初期値

Record

通話を録音し、mp3ファイルとして保存します

値: true、false

false

⚙ Connect Call To

Connect Call To Widget

説明:

Connect Call To allows you to bridge an in-progress call with another phone number (or numbers), Client user, SIM, SIP endpoint, or conference. Use this widget to connect your customer with a different department, or if they’re looking to reach a specific operator.

必須の構成:

The required fields for this Widget are Connect Call To and Caller ID, which can be variables or hard-coded entries. Select the Connect Call To type from the dropdown in the Inspector Panel, then set the field value to the number(s)/address that most accurately reflects the intended recipient.

名前

概要

初期値

Connect Call To

The phone number(s), Client user, SIM, SIP endpoint, or conference to call.
Note: For Multiple Numbers, separate each with commas: +14157234000, +14155551212, +14158675310

callerId

発信者番号として使用する電話番号です

Flow Default contact.channel.address

オプションの構成:

名前

概要

初期値

Record

通話を録音し、mp3ファイルとして保存します

値: true、false

false



⚙ HTTP Request

HTTP Request widget

説明:

HTTP Requestを使用すると、Studio外部のアプリケーションおよびコードとやり取りできます。 このWidgetを使用してFlowやFunctionsで定義されていないビジネスロジックの部分とやり取りします。

必須の構成:

このWidgetに必須のフィールドはRequest MethodおよびRequest URLです。 Request Methodはドロップダウンから選択でき、URLはAutomaticに設定することができます。

名前

概要

RequestMethod

リクエストに希望するHTTPメソッド(GET、POST、またはPUT)です。

Request URL

リクエストの送信先のURLです。

ヒント: URLのセキュリティーを向上させるには、Basic認証のクレデンシャルを追加します。 例: https://user:password@mydomain.com/handler.php

Content Type Content type of the request body, either application/x-www-form-urlencoded or application/json.

オプションの構成:

You may optionally decide to declare a request body and HTTP parameters for this Widget.

名前

概要

Request Body

Text to include as the body of your request.

HTTP Parameters

リクエストと一緒に渡す、パラメーターのひとつ以上のkey-valueの組です。 文字列定数と変数がサポートされます。


Transitions:

このWidgetにはTransitionをトリガーする2つのイベントがあります。

名前

概要

success

Functionの返りに成功した場合 (HTTP 20X)

Fail

The URL does not successfully return (or has an error)

レスポンス:

The HTTP response from the URL must return a 2xx status code within 5 seconds, and the response body must not exceed 64kB.

レスポンス Recommendation 注釈
Status Code 200 or 204 3xx redirection is supported. 4xx or 5xx status code will transition to "failed" in the widget.
Content Type application/json Content-Type header is not required if Status Code is 204 No Content. Other content types are supported, such as plain text or XML. But only application/json objects (e.g. {"foo":"bar"}) will be automatically parsed into Studio variables.
Body valid JSON Body content must match the Content-Type header.
Response Time 5 seconds or less Studio will timeout the request at 5 seconds and transition to "failed" in the widget.
Response Size Maximum 64kb Studio can only process responses up to 64kB.


変数:

Json: FunctionがJsonを返す場合、widgets.MY_WIDGET_NAME.parsed経由でアクセスできます。

たとえば{"message": "Hi", "person": {"name": "Bob", "age": 40}}を返すと、後続のWidget内で下記のように参照できます:

widgets.MY_WIDGET_NAME.parsed.message

widgets.MY_WIDGET_NAME.parsed.person.name

widgets.MY_WIDGET_NAME.parsed.person.age

すべての返り値の型については下記の変数があります:

widgets.MY_WIDGET_NAME.body

widgets.MY_WIDGET_NAME.status_code

widgets.MY_WIDGET_NAME.content_type

⚙ Record Voicemail

Record VM widget

説明:

Record Voicemailを使用すると、通話のオーディオを録音して、オプションでそれをテキスト化することもできます。このWidgetを使用して顧客との会話を保存します。オーディオファイルはPlay WidgetのURLを使用して再生できます。 widgets.MY_WIDGET_NAME.RecordingUrl.

Note that Studio does not handle transcription processing automatically. You can specify the callback URL when transcription is complete and handle it yourself. Using a Function is a great way to customize the behavior, such as emailing the transcription, although it requires writing some code.

変数:

Sid widgets.MY_WIDGET_NAME.Sid
作成日 widgets.MY_WIDGET_NAME.DateCreated
更新日 widgets.MY_WIDGET_NAME.DateUpdated
Account SID widgets.MY_WIDGET_NAME.AccountSid
Call SID widgets.MY_WIDGET_NAME.CallSid
RecordingUrl widgets.MY_WIDGET_NAME.RecordingUrl
Duration widgets.MY_WIDGET_NAME.Duration
Price widgets.MY_WIDGET_NAME.Price
PriceUnit widgets.MY_WIDGET_NAME.PriceUnit
ApiVersion widgets.MY_WIDGET_NAME.ApiVersion
URI widgets.MY_WIDGET_NAME.Uri
Status widgets.MY_WIDGET_NAME.Status
ソース widgets.MY_WIDGET_NAME.Source
Channels widgets.MY_WIDGET_NAME.Channels

⚙ Enqueue Call

Enqueue Call Widget

説明:

Enqueue Call enqueues the current call into a call queue. The caller will hear hold music until the call is dequeued by another caller.

必須の構成:

You must select a Queue or TaskRouter Task when configuring this Widget. The choice may be selected from a dropdown, with additional configuration fields appearing based on the selection.

名前

概要

Queue Name

The name of the Queue to place the call into (i.e. "Everyone"). If this Queue doesn’t exist, it will be created on demand. Max length of 64 characters.

Workflow SID

The desired Workflow ID for handling the TaskRouter Task.

オプションの構成:

You may optionally decide to declare task attributes, priority, timeout, and a hold music TwiML URL for the request initiated by this Widget.

名前

概要

Taskの属性

JSON representing task attributes (max 1024 characters)

Priority

The priority of this task in the TaskQueue. Tasks with a higher priority are assigned before older tasks with a lower priority. If not specified, will be treated as 0 during evaluation.

Timeout

The number of seconds you want the task to remain in this TaskQueue. Must be a positive integer < 2 weeks in seconds. If not specified, defaults to infinity.

Hold Music TwiML URL

The URL for custom hold music TwiML. If not specified, the default hold music will play upon enqueue.

Transitions:

名前

概要

Call Complete

Transition is triggered when the Enqueue action URL is requested. Due to the underlying behavior of the Enqueue action URL, Studio can only regain control of the live call after dequeueing if the call was originally dequeued using <Dial><Queue>.

Failed to Enqueue

Transition is triggered if enqueuing of the call fails, such as if the queue is full (max 100 members).

Call Failed

Transition is triggered if QueueResult is "system-error".

⚙ Send to Flex

Send to Flex widget

説明:

For Flex-enabled Projects, Send to Flex transfers a call or a message to Flex by creating a TaskRouter Task. Voice calls are enqueued and the caller will hear hold music while waiting for a Worker. Messages are transferred to Flex as new tasks for assignment to a Worker.

必須の構成:

You must select a Workflow and Channel when configuring this Widget.

名前

概要

Workflow

The name of the Flex Worfklow assigned to the Project.

Channel

The Task Channel being used. Only Voice and Chat are currently supported (select Chat for SMS).

オプションの構成:

You may optionally decide to declare task attributes, priority, timeout, and a hold music TwiML URL for the request initiated by this Widget.

名前

概要

Priority

The priority of this task in the TaskQueue. Tasks with a higher priority are assigned before older tasks with a lower priority. If not specified, will be treated as 0 during evaluation.

Timeout

The number of seconds you want the task to remain in this TaskQueue. Must be a positive integer < 2 weeks in seconds. If not specified, defaults to infinity.

属性

JSON representing task attributes (max 1024 characters)

URL Method

Method to be used when requesting the Hold Music TwiML URL (GET or POST)

Hold Music TwiML URL

The URL for custom hold music TwiML. If not specified, the default hold music will play upon transfer.

Transitions:

名前

概要

Task Created

For Voice calls, transition is triggered when the Enqueue action URL is requested. For Messages, transition is triggered as soon as the TaskRouter Task is created.

Failed to Create Task

For Voice calls, transition is triggered if enqueuing of the call fails. For Messages, transition is triggered immediately when TaskRouter returns an error for Task creation.

Call Failed

Only applies to Voice calls. Transition is triggered if QueueResult is "system-error".

⚙ Capture Payments

Capture Payments widget

説明:

Capture Payments allows you to securely capture credit card details on a call and either tokenize or process the payment using a Payment Gateway. This widget uses the underlying TwiML verb <Pay>.

Note: Use of Capture Payments requires PCI Mode to be enabled in Voice Settings.

オプションの構成:

名前

概要

Timeout

Sets the limit in seconds to wait for the caller to press another digit before moving on to validate the digits captured.

Max Attempts

Number of times to retry when collecting information.

Language

Language to speak when prompting the caller for credit card details.

Valid Card Types

Credit card types that should be accepted. Allows multiple values.

Request Security Code

Whether to prompt for credit card security code.

Request Postal Code

Whether to prompt for postal code.

Pay Connector

Unique Name corresponding to the Payment Gateway Connector installed in Twilio Add-ons

Payment Token Type

Select one-time payment or reusable payment.

Charge Card with Amount

Amount to be charged.

Currency

Currency to use when charging the card.

概要

Description of the payment.

Transitions:

名前

概要

success

Payment has completed successfully.

Max Failed Attempts

Maximum number of failed attempts has been reached.

Provider Error

Error communicating with Payment Provider.

Pay Interrupted

Payment process interrupted by caller pressing *.

Hang Up

Caller hung up during payment process.

Validation Error

Invalid attributes received.

⚙ Set Variables

Set Variables Widget

説明:

Set Variables allows you to save key/value pairs in the global context of the flow execution. Variables set via the widget are accessible throughout your flow via other widgets under the key {{flow.variables.<key>}}. This allows you to enable use cases such as counters that are dynamically updated as your flow executes.

オプションの構成:

You can add any number of Variables. Variables can have static values like a single number or string, or dynamic values set via the Liquid templating language.

Example that sets a variable called count to 0 if not set and increments it if it exists:

{% if flow.variables.count %}
  {{flow.variables.count | plus: 1}}
{% else %}
  0
{% endif %}

Configuration

名前

概要

Key

The name of this variable, once set, will be accessible in liquid via {{flow.variables.<key>}}.

Note: Variable names are case sensitive. Foo is a different variable to foo.

The variable value to set. This can be a number or string value, or a liquid template block like the example above.

Transitions

There is only one transition from this widget, "Next" which fires once any variables specified are set.

Example Flow

In the call flow screenshot below, the count variable is set to 0 when the flow starts, and the flow will loop until the count variable is equal to 3 and then exit (The set variable widget uses the sample liquid template code from above).

Screen Shot 2018-12-11 at 10.11.23 AM.png

⚙ Understand

understand widget

説明:

Understandを使用すると、入力文字列に機械学習を適用して情報を収集したり、そこから意図を汲み取ったりできます。 このWidgetを使用して受信したメッセージから「肯定的」あるいは「否定的」といったようなユーザーの意図を抽出し、Flowや顧客の意図をさらにカスタマイズします。

NOTE: The Understand widget is deprecated. A new Autopilot widget will take its place.

必須の構成:

このWidgetに必須のパラメーターはUnderstand Service IDおよびQueryであり、変数またはハードコーディングされた番号が使用できます。

名前

概要

Understand Service SID

使用したいUnserstand ServiceのSIDです

query

Flowの別の場所、例えばCall WidgetでのGather入力から得られた番号やスピーチなどから得られた変数の選択、検索を可能にします。

Rate this page:

ヘルプが必要ですか?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.