Introduction
List of all custom functions
URL: http://192.168.1.42:3000/centraloutboundwebhook-v1/prod
Method Name | Description |
|---|---|
createOutbound | Done |
dateCompare | |
fetchUserPreferences | |
updateUserPreferences | Done |
getFlowVariables | |
updatePauseStatusForCLI | Done |
URL: http://192.168.1.42:3000/chatbotwebhook-v1/prod
Method Name | Description |
|---|---|
linkcreation |
URL: http://192.168.1.42:3000/googleapiwebhook-v1/prod
Method Name | Description |
|---|---|
translateText |
URL: http://192.168.1.42:3000/hdfcsenseforthwebhook-v1/prod
Method Name | Description |
|---|---|
speechprocessing |
URL: http://192.168.1.42:3000/pullreportapiwebhook-v1/prod
Method Name | Description |
|---|---|
pullreport |
To Check:
Method Name | Description |
|---|---|
tonetag/generalwebhook | |
hdfcrural/locateBranch | |
reliance-nippon/ValidateDateAndTime |
1. Validate Date and Time
URL : http://192.168.1.42:3000/reliance-nippon-v1/test/
Method : ValidateDateAndTime
Usage : This webhook is used when you want to check weather any date and time is correct or not, is a holiday, a weekend according to the configured weekdays etc.
Request
Flow Variable | Example | Description |
$flow.key.inputDate | 2019-12-08T05:00:00+05:30, 4 November 2019 etc | Input date that needs to be validated |
$flow.key.validMAxDays | 5 | Given date is must be in future business day and not after that days. ex : if value is 5 than max 5 future day is valid other than not (excluding holiday). |
$flow.key.flowId | 58 | Flow ID of the flow from which request was sent |
$flow.key.workingDaysOff | MOnday,FRiday,sunday | Working days to be consider in validating date |
$flow.key.accountID | 2 | Account ID of the request |
$flow.key.incrementDays | 0 | Days to be incremented in input date |
$flow.key.appointmentStartTime | 2019-11-05T18:00+05:30 | Start Time of the appointment |
$flow.key.appointmentEndTime | 2019-11-05T18:00+05:30 | End time of the appointment |
$flow.key.type | Appointment |
Response
Flow Variable | Example | Description |
$flow.key.outputDate | 2019-12-08T05:00:00+05:30 | Send Output date after validating and crrecting. |
$flow.key.smsDate | 8-12-2019 | The output date to be send in SMS |
$flow.key.SmsOutputTime | 09:00 AM to 06:00 PM | The output time to be send in SMS |
$flow.key.outputTime | 09:00 AM to 06:00 PM | The output time after validating |
$flow.key.outputDay | Sunday | The output day after validating |
$flow.key.timeIsValid | false | ‘True' or 'False’ if the time is valid or not respectively |
$flow.key.dateIsValid | false | ‘True' or 'False’ if the date is valid or not respectively |
2. Initiate Outbound Flow
Using this webhook, you can request to initiate any Outbound Flow of your account using it's API.
URL : http://192.168.1.42:3000/centraloutboundwebhook-v1/prod/
Method : createOutbound
Request :
Flow Variable | Example | Description |
$flow.syskey.apiVersion | 1.0 | Outbound Flow Version |
$flow.syskey.securityID | <64 Character UUID> | Security ID |
$flow.syskey.flowID | <8 Chacter UUID> | Flow ID |
$flow.syskey.clientID | 123123123 | Client Identifier |
$flow.syskey.delayMinutes | 0 | When to start the Outbound Flow from current system time. |
$flow.syskey.contactNumbers | 91997974 6666 | Customer Numbers |
Response :
Flow Variable | Value |
$flow.key.obdResponseCode | 200 |
$flow.key.obdReqID | Request ID |
$flow.key.obdPhononUUID | Phonon UUID |
3. shortURL
Using this webhook, you can shorten a long URL to a short URL.
URL: https://s.phonon.in/UrlShortner/phonon/shortUrl
Method: POST
Headers:
Headers | Title |
Content-Type | application/json |
Accept | application/json |
Request:
{
"custToken": "abcd1234",
"longUrl": "https://google.co.in"
}
custToken is static at "abcd1234"
Response:
{
"shortUrl": "https://s.phonon.in/BEK4YYnx"
}
You can have your custom domain. Contact Support to help you with that.
3. updateUserPreferences
Using this webhook, you can update $user.key Flow Variables without requiring a Make Call widget. Great for usage in Email and SMS flows.
Note: This will become an inert feature of $user.key flow variables soon resulting this to be obsolete.
URL: http://192.168.50.21:3000/centraloutboundwebhook-v1/prod/
Method : POST
Request :
Flow Variable | Example | Details |
$flow.syskey.phonon_uuid | daa638a2-a5e9-4ac0-9934-f2b5e818ac48 | |
$user.key.Language | English | |
$user.key.requestid | d1f513a9-c5ab-4e0a-92f0-72d0935c6201 | |
$user.syskey.contactNumber | 8000374XXX | Enter the unique ID of the Customer such as it's phone number. |
$user.syskey.accountID | 163 | Account ID of the Central Account where the flow is |
$user.key.XXXX... | Value | You can save or get any value |
Response :
4. updatePauseStatusForCLI - Change Break Status of a Direct Dial Agent
Using this webhook, you can change the break status of a Direct Dial Agent. While the Direct Dial Agent is on break, s/he will not be considered for any calls allotment. For example, if your Dialer DID is 91806880080, you can create an Inbound Flow with the same DID with this webhook. DID Agents can call on the Inbound number to change their pause status anytime (or you can toggle it automatically).
Notes:
In the Dialer Flow, you can get the Agent CLI using
$call.agent.dnis.numberor for Inbound Flow =>$call.cli.number
URL: http://192.168.60.15:3000/centraloutboundwebhook-v1/prod/
Method: POST
Request :
Flow Variable | Example | Description |
$flow.key.pause |
| Set the Direct Dial Agent Pause Status to be true. |
Content |
| Set the Direct Dial Agent Pause Status to be false. |
$flow.key.cli | 9879964805 | CLI of the Direct Dial Agent. With or Without Country Code |
Content | 919879964805 | Content |
Response :
Flow Variable | Example | Description |
$flow.key.cli_pause_update |
| The Direct Dial was successfully paused / unpaused |
Content |
| The Direct Dial was could not be paused / unpaused |
Add Comment