Call latching description cum technical document

Format of API :

http://www.valuecallz.com/utils/sendVoice.php?cid=&tonumber=&bparty=&tts_data=&max_latch_duration=&bufferFlag=retrytime=&returnurl=  Description of parameters: 

1) Cid: Has to be provided by ValueFirst and binded with the account. It would be string

i.e. LE456CVB234RT123.

2) Tonumber: Source party number (call center number). It could be of 10 digit with

xxxxxxxxxx and 11 digits with 0xxxxxxxxxx and 12 digits with 91xxxxxxxxxx.

        3) Bparty: Destination party number (end user number). It could be of 10 to 12 digit

Number. It could be of 10 digit with xxxxxxxxxx and 11 digit with 0xxxxxxxxxx and 12

Digit with 91xxxxxxxxxx.

        4) Tts_data:  Variable data if supported by the template (comma separated -- numeric

alphanumeric and date is currently supported only). It would be string and comma separated i.e.

your

Account balance is due on, 2011-05-06 12:03:45.

       5) Max_latch_duration: Latch duration in seconds (by default 2700 seconds). And we can

Specify it to a particular limit in seconds so that call will disconnect after the Specified

Time. It would be numeric value i.e. 30.

        6) BufferFlag: If user wants to buffer the calls and wants to execute on a specified time. It

Must set to “true”. it would be string.

        7) Retrytime:  It is time to execute the buffered call (Must be encoded in YYYY-mm-dd

H: i: s format)

        8) Returnurl:   Has to be provided by client where the MIS needs to be updated at their

End.(i.e http://someIP.com/somefile)

               

The format of URL which will be pushing back to client is given below:       

http://someIP.com/somefile?

srcNo=&destNo=&status=&responseCaptured=&duration=&Credit_used=&deliveredon=&latch

ing_status_String=&latching_duration=&latching_credit_used=&lastVoiceClip=&Call_Id=&C_

Id=&triedon=&retry_count=

 This is the URL which we get from the client. The client can send us the URL up to

http://someIP.com/somefile and client can append one or more parameter to the URL.

Descriptions of the parameters for ‘returnurl’ :

1) srcNo:  Source party number(call center number) . It could be of 10 digits with

xxxxxxxxxx and 11 digits with 0xxxxxxxxxx and 12 digits with 91xxxxxxxxxx.

2) destNo:   Destination party number(end user number). It could be of 10 digits with

xxxxxxxxxx and 11 digits with 0xxxxxxxxxx and 12 digits with 91xxxxxxxxxx.

3) Status:     IVR(Interactive Voice Response) call status.

4) responseCaptured: User response captured(default NULL).it would be the value which

user enter during call flow in case of IVR. It would be numeric and dash separated i.e. 1-

3-4.

5) duration:  This parameter specifies the duration of call in Seconds. it would be numeric

i.e. 30

6) Credit_used: No of credits used during a call. In normal case 1 credit is of 30 seconds.

And in case of latching the credit is of 1.5 for 30 seconds call for both the calls. it would

be numeric i.e. 5

7) Deliveredon:  Call end time in encoded date time format. This is the time when first

party picks up the call. It would be in date time format i.e. 2011-01-03 02:23:33

8) latching_status_String: Call latching status (source party call status- destination party

call status) .it would be in hexadecimal string i.e. 0x11.

9) latching_duration:   Call latching duration (default 0). Describe the duration of call in

Seconds. It would be in date time format i.e. 2011-01-03 02:23:33

10) latching_credit_used:  Call latching credit used (1credit=1.5). It would be numeric i.e.

5.

11) lastVoiceClip: It would be string i.e. vc-1 and it is the last clip which is listened by the

end-user during the call flow. And user can perform any kind of action on the basis of the

clip. Like to send a message after the particular clip played during the call flow.

12) Call_Id:    Unique call ID same as Http API returns in response. It would be numeric i.e.

13456279.

13) C_Id:  Campaign ID same as cid. It would be string like LE456CVB234RT123

14) tried_on:  This is the time when client initiated the request. It would be in datetime

format i.e. 2011-06-07 07:34:45

15) retry_count: .It represents the nth retry and it would be numeric. Its value range

depends on the retry configuration during the creation of the campaign.

The parameters like status, responseCaptured, duration, credits_used, lastVoiceClip are used in

case of IVR (Interactive Voice Response).and the parameters like latching_status_String,

latching_credit_used, latching_duration are set in case of latching rest of the parameters are

common in both cases.

The table below specifies the sample values for returnurl parameters:

Parameter name Ivr sample value Latching sample value srcNo 91xxxxxxxxxx 91xxxxxxxxxx destNo 91xxxxxxxxxx 91xxxxxxxxxx Status 0x10 NullresponseCaptured 1-2-3 Nullduration 30(in seconds) NullCredit_used 2 NullDeliveredon Yyyy-mm-dd hh:ii:ss Nulllatching_status_String null 0x10-0x10latching_duration null 30(in seconds)latching_credit_used null 4.5Call_Id >= 8 digits >= 8 digitsC_Id 16 digit(alphanumeric) 16 digit(alphanumeric)tried_on Yyyy-mm-dd hh:ii:ss Yyyy-mm-dd hh:ii:ssretry_count 2 2lastVoiceClip vc-1 vc-1tried_on Yyyy-mm-dd hh:ii:ss Yyyy-mm-dd hh:ii:ss