apis

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
apis [2020/01/09 16:04]
127.0.0.1 external edit
apis [2020/01/22 11:34] (current)
admin
Line 76: Line 76:
 |max_attempts|int (between 1-10)|no|Total number of times to attempt calling a specific number (if previous attempts are not completed successfully).| |max_attempts|int (between 1-10)|no|Total number of times to attempt calling a specific number (if previous attempts are not completed successfully).|
 |reattempt_wait|int|no|Interval (in seconds) to wait before retrying the outbound call after a failure. This is only required when you set a //​max_attempts//​ value greater than one, which indicates additional retry attempts. Valid values range from 60 to 86400 (1 minute to 1 day)| |reattempt_wait|int|no|Interval (in seconds) to wait before retrying the outbound call after a failure. This is only required when you set a //​max_attempts//​ value greater than one, which indicates additional retry attempts. Valid values range from 60 to 86400 (1 minute to 1 day)|
-|metadata|mixed|no|JSON object of key=>​value pairs of variables and their related values for use with an application at run time.|+|metadata|mixed|no|JSON object of key=>​value pairs of variables and their related values for use with an application at run time.\\ \\ Ex: {"​first_name":"​Steve","​last_name":"​Smith"​}|
 |result_url|url|no|Callback URL to your REST service that processes the call status results when the call is completed, canceled, or all attempts have been exhausted. The POST body matches the format of the //​call_details//​ attribute from the outbound call status API response, shown [[ #​checking-status-for-an-outbound-call | here]].| |result_url|url|no|Callback URL to your REST service that processes the call status results when the call is completed, canceled, or all attempts have been exhausted. The POST body matches the format of the //​call_details//​ attribute from the outbound call status API response, shown [[ #​checking-status-for-an-outbound-call | here]].|
 |is_pci|int (0 or 1)|no|For customers who have been granted access to our HIPAA / PCI compliant secure environment setting this flag to 1 will cause connected outbound calls to execute within that secure environment.| |is_pci|int (0 or 1)|no|For customers who have been granted access to our HIPAA / PCI compliant secure environment setting this flag to 1 will cause connected outbound calls to execute within that secure environment.|
apis.txt · Last modified: 2020/01/22 11:34 by admin