This application is intended to ring round a specified set of destinations and play custom voice prompt.
addIVRCampaign()
Parameters:
- name - Short name of the campaign. String. Required
- description - Long description of the campaign. String
- i_ivr_prompt - The identifier of ivr_prompt to play. Integer. Required
- paused - Whether the campaign is temporarily stopped. String. Optional.
- authname - Authentication name to use while calling out. String. Required
- cli - Use this value as CLI when calling out. If not set the CLD value used as CLI. String. Optional.
- i_schedule - Optional schedule. Integer. Optional.
- max_concurrent_calls - The maximum number of concurrent calls per the campaign (default: 20) Integer. Optional.
- max_attempts - The maximum number of attempts to call each destination (default: 3). Integer. Optional.
- timeout_sec - How long to wait for destination to answer (default: 300 seconds). Integer. Optional.
- backoff_sec - The delay after unsuccessful call before next attempt (default: 600 seconds). Integer. Optional.
- threshold_msec - How long the prompt should have been playing to recognize the call as successful (default: 3000 milliseconds). Integer. Optional.
Returns:
- result - OK means that callback was initiated. String.
- i_campaign - ID of requested callback. Integer.
- XMLRPC fault in case of any error.
addCampaignPhone()
Parameters:
- i_campaign - Which campaign this phone belongs to. Integer. Required
- cld - CLD. String. Required
- finished - False when the record still in progress. Boolean. Optional.
- expires - It is NULL when the record has never been processed. The expiration date and time is contained here otherwise.
- next_call - The instant when next call attempt will take place. May be NULL which means immediately.
Returns:
- result - OK means that callback was initiated. String.
- i_campaign_phone - ID of requested callback. Integer.
- XMLRPC fault in case of any error.
addIVRPrompt()
Parameters:
- name - Short name of the prompt. String. Required
- data - Url to download the sln fileString. Required
Returns:
- result - OK means that callback was initiated. String.
- i_ivr_prompt - ID of requested callback. Integer.
- XMLRPC fault in case of any error.