Examples

🚧

[BETA]

This product is currently in early access. Please reach out to your account manager to get more information.

Examples

Chat Apps auto reply:

{
        "subAccountId": "Test_12345_ChatApps",
        "trigger": "inbound_chat_apps",
        "status": "enabled",
        "definition": {
            "name": "Auto Reply ChatApps",
            "steps": [
                {
                    "id": "send_CA",
                    "stepType": "ChatAppsMessage",
                    "inputs": {
                        "subAccountId": "Test_12345_ChatApps",
                        "user": {
                            "msisdn": "{{data.payload.user.msisdn}}"
                        },
                        "type": "text",
                        "content": {
                            "text": "Hello, thank you for your message!"
                        }
                    }
                }
            ]
        }
    }

SMS auto reply:

{
        "subAccountId": "Test_12345_hq",
        "trigger": "inbound_sms",
        "status": "enabled",
        "definition": {
            "name": "Auto Reply SMS",
            "steps": [
                {
                    "id": "send_sms",
                    "stepType": "SMS",
                    "inputs": {
                        "subAccountId": "Test_12345_hq",
                        "source": "MyBrand",
                        "destination": "{{data.payload.source}}",
                        "text": "Hello, thank you for your message!",
                        "encoding": "Auto"
                    }
                }
            ]
        }
    }

Out of Office with country branch:

{
        "subAccountId": "Test_12345_hq",
        "trigger": "inbound_chat_apps",
        "status": "enabled",
        "definition": {
            "name": "Out of Office",
            "steps": [
                {
                "id": "branch_on_msg_country",
                "stepType": "Branch",
                "selectNextStep": {
                    "message_from_ID": "{{isCountryCode(data.payload.user.msisdn, 'ID')}}",
                    "message_from_US": "{{isCountryCode(data.payload.user.msisdn, 'US')}}",
                    "handle_mo_from_others": null
                         }
                },
                {
                "id": "message_from_ID",
                "stepType": "If",
                "inputs": {
                "condition": "{{!isTimeOfDayBetween(data.timestamp, '09:00:00', '18:00:00', 'SE Asia Standard Time')}}"
                },
                "do": [
                    [
                        {
                "id": "ID_out_of_office_hours",
                "stepType": "ChatAppsMessage",
                        "inputs": {
                        "subAccountId": "Test_12345_ChatApps",
                        "user": {
                            "msisdn": "{{data.payload.user.msisdn}}"
                        },
                        "type": "text",
                        "content": {
                            "text": "Halo, terima kasih atas pesan Anda!"
                        }
                    }
                  ]
                 ]
                },
                {
                "id": "message_from_US",
                "stepType": "If",
                "inputs": {
                "condition": "{{!isTimeOfDayBetween(data.timestamp, '09:00:00', '18:00:00', 'Pacific Standard Time')}}"
                },
                "do": [
                    [
                        {
                "id": "ID_out_of_office_hours",
                "stepType": "ChatAppsMessage",
                        "inputs": {
                        "subAccountId": "Test_12345_ChatApps",
                        "user": {
                            "msisdn": "{{data.payload.user.msisdn}}"
                        },
                        "type": "text",
                        "content": {
                            "text": "Hello, thank you for your message!"
                        }
                      }
                   ]
                 ]
               }
            ]
        }
    }

Keyword detection:

{
        "subAccountId": "Test_12345_hq",
        "trigger": "inbound_sms",
        "status": "enabled",
        "definition": {
            "name": "Promo_register",
            "steps": [
                {
                    "id": "keyword",
                    "stepType": "branch",
                    "selectNextStep": {
                            "register_flow_1": "{{stringContains(data.payload.body, 'Register')}}",
                            "others": null
                            }

                },
                {
                    "id": "register_flow_1",
                    "stepType": "HttpRequest",
                    "inputs": {
                            "url": "https://sample.api.com/newrecord/",
                            "method": "POST",
                            "headers": {
                            "Authorization": "Bearer 4f5b6f29654s36654xsvdc895b469dc0"
                             },
                            "body": { 
                                "register": 1,
                                "user": "{{'umid: ' + data.payload.source}}", 
                                "time": "{{data.receivedAt}}"
                             },
                            "outputs": {
                            "httpCode": "{{step.responseCode}}"
                             },
                    {
                    "selectNextStep": {
                        "register_flow_2": "{{step.responseCode == '200'}}",
                        "register_flow_fail": null
                        }
                    }
                },
                {
                "id": "register_flow_2",
                "stepType": "ChatAppsMessage",
                "inputs": {
                        "subAccountId": "Test_12345_ChatApps",
                        "user": {
                            "msisdn": "{{data.payload.user.msisdn}}"
                        },
                        "type": "text",
                        "content": {
                            "text": "Hello, you are now registered, thanks !"
                        }
                    }
                },
                {
                "id": "register_flow_fail",
                "stepType": "ChatAppsMessage",
                "inputs": {
                        "subAccountId": "Test_12345_ChatApps",
                        "user": {
                            "msisdn": "{{data.payload.user.msisdn}}"
                        },
                        "type": "text",
                        "content": {
                            "text": "Hello, something went wrong, please try again later"
                        }
                    }
                }
            ]
        }
    }

Menu using WaitForReply:

{
   "trigger":"inbound_chat_apps",
   "subAccountId":"Test_12345_hq",
   "status": "enabled",
   "definition":{
      "name":"ChatBot-123",
      "steps":[
         {
            "stepType":"ChatAppsMessage",
            "id":"Hello",
            "inputs":{
               "subAccountId":"Test_12345_hq",
               "user":{
                  "msisdn":"{{data.payload.user.channelUserId}}"
               },
               "type":"text",
               "content":{
                  "text":"Hello, 👋\r\nThanks for contacting our team 🤖\r\n Please choose one of the option below: 🤓 \r\n 1️⃣ Technical Support \r\n 2️⃣ Product Questions \r\n 3️⃣ Sales Support \r\n 4️⃣ Billing Qestions \r\n 5️⃣ Other"
               }
            },
            "outputs":{
               "user_msisdn":"{{data.payload.user.channelUserId}}"
            },
            "nextStepId":"wait1"
         },
         {
            "stepType":"WaitForReply",
            "id":"wait1",
            "inputs":{
               "timeout":"00:05:00",
               "channel":"whatsapp",
               "from":"{{data.user_msisdn}}"
            },
            "outputs":{
               "reply1":"{{step.reply}}"
            },
            "selectNextStep":{
               "success":"{{data.reply1 != null}}",
               "failure":"{{data.reply1 == null}}"
            }
         },
         {
            "stepType":"Branch",
            "id":"success",
            "selectNextStep":{
               "branch1":"{{ data.reply1.payload.content.text == '1'}}",
               "branch2":"{{ data.reply1.payload.content.text == '2'}}",
               "branch3":"{{ data.reply1.payload.content.text == '3'}}",
               "branch4":"{{ data.reply1.payload.content.text == '4'}}",
               "branch5":"{{ data.reply1.payload.content.text == '5'}}"
            }
         },
         {
            "stepType":"ChatAppsMessage",
            "id":"branch1",
            "inputs":{
               "subAccountId":"Test_12345_hq",
               "user":{
                  "msisdn":"{{data.user_msisdn}}"
               },
               "type":"text",
               "content":{
                  "text":"Thanks for choosing 1️⃣ Technical Support! \r\n This department will get back to you shortly"
               }
            }
         },
         {
            "stepType":"ChatAppsMessage",
            "id":"branch2",
            "inputs":{
               "subAccountId":"Test_12345_hq",
               "user":{
                  "msisdn":"{{data.user_msisdn}}"
               },
               "type":"text",
               "content":{
                  "text":"Thanks for choosing 2️⃣ Product Questions! \r\n This department will get back to you shortly"
               }
            }
         },
         {
            "stepType":"ChatAppsMessage",
            "id":"branch3",
            "inputs":{
               "subAccountId":"Test_12345_hq",
               "user":{
                  "msisdn":"{{data.user_msisdn}}"
               },
               "type":"text",
               "content":{
                  "text":"Thanks for choosing 3️⃣ Sales Support! \r\n This department will get back to you shortly"
               }
            }
         },
         {
            "stepType":"ChatAppsMessage",
            "id":"branch4",
            "inputs":{
               "subAccountId":"Test_12345_hq",
               "user":{
                  "msisdn":"{{data.user_msisdn}}"
               },
               "type":"text",
               "content":{
                  "text":"Thanks for choosing 4️⃣ Billing Support! \r\n This department will get back to you shortly"
               }
            }
         },
         {
            "stepType":"ChatAppsMessage",
            "id":"branch5",
            "inputs":{
               "subAccountId":"Test_12345_hq",
               "user":{
                  "msisdn":"{{data.user_msisdn}}"
               },
               "type":"text",
               "content":{
                  "text":"Thanks for choosing 5️⃣ other! \r\n This department will get back to you shortly"
               }
            }
         },
         {
            "stepType":"ChatAppsMessage",
            "id":"failure",
            "inputs":{
               "subAccountId":"Test_12345_hq",
               "user":{
                  "msisdn":"{{data.user_msisdn}}"
               },
               "type":"text",
               "content":{
                  "text":"Ok if you don't reply I will chat with someone else 😥 Feel free to contact me again 👨‍💻"
               }
            }
         }
      ]
   }
}