Plum DEV Documentation
plumdevguide:outbounddevguide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
plumdevguide:outbounddevguide [2018/04/27 11:00]
admin [Programming Notes]
plumdevguide:outbounddevguide [2018/07/27 10:46] (current)
admin
Line 63: Line 63:
   -  When an outbound channel on the VoiceXML systems becomes available and your call is at the top of the queue, the call is placed.   -  When an outbound channel on the VoiceXML systems becomes available and your call is at the top of the queue, the call is placed.
   -  The call is connected successfully and the callee type detection begins (if enabled).   -  The call is connected successfully and the callee type detection begins (if enabled).
-  -  The result of the callee type detection as well as all the parameters defined in the Outbound API (i.e. phone_number,​ message_reference,​ call_parameters) are posted to your start_url.+  -  The parameters defined in the Outbound API (i.e. phone_number,​ message_reference,​ call_parameters) are posted to your start_url.
   -  A standard VoiceXML session continues from here.   -  A standard VoiceXML session continues from here.
   -  The call completes, all VXML execution is completed.   -  The call completes, all VXML execution is completed.
Line 81: Line 81:
 **queuecalls.php** operates similarly except a list of phone numbers to be dialed is uploaded to the Plum outbound web service. **queuecalls.php** operates similarly except a list of phone numbers to be dialed is uploaded to the Plum outbound web service.
  
-NOTE: If an outbound campaign has too many calls to place and these calls don't all go out, steps 3-5 for "​Outbound process for an unsuccessful call" do not occur. However, result_url does get called since the outbound platform clears the expired calls and performs the callback. In this case, the posted callee_type that gets returned to result_url is an empty string.+NOTE: If an outbound campaign has too many calls to place and these calls don't all go out, steps 3-5 for "​Outbound process for an unsuccessful call" do not occur. However, result_url does get called since the outbound platform clears the expired calls and performs the callback.
  
 ====Interface Specifications==== ====Interface Specifications====
Line 215: Line 215:
 ^Parameter^Type^Description^ ^Parameter^Type^Description^
 |phone_number|int|dialed phone number| |phone_number|int|dialed phone number|
-|callee_type|string|on success: voice, answeringmachine| 
 |call_id|int|plum outbound assigned call identifier| |call_id|int|plum outbound assigned call identifier|
 |message_reference|string|client assigned call identifier| |message_reference|string|client assigned call identifier|
Line 237: Line 236:
 |call_id|int|plum outbound assigned call identifier| |call_id|int|plum outbound assigned call identifier|
 |result|string|completed,​failed| |result|string|completed,​failed|
-|callee_type|string|on completed: voice,​answeringmachine,​faxmachine \\  on failed: busy,​noanswer,​informationtone| 
 |attempts|int|number of attempts made| |attempts|int|number of attempts made|
 |last_attempt_timestamp|time|last call attempt start time (Mon, 19 Jul 2004 13:46:03 -0400)| |last_attempt_timestamp|time|last call attempt start time (Mon, 19 Jul 2004 13:46:03 -0400)|
Line 246: Line 244:
 The **result_url** should return acknowledgment of the receipt of the call result, by returning the text "​completed"​. The **result_url** should return acknowledgment of the receipt of the call result, by returning the text "​completed"​.
  
-NOTE: If an outbound campaign has too many calls to place and these calls don't all go out, steps 3-5 for "​Outbound process for an unsuccessful call" do not occur. However, result_url does get called since the outbound platform clears the expired calls and performs the callback. In this case, the posted callee_type that gets returned to result_url is an empty string+NOTE: If an outbound campaign has too many calls to place and these calls don't all go out, steps 3-5 for "​Outbound process for an unsuccessful call" do not occur. However, result_url does get called since the outbound platform clears the expired calls and performs the callback.
  
 ====Programming Notes==== ====Programming Notes====
Line 280: Line 278:
  <​prompt>​Hello! This is a call from Company X Y Z. Please press any key to accept this call.</​prompt>​  <​prompt>​Hello! This is a call from Company X Y Z. Please press any key to accept this call.</​prompt>​
  <​filled>​  <​filled>​
- <if cond="​input$.termchar">​ + <if cond="​input$.termchar ​== null">​ 
- <goto next="#voice"/>+ <throw event="noinput"/>
  </​if>​  </​if>​
- <throw event="noinput"/>+ <goto next="#voice"/>
  </​filled>​  </​filled>​
  <​noinput>​  <​noinput>​
- <if cond="​session.connection.callee_type == '​answeringmachine'"​/>+ <if cond="​session.connection.callee_type == '​answeringmachine'">​
  <​goto next="#​answeringmachine"/>​  <​goto next="#​answeringmachine"/>​
  <​elseif cond="​session.connection.callee_type == '​fax'"/>​  <​elseif cond="​session.connection.callee_type == '​fax'"/>​
Line 293: Line 291:
  <​goto next="#​voice"/>​  <​goto next="#​voice"/>​
  </​noinput>​  </​noinput>​
- </field>+ </record>
  </​form>​  </​form>​
  <form id="​answeringmachine">​  <form id="​answeringmachine">​