Flow: Receive
This node receives inbound response from end customers over SMS, Voice,Facebook Messenger, Email, Twitter, WeChat, RTM and Custom event channels configured in the service.
You can configure Maximum time out for all the events configured inside Receive node, if the node fails to receive all the data within the time specified then corresponding mapped exception is thrown.
Custom Event & Cross Channel
Receive node can be configured to facilitate flow wait across 'Custom event' and 'Channels events' simultaneously or either one independently or combined in any sequence desired.
SETTINGS
Node's specific configurations are accessed by double-clicking on the node.
Response for all channels/events (except Custom Event) will be available as 'sysResponseMessage'.
Post data from the Custom Event will be available as 'session data'.
| Channel/Events | Description |
|---|---|
| Receive SMS | An inbound message from the customer identified by 'From number' resumes the flow. |
| Inbound Voice | An inbound Voice call from the customer identified by 'From number' resumes the flow. |
| Facebook Messenger - Incoming Message | An inbound message identified by Facebook app id and PSID resumes the flow. |
| Facebook Messenger - Postback | The flow is resumed on receiving a post-back event from the configured PSID. |
| Facebook Messenger - Account linking | Flow is resumed when new Facebook account with configured PSID is linked. |
| Facebook Messenger - Authentication | Resume flow on successful authentication of Facebook with configured Facebook PSID. |
| Facebook Messenger - Referral | Resume flow when referral is sent from configured PSID. |
| Receive Email | An inbound email identified from 'From(emailid)' resumes the flow. |
| Twitter message | Resume flow on inbound Twitter message identified by 'From(twitterid)'. |
| Custom Event | Selected custom event resumes flow along with post data from the event available as 'session data'. |
| WeChat message | Resume flow on inbound Wechat message |
| In-app messaging | Resume flow on inbound In-app messaging identified by 'From(threadid)' and 'From(userId)'. |
Example Usage
Multiple Channel/Events
Here, the flow will simultaneously wait to receive any of the 9 receive events namely:
- Inbound SMS from customer on 442477180129 (or)
- One of the Facebook messenger events from the customer
- Incoming message (or)
- Post back (or)
- Account linking (or)
- Authentication (or)
- Referral (or)
- Inbound Twitter DM from customer (or)
- Inbound email from the customer (or)
- Inbound custom event on event ID 3766 where the post key value pairs match the set data i.e.
Name as 'IMI' and userID as '66'.
If more than one event is carried forward by end-customer - For example Sends Inbound sms on 442477180129 and then links Facebook Account and then sends email on configured 'From(email)
then the flow will be invoked thrice with unique transaction Id for each event hence creating unique session for each event.
The above screenshot depicts flow Transaction logs which can be accessed by clicking on 'Debug'.Transaction log shows flow has been invoked five times along with the total time taken for running each flow & the trigger that initiated the flow & the date and time at which the event was invoked.
Further detail about each session can be obtained by clicking on a particular 'Transaction ID'.
Receive SMS
| Property | Description |
|---|---|
| Number | The number to which SMS is sent by the customer. |
| Keyword | Unique String configured by the user to trigger the flow. |
| From Number | Customer's Number from which SMS is sent. |
Inbound Voice
| Property | Description |
|---|---|
| Number | Auto-filled property obtained from number selected under Setting fa-arrow-right Apps For more information, see Numbers and Apps |
| From number | An inbound voice on the number from the customer identified by 'From number' resumes the flow. |
Facebook Messenger
| Property | Description |
|---|---|
| App Id | Auto-filled property obtained from app selected under General Setting Apps. |
| From(PSID) | Flow resumes only when Configured 'From(PSID)' matches event-triggering (Customer's) Facebook PSID. |
| Event name | Select an event- Incoming Message Postback Account Linking Authentication Referral Multiple Facebook events can be added using- + Add another Facebook event. |
Receive Email
| Property | Description |
|---|---|
| App Id | Auto-filled property obtained from app selected under General Setting Apps |
| From(email Id) | Resume flow on inbound Email identified by 'From(email Id)' . |
Twitter message
| Property | Description |
|---|---|
| App Id | Auto-filled property obtained from app selected under 'General Setting Apps. |
| From(twitterid) | Resume flow on inbound twitter message identified by From(twitter id).'. |
Custom Event
| Property | Description |
|---|---|
| Custom event | The selected custom event resumes flow on successful HTTP request along with post data from the event available as 'session data'. To configure a custom event go to General settings fa-arrow-right custom events. |
| Resume Key | A unique value passed within the HTTP body to match the 'custom event request' with 'flow session'. Multiple Resume key - value pair can be configured using + ADD ANOTHER RESUME KEY-VALUE. |
WeChat message
| Property | Description |
|---|---|
| App Name | Auto-filled property obtained from app selected under General Setting Apps. |
| From(wechat_user_id) | Resume flow on inbound WeChat message identified by From(wechat_user_id) |
In-app messaging
| Property | Description |
|---|---|
| App Id | Auto-filled property obtained from app selected under General Setting Apps. |
| From(thread id) | Resume flow on inbound In-app messaging identified by 'From(thread id)'. |
| From(user Id) | Resume flow on inbound In-app messaging identified by 'From(user Id)'. |
SESSION DATA
For information on session data, click here .
CUSTOM LOGS
For information on custom logs, click here.
NODE EVENTS
To configure the nodes, select the node event point and drag anywhere on the screen.
| Exit Event | Description |
|---|---|
| onerror | This event is triggered when an error occurs. |
| onsuccess | This event is triggered if the node completes successfully. |
| ontimeout | This edge receives information when the request is timed out as defined in the Time Out (Sec) parameter and pass it to the next connected node for further action in the flow. |
Updated about 5 years ago