Plum Fuse

Differences

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

api:outbound_queue [2010/04/08 10:46]
ted
api:outbound_queue [2010/06/13 23:10] (current)
Line 3: Line 3:
This API request is initiated with an ''POST'' to the following URL: This API request is initiated with an ''POST'' to the following URL:
-  http://synappsbeta.plumvoice.com/api/1/outbound/queue+  http://quickfuseapps.com/api/1/outbound/queue
==== Example usage ==== ==== Example usage ====
Line 10: Line 10:
<code>$ curl -u username:password -d app_id=MkyepUqu8jA -d tablekey=username:customers <code>$ curl -u username:password -d app_id=MkyepUqu8jA -d tablekey=username:customers
-  -d dial_col=phone http://synappsbeta.plumvoice.com/api/1/outbound/queue</code>+  -d dial_col=phone http://quickfuseapps.com/api/1/outbound/queue</code>
**Intermediary example**: Same as previous, except results are saved to the ''result'' column and the campaign starts at a specific time. **Intermediary example**: Same as previous, except results are saved to the ''result'' column and the campaign starts at a specific time.
Line 16: Line 16:
<code>$ curl -u username:password -d app_id=MkyepUqu8jA -d tablekey=username:customers <code>$ curl -u username:password -d app_id=MkyepUqu8jA -d tablekey=username:customers
  -d dial_col=phone -d result_col=result -d start_timestamp=1270163564   -d dial_col=phone -d result_col=result -d start_timestamp=1270163564
-  http://synappsbeta.plumvoice.com/api/1/outbound/queue</code>+  http://quickfuseapps.com/api/1/outbound/queue</code>
**Über example**: Same as previous but in addition, the campaign expires after one hour, up to three retry calls are placed every two minutes, only rows with ''%%status = 'outstanding balance'%%'' are called, and the ''name'' variable in the application is preset with the value of ''name'' in the row being called. **Über example**: Same as previous but in addition, the campaign expires after one hour, up to three retry calls are placed every two minutes, only rows with ''%%status = 'outstanding balance'%%'' are called, and the ''name'' variable in the application is preset with the value of ''name'' in the row being called.
Line 25: Line 25:
  -d "filters[]=status = 'outstanding balance'"   -d "filters[]=status = 'outstanding balance'"
  -d "params[]=name" -d "fields[]=name"   -d "params[]=name" -d "fields[]=name"
-  http://synappsbeta.plumvoice.com/api/1/outbound/queue</code>+  http://quickfuseapps.com/api/1/outbound/queue</code>
Each of these examples returns the following response if the campaign was successfully queued: Each of these examples returns the following response if the campaign was successfully queued:
Line 36: Line 36:
=== Required === === Required ===
-  * **''app_id''** //(string)// - Extract this from the URL of your application when open in the editor, looking for the ''#a='' parameter.  e.g., the ''app_id'' for the following URL is ''MkyepUqu8jA''.  <code>http://synappsbeta.plumvoice.com/app/edit#a=MkyepUqu8jA</code>+  * **''app_id''** //(string)// - Extract this from the URL of your application when open in the editor, looking for the ''#a='' parameter.  e.g., the ''app_id'' for the following URL is ''MkyepUqu8jA''.  <code>http://quickfuseapps.com/app/edit#a=MkyepUqu8jA</code>
  * **''tablekey''** //(string)// - Identifies the table to be used for the campaign.  This is in the format ''<tableowner>:<tablename>''.  It is case and whitespace sensitive.  ''<tableowner>'' is the full username of the owner of the table.  Valid table names contain only letters, numbers, and the underscore _ character.   * **''tablekey''** //(string)// - Identifies the table to be used for the campaign.  This is in the format ''<tableowner>:<tablename>''.  It is case and whitespace sensitive.  ''<tableowner>'' is the full username of the owner of the table.  Valid table names contain only letters, numbers, and the underscore _ character.
Line 44: Line 44:
=== Optional === === Optional ===
-  * **''rev_id''** //(string)// - To always use the latest revision of your app, omit this parameter or submit the string ''(latest)''.  Otherwise, extract this from the URL of the opened revision, looking for the ''r='' parameter.  e.g., the ''rev_id'' for the following URL is ''iQl''.<code>http://synappsbeta.plumvoice.com/app/edit#a=MkyepUqu8jA,r=iQl</code>+  * **''rev_id''** //(string)// - To always use the latest revision of your app, omit this parameter or submit the string ''(latest)''.  Otherwise, extract this from the URL of the opened revision, looking for the ''r='' parameter.  e.g., the ''rev_id'' for the following URL is ''iQl''.<code>http://quickfuseapps.com/app/edit#a=MkyepUqu8jA,r=iQl</code>
  * **''result_col''** //(string)// - The column where the result of each call will be saved.  To not save the result anywhere, omit this parameter.  If the field does not exist for a row, it will be created.  This //will// overwrite anything currently in the field!   * **''result_col''** //(string)// - The column where the result of each call will be saved.  To not save the result anywhere, omit this parameter.  If the field does not exist for a row, it will be created.  This //will// overwrite anything currently in the field!
api/outbound_queue.1270738010.txt.gz · Last modified: 2010/06/13 23:05 (external edit)