Push Data

Author: Salman Pathan 326 views

Purpose:

This function is used to push customer data to Jodo Application.
If Media is voice & contact Number is valid, data push for dialing.

Pre-requisite for TTS
Status :: 10500 → After TTS covert, status changed to 1001
TTS web hook need to map with Process + Data Import event
TTS Web Hook :: Commercial service and need separate subscription.

Use Cases:

Initiate and handle customer call from CRM / Business Application screen:

Start Call in Jodo Platform for specific contact data on click (or as a background trigger) by CRM / Business application.
This can also be used in case of Click-to-call campaigns across multiple media.

Incoming calls screen-pop as response to multi-media campaigns from external platforms (mostly useful in Marketing Automation driven SMS / Email Marketing Campaigns)

External platform can use API to send customer data into Jodo Call guide before scheduled campaign time and agents will get a screen pop-up in Jodo Call Guide.

Make Multi-lingual calls using Automated voice (Engineered voice) via Text to Speech Engine

(Jodo Messenger Dialer integrated with Cloud TTS Service. E.g., Google / Amazon etc.)

  • In this case Jodo receives Customer First Name & Last Name via Push API in real-time.
  • Jodo pushes data to target TTS Engine API. (User defined in configuration)
  • After TTS API response received, Jodo dials contact number passed in request and start interactive message flow at scheduled time.

User Input Parameters:

NodeM/OData type sizeValueDescription
MethodMTextImportProcessDataUnique Command for JSON Request. (This method value cannot be changed)
apikeyMTexttest_orgUnique key mapped to an organisation. (API key will change according to client organisation)
servicekeyMTextVoiceProcessUnique key mapped to the voice media process. (Service key will change according to client process)
MediaMText11Media for the received data. (e.g., 1=Email In (Incoming / received email) 2=Email Out (Outgoing / Sent email) 3=SMS In (Incoming / received SMS) 4=SMS Out (Outgoing / Sent SMS) 8=Chat (Website / messenger Chat conversation) 11=Voice In (Incoming / received Voice Call / session) 12=Voice Out (outgoing / Sent Voice call / session) 21=Social Media – Twitter channel 22=Social Media -Facebook channel 31=Video Refer table below for Media Information values
DataMText[ { “leadnumber”:”1″ “name”:”Ram” “mobilenumber”:”1234567890″ “emailid”:”v@avhan.com” “callDateTime”:”2018-06-20 09:07:00″ “calltype”:”71″ “dateofleadcreation”:”2012-02-22″ “timeofleadcreation”:”12:00:00″ “extrafield1″:”1” “extrafield2″:”2” “extrafield3″:”3” }, { “leadnumber”:”2″ “name”:”abc” “mobilenumber”:”1234567891″ “emailid”:”v1@avhan.com” “callDateTime”:”2018-06-20 09:07:00″ “calltype”:”41″ “dateofleadcreation”:”2012-02-22″ “timeofleadcreation”:”12:00:00″ “extrafield1″:”11” “extrafield2″:”21” “extrafield3″:”31” } ]Customer data in JSON Array (Needs mobile number, name, email ID).
updateparamMTextMobilenumber / customercode / crmuniquefieldThe parameter used for data check to update and insert data. (like Mobile number or Customer code or CRM unique field)
reqdatetimeMText2018-11-12 14:00:05Date and Time of the request. (Date format: YYYY-MM-DD hh:mm:ss)
CallDateTimeO2018-11-12 14:00:05Date and Time of the request. (Date format: YYYY-MM-DD hh:mm:ss)
CalltypeO5Refer table below for call type values
userloginOtest@avha.comValid login ID that exists in Jodo Platform

Multiple trunks handle prefix for domestic and international calling differently and based on the Trunks used in your operations you will need to standardise the data in your applications with the appropriate prefix.
e.g., GSM trunks / Gateways can process + for international dialing as a prefix while TELCO trunks need you to assign 00 as prefix for international dialing. Similarly domestic dialing code prefix may be different in parts of the world.

Developer should replace + with dialing prefix based on trunk configuration

Output Parameters:

NodeValueDescription
methodReallocatedataUnique Command for JSON Response
resdatetime2018-11-12 14:00:05Date and Time of the response. (Date format: YYYY-MM-DD hh:mm:ss)
status001Refer the status parameter table
statusdescsuccessstatus parameter description

Return Value:
This API returns one of responses listed below in JSON format.

Request with updateparam mobilenumber:

				
					{
"method":"ImportProcessData",
"reqdatetime":"2018-11-12 14:00:05",
"servicekey":"VoiceProcess",
"apikey":"test_org",
"media":"11",
"updateparam":"mobilenumber",
"data"
[

{ "fname":"suvarna", "lname":"gadakh",
"mobilenumber":"00918452892308",
"extra_params":"xyz",
"call_type":"5"},
{ "fname":"suvarna", "lname":"gadakh",
"mobilenumber":"00918452892308",
"extra_params":"xyz",
"call_type":"5"}

]
}
				
			

Request with updateparam  customercode:

				
					{
"method":"ImportProcessData",
"reqdatetime":"2018-11-12 14:00:05",
"servicekey":"process1",
"apikey":"MsQgi5/gKVZusW5XziRf76nHbn9JxU4VDSWwongD5dU=",
"media":"11",
"updateparam":"customercode",
"data"
[
{
"leadnumber":"1"
"customercode":"1"
"name":"Ram",
"mobilenumber":"1234567890"
"emailid":"v@avhan.com"
},
{
"leadnumber":"2"
"customercode":"2"
"name":"abc"
"mobilenumber":"1234567891"
"emailid":"v1@avhan.com"
}
]
}
				
			

Request with updateparam crmuniquefield:

				
					{
"method":"ImportProcessData",
"reqdatetime":"2018-11-12 14:00:05",
"servicekey":"process1",
"apikey":"MsQgi5/gKVZusW5XziRf76nHbn9JxU4VDSWwongD5dU=",
"media":"11",
"updateparam":"crmuniquefield",
"data"
[
{
"leadnumber":"1",
"customercode":"1",
"name":"Ram",
"mobilenumber":"1234567890",
"emailid":"v@avhan.com",
"callDateTime":"2018-06-20 09:07:00",
"calltype":"71",

},
{
"leadnumber":"2",
"customercode":"2",
"name":"abc",
"mobilenumber":"1234567891",
"emailid":"v1@avhan.com",
"callDateTime":"2018-06-20 09:07:00",
"calltype":"41",

}
]
}
				
			

ImportProcessData JSON Response

				
					{
"method":"ImportProcessData",
"resdatetime":"2018-11-12 14:00:05",
"statuscode":"001",
"statusdesc":"success"
}
				
			

ImportProcessData JSON Fail Response

				
					{
"method":”ImportProcessData”,
"revisionno":"1",
"status":5,
"statusdesc":"fail",
"resdatetime":"2018-11-12 14:00:05"
}
				
			

Status Code Information

StatusStatus Description
01Success
14Customer data not found
15Date range not proper
16Invalid To Date format
17Invalid Media
18Media Not found
19Media Found blank
24Update Parameter not found
25Update Parameter blank
26Invalid Update Parameter

CALL Type Code Information

Call TypeCall Type Description
5Hot Lead
21Callback Call
31Preview Callback Call
41General call back
71Preview Call
1001Fresh Call

Media type:

Media IdMedia Information
1Email In
2Email Out
3SMS In
4SMS Out
8Chat
11Voice In
12Voice Out
21Social-Twitter
22Social-Facebook
31Video