Initiates a phone call. This endpoint supports multiple different ways to start a call with many fields that are mutually exclusive.
For the destination phone number either the to field or the contactId field must be provided. If a contactId is provided, the destination number will be looked up from their contact information.
For the source phone number either the from field or the numberSetId field must be provided. If the numberSetId field is used, a number will be chosen from the number set at random.
The url parameter is required and points to an InboundXML file that describes how the call should be handled. The default method for sending data is POST. If you would like to specify the method you can pass GET or POST in the urlMethod JSON object. For more information see: https://docs.ytel.com/docs/getting-started-now
The statusCallbackUrl and fallbackUrl are REST endpoints that will be contacted at the completion of the phone call. In the event that there is an error with the statusCallbackUrl, the fallbackUrl will be used.
The heartbeatCallbackUrl will be hit every 60 seconds while the call is active.
The record and recordCallbackUrl parameters dictate whether the call will be recorded. If set to true (default false) after the recording is complete a callback will be made to the url specified in recordCallbackUrl.
The ifMachine and ifMachineCallbackUrl parameters dictate what will happen if an answering machine or voice mail is detected. ifMachine may be one of hangup or continue. ifMachineCallabckUrl will be called with a callback if specified.
The timeout parameter specifies the number of seconds that will be waited for a call to be connected.
The playDtmf parameter specifies a set of dialtones to play after a call is completed. The valid values are 0-9,#,*.
The hideCallerId parameter specifies whether the callerId will be hidden. Default false.
We recommend using number sets and contacts since these will result in fewer changes over time.