Activate Listener for Outbound Flows

In order to trigger and run any outbound flow first you need to activate the listener for that flow. Activating listener means activating the service of outbound calls on the outbound flow. To activate the listener, you need to follow below steps -

1. Create any outbound flow

2. Attach the DIDs to that flow

3. Drop a mail on help@phonon.io regarding the same with the following details

   1. Client ID/ Account ID

   2. Flow ID

   3. All the DID numbers attached

How to trigger Outbound Flows ?

Triggering outbound flow means uploading customer’s details to broadcast or run the outbound campaign (like customer number, startime, flow variables). That is making calls to those customers at mentioned starttime. The outbound flows can be trigged in three ways -

1. Webservice End Point

→ The API Request (with method as post) should be send to mentioned webservice end point in the flow. The webservice endpoint for

1. Outbound Multicast flow is “https://central.phonon.in/kairos-apis/outbound/create”

2. Outbound Dialer flow is “https://central.phonon.in/kairos-apis/outbounddialer/create”

→ API Request Body :

{
	"api-version" : "1.0",
  	"security-id" : "your security ID",
    "flow-id" : "your flow ID",
    "calls" : [{
        "client-identifier" : "Call identifier",
        "start-time" : "start date and time"
		"contact-numbers": ["Contact no to call"],
		"keys" : [
          {"name" : "$flow.key.<Flow Variable>",
          "value" : "value for flow variable"},
          {"name" : "$flow.key.<Flow Variable>",
          "value" : "value for flow variable"}
        ]
    }]
}

→ You can get security ID and flow ID from the flow’s configurator tab. Example shown below

Note - Before sending request, make sure to whitelist your IP through which you are sending API request in the whitelist section.

2. Email Upload

• You can find unique email ID for each outbound flows. You can send email with attachment to that email ID.

• Upon file being loaded, the user will receive an auto-response message, that the upload was successful or not.

• Call List File Instructions

  If you're uploading the call list using a file, please keep in mind the following

  1. Support file formats are .csv and .zip

  2. You can upload a .csv file of maximum 5MB

  3. Download the template file from the interface.

  4. telX:Put the customer number with country code in tel1 header, alternative numbers can be added as tel2,tel3, etc. up to tel10.

  5. $flow.key.variable:You can upload value of any flow variable by putting the flow variable name as the header and value in the respective cell.

  6. starttime:You can input the starttime of each record in the starttime header in ISO 8601 format.

  7. Common starttime:If the starttime is common for all the records, you can input the starttime in the file name as "upload_<starttime in ddMMyyyyHHmmss format>.csv' Example: upload_08022020211200.csv

• You can find email ID for email upload in outbound flow’s configurator tab. Example shown below.

3. Direct Upload through Interface

You can upload the .csv or .zip file directly from the interface by selecting a file or by drag and drop method. To know more about direct upload, click here.