Internal Webhooks

1. Validate Date and Time

...

Before you start

All internal webhooks have following structure. The method name and parameters are provided for each item.

Type:

{
	"method": "<method name. Eg: fetchUserPreferences>",
	"keys": [
		{
			"name": "$flow.key.<parameters>",
			"value": "<value to be saved>"
		},
		{
			"name": "$flow.key.cli",
			"value": "919979293198"
		}
	]
}

1. Validate Date and Time

Usage : This webhook is used when you want to check weather any date and time is correct or not , or is a holiday, a /weekend according to the configured weekdays or the date and time is valid or not etc.

URL : httphttps://192internal-webhooks.168.60.15:3000phonon.io/reliance-nippon-v1/test/

Method : ValidateDateAndTime

Request Parameters :

Response Parameters :

2. Initiate Outbound Flow

...

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

URL : httphttps://192internal-webhooks.168.50.21:3000phonon.io/centraloutboundwebhook-v1/prod/

Method : createOutbound

R‌equest Parameter :

Flow Variable	Example	Description
$flow.syskey.apiVersion	1.0	Outbound Flow Version (mostly 1.0)
$flow.syskey.securityID	<64 Character UUID>	Security ID mentioned in the outbound flow
$flow.syskey.flowID	<8 Chacter UUID>	Flow ID of outbound flow that needs to be triggered
$flow.syskey.clientID

123123123

phononio123456	Client Identifier
$flow.syskey.delayMinutes	0	When to start the Outbound Flow from current system time.
$flow.syskey.contactNumbers

91997974 6666

9181607XXXXX

Customer Numbers to which calling is to be performed

Response Parameter :

Flow Variable	Example	Description
$flow.key.obdResponseCode	200, 401 etc	Response code
$flow.key.obdReqID

<Request ID>

3417f255-e5e7-4911-a533-67bb2aaaf677	Request Id
$flow.key.obdPhononUUID

<Phonon UUID>

1b56ab0e-7760-4883-a1ef-ae8a872c8636

Phonon UUID

3. updateUserPreferences

...

GreentitleworkingUsage : 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 obsoleteOnce you have invoked this webhook, then the values of the user key variables mentioned in the API request will be updated with the new values in the system.

URL: httphttps://192internal-webhooks.168.50.21:3000phonon.io/centraloutboundwebhook-v1/prod/

Method : POST

Request Parameter :

Flow Variable	Example	Details
$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

for which the user key variables are present.
$user.key.XXXX...	Value

You can save or get any value

The user key variables which you want to update

Response Parameter :

Flow Variable	Example	Details
$flow.key.userPrefsUpdationSuccess	SUCCESS/FAILURE	Status of the request sent

...

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

...

getting null response‌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).

...

1. In the Dialer Flow, you can get the Agent CLI using $call.agent.dnis.number or for Inbound Flow =>$call.cli.number

‌URL: httphttps://192internal-webhooks.168.60.15:3000phonon.io/centraloutboundwebhook-v1/prod/

‌Method: POST

Request Parameter :

Flow Variable	Example	Description
$flow.key.pause	true	Set the Direct Dial Agent Pause Status to be true. Mandatory
$flow.key.cli	98799XXXXX	CLI of the Direct Dial Agent. With or Without Country CodeMandatory

 

Response Parameter :

Flow Variable	Example	Description
$flow.key.cli_pause_update	true/false	The Direct Dial was successfully paused / unpaused

5. fetchUserPreferences

Status : StatuscolourGreentitleworkingUsage : This webhook is used to fetch all the user key variables linked with the contact number in an account.

URL : httphttps://192internal-webhooks.168.60.15:3000phonon.io/centraloutboundwebhook-v1/prod/

Method : fetchUserPreferencesUsage : This webhook is used to fetch all the user key variables linked with the contact number.

Request Parameter :

Response Parameter : All user key variables linked with contact number.

6. linkcreation

...

titletesting remainingURL : httphttps://192internal-webhooks.168.1.42:3000phonon.io/chatbotwebhook-v1/prod

Method : linkcreation

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

Request Parameter :

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

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

Response Parameter :

Flow Variable	Example	Description
$flow.key.shortenUrl	https://s.phonon.in/BEK4YYnx	Short URL
$flow.key.botUniqueID		Unique ID of Bot

7. translateText

Status : StatuscolourRedtitlegetting errorUsage : This webhook will be used to convert the text from one language to another using Google Cloud account.

URL : httphttps://192internal-webhooks.168.60.15:3000phonon.io/googleapiwebhook-v1/prod

Method : translateTextUsage : This webhook will be used to convert the text from one language to another.

Request Parameter :

Response Parameter :

8.

...

Status :

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

Method : speechprocessing

Usage : To webhook will be used to perform speech processing

Request :

...

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 :

...

Pullreport

Usage : This webhook is used to write the details of any call record in the report at the given location.

URL : https://internal-webhooks.phonon.io/pullreportapiwebhook-v1/prod/

Method : pullreport

Usage : This webhook is used to write the details of any call record in the report at the given location.

Request Request Parameter :

Response Parameter : No response configured

9. FindLanguage

Usage : This webhook is used to find the language of the customer from where it belongs, based on their phone number.

URL : https://internal-webhooks.phonon.io/hdfcruralwebhook-v1/prod/

Method : findLanguage

Request Parameters :

Response Parameter :

...

How to test internal webhooks ?

...

1. Connect to VPN

2. Open any API Client tool, example - Postman

3. Enter the URL of internal webhook

4. Select the method as ‘POST’

5. Select ‘Body type’ as ‘JSON’

6. Enter the API request in predefined format in the ‘Body’

Predefined Format :

{
	"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

...

Greentitleworking‌Usage : Using this webhook, you can shorten a any 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://google.co.in", "domain": "phn.io" }

Note : custToken is static at "abcd1234"is unique for each customer. Domain is optional, and must be created if custom domain is required.

Response:

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

...

}

Webhook URLs and end-points :

URL : https://internal-webhooks.phonon.io