voice based verification (api)
TRANSCRIPT
ZipDial Mobile Solutions Pvt. Ltd. No. 63, 3rd Floor, RMZ GATEWAY, 100 Feet Road, KORAMANGALA 4TH BLOCK, Near Sony World Signal, Bangalore – 560034, India
Voice Based Verification
API to initiate Voice based verification (To be used by the customer) http://www.zipdial.com/z2cod/startTransaction.action?customerToken=<to be provided by ZipDial> &orderRefId=123456&callerPhone=7760967758&duration=300&countryCode=91 Parameter Description: 1. customerToken: This is constant configured for Customer’s account. Do not change this value 2. orderRefId: This is the Order reference Id which for the customer who has placed a verification request on Customer’s site (Mandatory) 3. callerPhone: Mobile number of the customer (Mandatory) 4. duration: time (in seconds). After x seconds ZipDial will push OBD call to the user (minimum 10 sec) 5. countryCode: Country from which the user is verifying the transaction using the mobile number. For India based users the value is 91. Sample Response on the start transaction API: {"message":"ok","order_ref_id":"123456","transaction_token":"f06339de7ffa8ea507950e0738d88474b39a6c47","status":"1"} Parameter Description: 1. message: a descriptive message confirming whether the verification Start transaction was successful or not 2. order_ref_id: This will be the value which is passed in the Start Transaction API for the parameter orderRefId 3. transaction_token: This will be a unique transaction token returned on successful verification Start transaction initiation. 4. status: 1 indicates transaction was successful, 0 indicates transaction was unsuccessful. Call Back - (This will be triggered by ZipDial) on successful verification i.e. when the user respond on OBD either accepting or rejecting the Verification A Call Back URL given by the customer will be invoked along with the below parameters. Parameters passed on the Call Back URL are: 1. transaction_token: This will be a unique transaction token returned on successful verification Start transaction initiation. (This is the value which is returned on invoking Start transaction API) 2. orderRefId: This will be the value which is passed in the Start Transaction API for the parameter orderRefId 3. orderStatus: Possible values are 0,1
ZipDial Mobile Solutions Pvt. Ltd. No. 63, 3rd Floor, RMZ GATEWAY, 100 Feet Road, KORAMANGALA 4TH BLOCK, Near Sony World Signal, Bangalore – 560034, India
0 - indicates user has not responded 1 - Indicates user has accepted the Verification Other Configuration required for Voice Based Verification: 1) Call Back URL 2) OBD Playtext 3) Confirmation SMS (if any) Error Codes: If customerToken or orderRefId or callerPhone is missing: ("message", "ERRO1: Incomplete details for verification (Require: customerToken,orderRefId,callerPhone)"); ("status", "0"); If duration is less than 0 or more than 7200 sec i.e. 2hr: ("message", "ERRO2: Duration less than zero and more than 7200 secs not supported. Please contact ZipDial Support([email protected])"); ("status", "0"); If user number is Invalid: ("message", "ERRO3: Invalid Caller Phone for verification. Please contact ZipDial Support([email protected])"); ("status", "0"); If customerToken is Invalid: ("message", "ERRO4: Invalid Customer credentials. Please contact ZipDial Support([email protected])"); ("status", "0");
Contact Information: Amit Malhotra [email protected] (E) 7760967758 (M)