Versions Compared

Old Version 4

changes.mady.by.user Riddhi Shah (Deactivated)

Saved on

compared with

New Version 5

changes.mady.by.user Riddhi Shah (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Internal Webhooks

1. Validate Date and Time

Status :

Status
colourRedGreen
titleGetting Errorworking

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.

URL : http://192.168.160.4215:3000/reliance-nippon-v1/test/

...

Flow Variable

Example

Description

$flow.key.outputDate

2019-12-08T05:00:00+05:30

Send Output date after validating and correcting.

$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.

If the type is ‘Callback’, then the time will be of form '08:00 AM to 08:00 PM'

$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' if time is valid, otherwise 'False’

$flow.key.dateIsValid

false

‘True' if time is valid, otherwise 'False’

2. Initiate Outbound Flow

Status :

Status
colourRedGreen
titleGetting Errorworking

Usage : Using this webhook, you can request to initiate any Outbound Flow of your account using it's API.

URL : http://192.168.150.4221:3000/centraloutboundwebhook-v1/prod/‌

Method : createOutbound

R‌equest :

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

ValueExample

Description

$flow.key.obdResponseCode

200

Response code

$flow.key.obdReqID

<Request ID>

Request IDId

$flow.key.obdPhononUUID

<Phonon UUID>

Phonon UUID

3

...

Status :

Status
colourGreen
titleworking

‌Usage : Using this webhook, you can shorten a long URL into a short URL.

URL: https://s.phonon.in/UrlShortner/phonon/shortUrl

Method: POST

Headers:

...

Key

...

Value

...

Content-Type

...

application/json

...

Accept

...

application/json

Request:

...

.

...

custToken is static at "abcd1234"

Response:

Code Block
{  
    "shortUrl": "https://s.phonon.in/BEK4YYnx"
}

You can have your custom domain. Contact Support to help you with that.

...

updateUserPreferences

Status :

Status
colourGreen
titleworking

...

As soon as this webhook is executed, user key variables will be updated with the new values of $user.key variables.

...


4. updatePauseStatusForCLI - Change Break Status of a Direct Dial Agent

Status :

Status
colourYellow
titleunable to get getting null response variable

‌Usage : 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 9180680XXXXX, 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).

...

Flow Variable

Example

Description

$flow.key.cli_pause_update

true/false

The Direct Dial was successfully paused / unpaused

...

5. fetchUserPreferences

Status :

Status
colourRedGreen
titleGetting Errorworking

URL : http://192.168.160.4215:3000/centraloutboundwebhook-v1/prod/

Method : fetchUserPreferences

...

Response : All user key variables linked with contact number.

...

6. linkcreation

Status :

Status
colourBlue
titletesting remaining

...

Usage : This webhook is used to generate a personalised short URL(by appending customer’s details) for the customer for a BotChatBot.

Request :

Flow Variable

Example

Description

$flow.key.cli

9181607XXXXX

CLI number

$flow.key.botid

123

ID of Bot

$flow.key.token

Cust token of the chat bot

In this request, all other flow variable will also be send if provided.

...

Flow Variable

Example

Description

$flow.key.shortenUrl

https://s.phonon.in/BEK4YYnx

Short URL

$flow.key.botUniqueID

Unique ID of Bot

...

7. translateText

Status :

Status
colourRed
titlegetting error

URL : http://192.168.160.4215:3000/googleapiwebhook-v1/prod

...

Flow Variable

Example

Description

$flow.key.inputText

My name is John

Input text to be converted

$flow.key.sourceLang

English

Language of input text

$flow.key.targetLang

Hindi

Language in which you want to translate

$flow.key.apiKey

AIzaSyD562N7eElnnwMH6euehqJGdv5W43fOxxx

API Key of Google Account

...

Flow Variable

Example

Description

$flow.key.status

SUCCESS/FAILED

Status of webhook request

$flow.key.translatedText

Translated text

$flow.key.detectedSourceLanguage

Hindi

Source language that was detected (If any)

...

8. speechprocessing

Status :

Status
colourRed
titlegetting error

URL: http://192.168.160.4215:3000/hdfcsenseforthwebhook-v1/prod/

Method : speechprocessing

Usage : To webhook will be used to perform speech processing

...

Flow Variable

Example

Description

$flow.key.cli

9181607XXXXX

Status of webhook request

$flow.key.speechText

Good Morning

The speech text which needs to be processed

Response :

Flow Variable

Example

Description

$flow.key.status

SUCCESS/FAILURE

Status of webhook request

...

9. Pullreport

Status :

Status
colourRed
titlegetting internal server error

URL : http://192.168.50.21:3000/pullreportapiwebhook-v1/prod/

...

Response : No response configured

...

How to test internal webhooks ?

In order to test internal webhooks, you need to follow below steps -

...

Predefined Format :

Code Block
{
	"method" : "<name of method>",
	"keys" :  [
		{
			"name" : "<request variable 1>",
			"value" :  "<value of request variable 1>"
		},
		{
			"name" : "<request variable 2>",
			"value" : "<value of request variable 2>"
		} 
		//Repeate for other request variables
	]
}

Additional APIs

1. shortURL

Status :

Status
colourGreen
titleworking

‌Usage : Using this webhook, you can shorten a long URL into a short URL.

URL: https://s.phonon.in/UrlShortner/phonon/shortUrl

Method: POST

Headers:

Key

Value

Content-Type

application/json

Accept

application/json

Request:

Code Block
{	
    "custToken": "abcd1234",	
    "longUrl": "https://follow same pattern if more than 2 request parameters
]
}google.co.in"
}

custToken is static at "abcd1234"

Response:

Code Block
{  
    "shortUrl": "https://s.phonon.in/BEK4YYnx"
}

You can have your custom domain. Contact Support to help you with that.