6 External IVR. All rights reserved to Voicenter Revision

Transcription

1 External IVR

2 . External IVR.. Method name: GET_IVR_ACTION This method s request is sent by voicenter server to a designated URL on the client s server, with the incoming call details: IVR_MENU REQUEST: Field name Description Type Remarks CALLER_ID Caller ID String CALLER_NAME Caller name String DID The number called String MENU Client s menu identifier String will be "-" at the beginning of the call PREVIOUS_MENU Client s menu identifier String will be "-" at the beginning of the call DTMF The DTMF the caller pressed String IVR_UNIQUE_ID A unique ID for the incoming call String IVR_UNIQUE_ID A unique ID for the incoming call String chars long EXAMPLES Xml-rpc: <?xml version=.0 encoding= utf-?> <methodcall> <methodname>get_ivr_action</methodname> <params> <param> <name>did</name> <string> </string> <name>caller_id</name> <string> </string> <name>caller_name</name> < string />שלום< string > <name>ivr_unique_id</name> <string>cedf0fcdeddf dx</string>

3 0 0 <name>dtmf</name> <string/> <name>menu</name> <string>-</string> <name>previous_menu</name> <string>-</string> </param> </params> </methodcall> JSON: 0 { METHOD: "GET_IVR_ACTION", DATA: { DID: "0", CALLER_ID: "nzxca", CALLER_NAME: "nzxca", IVR_UNIQUE_ID: "bcdfad0f", DTMF: "", MENU: "-", PREVIOUS_MENU: "-" IVR_MENU REQUEST: Field name Description Type Appearance STATUS 0 OK Integer Mandatory - Error ACTION One of the following options in the next table: String Mandatory MENU CALL HANGUP SAYDIGITS VO SILENTRECORD LANGUAGE he String Mandatory en DATA Structure contains relevant data of : MENU / CALL / HANGUP /. Structure Mandatory

4 Action options MENU - another IVR menu Field name Description Type Apearence REC The file name of the record to play String Mandatory LOOP The number of times to loop-play the record Integer Mandatory DELAY The number of seconds to wait between each loop Integer Mandatory SIZE The Maximum number of digits from the caller Integer Mandatory MENU Client s menu identifier String Mandatory VALIDATION DTMF input validation Integer Mandatory validation 0 no validation CALL - Dial and connect any destination world wide TARGET The destination to call String Mandatory CALLERID The Caller number Shown to the destination String Mandatory CALLERNAME The Caller name Shown to the destination String Mandatory CALLER_REC The record the caller will hear before dialing destination String Optional MOH_CLASS The music class heard while dialing a destination String Optional TARGET_REC The record the target will hear before connecting to the caller String Optional TARGET_REC The record the target will hear before connecting to the caller String Optional CALL_MAX_DIAL Maximum time in seconds to wait while dialing Integer Mandatory CALL_MAX Maximum duration in seconds for the call Integer Mandatory NEXT_MENU Next menu the call will be redirected to in case of call failure String Optional. If Empty call will be disconnected. NEXT_MENU_RECORD The name of the record of the menu the call will redirected to String Optional in case of call failure NEXT_MENU_LOOP The number of times to loop-play the record of the next menu Integer Optional NEXT_MENU_SIZE The Maximum number of digits from the caller Integer Optional NEXT_MENU_WAIT The number of seconds to wait between each loop, in the next Integer Optional menu REC_STATUS 0 Don't record Integer Mandatory Record call DTMF_PLAY After the called party answers, send digits as a DTMF stream String Optional DIALSTRINGS Array of ready dialstrings for dial Array Optional SAYDIGITS Say gigits REC The file name of the record to play String Mandatory LOOP The number of times to loop-play the record Integer Mandatory DELAY The number of seconds to wait between each loop Integer Mandatory SIZE The Maximum number of digits from the caller Integer Mandatory MENU Client's menu identifier String Mandatory VALIDATION DTMF input validation Integer Mandatory validation 0 no validation SAYDIGITSRECORD Record to play before DIGITS String Mandatory DIGITS DIGITS to play Pay attention to string type! Do not use integer type to prevent zero loose in zero leading numbers like 0. Any characters other than numbers will be ignored. Mandatory

5 SILENTRECORD Answer the call & record it Field name Description Type Apearence REC The file name of the record to play before recording starts String Optioinal MAXDURATION Maximum call duration Integer Optioinal VO go to IVR layer LAYER Layer number to go to Integer Mandatory RECORD Record to play String Mandatory LOOP The number of times to loop-play the record Integer Mandatory DELAY The number of seconds to wait between each loop Integer Mandatory HANGUP - Hang up the call HANGUP_REC The "good bye" message before hangup. String Optional HANGUP_CAUSE Cause of the hangup Integer Optional HANGUP CALL EXAMPLE Xml-rpc: <?xml version=".0" encoding="utf-"?> <methodresponse> <params> <param> <name>status</name> <int>0</int> <name>language</name> <string>he</string> <name>action</name> <string>hangup</string> <name>data</name> <name>hangup_rec</name> <string>blank</string> <name>hangup_cause</name> 0

6 0 <int></int> </param> </params> </methodresponse> JSON: { "STATUS" : 0, "ACTION" : "HANGUP", "LANGUAGE" : "HE", "DATA" : { "HANGUP_REC":"blank", "HANGUP_CAUSE": CALL EXAMPLE Xml-rpc: 0 0 <?xml version=".0" encoding="utf-"?> <methodresponse> <params> <param> <name>status</name> <int>0</int> <name>language</name> <string>he</string> <name>action</name> <string>call</string>

7 <name>data</name> <name>target</name> <string>00</string> <name>callerid</name> <string>unknown</string> <name>callername</name> <string>לארשי</string> <name>caller_rec</name> <string>now_calling</string> <name>moh_class</name> <string>californication</string> <name>target_rec</name> <string>blank</string> <name>call_max_dial</name> <int></int> <name>call_max</name> <int>00</int> <name>next_menu</name> <string>some-menu</string> <name>next_menu_record</name> <string>record-filename</string>

8 <name>next_menu_loop</name> <string></string> <name>next_menu_wait</name> <string></string> <name>next_menu_size</name> <string></string> <name>rec_status</name> <string></string> <name>dtmf_play</name> <string> </string> <name>dialstrings</name> <array> <data> SIP/000000@provider SIP/000000@provider </data> </array> </param> </params> </methodresponse>

9 JSON: 0 0 { "STATUS": 0, "ACTION": "CALL", "LANGUAGE" : "HE", "DATA": { "TARGET": "00", "CALLERID": " ", "CALLERNAME": "", "CALLER_REC": "rec", "MOH_CLASS": "musiconhold", "TARGET_REC": "", "CALL_MAX_DIAL": "", "CALL_MAX": "00", "NEXT_MENU": "", "NEXT_MENU_RECORD": "rec", "NEXT_MENU_LOOP":, "NEXT_MENU_SIZE":, "NEXT_MENU_WAIT":, "REC_STATUS": "0", "DTMF_PLAY": "", "DIALSTRINGS : [ SIP/000000@provider", "SIP/000000@provider" ] MENU EXAMPLE Xml-rpc: 0 0 <?xml version=".0" encoding="utf-"?> <methodresponse> <params> <param> <name>status</name> <int>0</int> <name>action</name> <string>menu</string> <name>language</name> <string>he</string> <name>data</name>

10 <name>rec</name> <string>record_filename</string> <name>loop</name> <int></int> <name>delay</name> <int></int> <name>size</name> <int></int> <name>menu</name> <string>menu_name</string> <name>validation</name> <int></int> </param> </params> </methodresponse> JSON: 0 { "STATUS" : 0, "ACTION" : "MENU", "LANGUAGE" : "HE", "DATA" : { "REC":"record", "LOOP":, "DELAY":, "SIZE":, "MENU": "menu", "VALIDATION": 0

11 SAYDIGITS EXAMPLE Xml-rpc: <?xml version=".0" encoding="utf-"?> <methodresponse> <params> <param> <name>status</name> <int>0</int> <name>action</name> <string>saydigits</string> <name>language</name> <string>he</string> <name>data</name> <name>rec</name> <string>record_filename</string> <name>loop</name> <int></int> <name>delay</name> <int></int> <name>size</name> <int></int> <name>menu</name> <string>menu_name</string>

12 0 0 0 <name>validation</name> <int></int> <name>saydigitsrecord</name> <string>blank</string> <name>digits</name> <string></string> </param> </params> </methodresponse> JSON: 0 { "STATUS" : 0, "ACTION" : " SAYDIGITS ", "LANGUAGE" : "HE", "DATA" : { "REC":"record", "LOOP":, "DELAY":, "SIZE":, "MENU": "menu", "VALIDATION": 0, "VALIDATION": "SAYDIGITSRECORD", "VALIDATION": "DIGITS"

13 .. Method name: HANGUP_CALL This method request is sent by voicenter server to report the client server at an end of a call. HANGUP_CALL REQUEST: Field name Description Type Example CALLER_ID Caller ID String 0 DID The number called String 0 IVR_UNIQUE_ID A unique ID for the incoming call String aohsrrfiebjumnpiodfjgf TARGET The destination of the call String 00 CALL_TIME_EPOCH Hour and date of the call in Linux EPOCH Integer CALL_START_EPOCH Hour and date of the call flow start in Linux EPOCH IVR_UNIQUE_ID A unique ID for the incoming call String Integer CALL_DURATION Total call duration in seconds Integer CALL_DAILTIME Dialing time until destination answered in seconds Integer CALL_STATUS Status of the call String ANSWERED CALL_STATUS options: ANSWER: Call is answered. A successful dial. The caller reached the callee. BUSY: Busy signal. The dial command reached its number but the number is busy. NOANSWER: No answer. The dial command reached its number, the number rang for too long, then the dial timed out. CANCEL: Call is cancelled. The dial command reached its number but the caller hung up before the callee picked up. CONGESTION: Congestion. This status is usually a sign that the dialled number is not recognised. CHANUNAVAIL: Channel unavailable. On SIP, peer may not be registered. DONTCALL: Privacy mode, callee rejected the call TORTURE: Privacy mode, callee chose to send caller to torture menu INVALIDARGS: Error parsing Dial command arguments

14 SIP RFC error codes Definition SIP Equivalent Cause code (ISUP) Unallocated (unassigned) number 0 Not Found no route to network 0 Not found no route to destination 0 Not found normal call clearing BYE or CANCEL (*) user busy Busy here no user responding 0 Request Timeout no answer from the user 0 Temporarily unavailable subscriber absent 0 Temporarily unavailable 0 call rejected 0 Forbidden (+) number changed (w/o diagnostic) 0 Gone number changed (w/ diagnostic) 0 Moved Permanently redirection to new destination 0 Gone non-selected user clearing 0 Not Found (=) destination out of order 0 Bad Gateway address incomplete Address incomplete facility rejected 0 Not implemented normal unspecified 0 Temporarily unavailable no circuit available 0 Service unavailable network out of order 0 Service unavailable temporary failure 0 Service unavailable switching equipment congestion 0 Service unavailable resource unavailable 0 Service unavailable incoming calls barred within CUG 0 Forbidden bearer capability not authorized 0 Forbidden bearer capability not presently 0 Service unavailable bearer capability not implemented Not Acceptable Here only restricted digital avail Not Acceptable Here 0 service or option not implemented 0 Not implemented user not member of CUG 0 Forbidden incompatible destination 0 Service unavailable recovery of timer expiry 0 Gateway timeout 0 protocol error 00 Server internal error interworking unspecified 00 Server internal error HANGUP_CALL REQUEST: Field name Description Type Mandatory STATUS 0 OK Integer Mandatory - Error

15 REQUEST EXAMPLE Xml-rpc: <?xml version=".0" encoding="utf-"?> <methodcall> <methodname>hangup_call</methodname> <params> <param> <name>did</name> <string> </string> <name>caller_id</name> <string> </string> <name>ivr_unique_id</name> <string>cedf0fcdeddfdx</string> <name>target</name> <string>000000</string> <name>call_time_epoch</name> <int></int> <name>call_start_epoch</name> <int></int> <name>call_duration</name> <int></int> <name>call_dailtime</name> <int></int> 0

16 0 <name>call_status</name> <string>answered</string> </param> </params> </methodcall> JSON: 0 { "METHOD" : "HANGUP_CALL", "DATA" : { "DID":" ", "CALLER_ID": " ", "IVR_UNIQUE_ID": "cedf0fcdeddfdx", "TARGET": "000000", "CALL_TIME_EPOCH":, "CALL_START_EPOCH":, "CALL_DURATION": 0, "CALL_DAILTIME":, "CALL_STATUS": "ANSWERED" RESPONSE EXAMPLE Xml-rpc: 0 <?xml version=".0" encoding="utf-"?> <methodresponse> <params> <param> <name>status</name> <int>0</int> </param> </params> </methodcall> JSON: { STATUS : 0