Call
| Field | Description |
|---|---|
| sid string | Customer SID is used to identify customer accounts in Universally Unique Identifier (UUID) format. |
| call_flow_app string | The call_flow_app field represents the identifier of the call flow application. |
| destination_type string | The destination_type field represents the type of destination for the call. |
| destination string | The destination field represents the destination address for the call. |
| when string or integer | The "when" field represents the time when the call should be initiated. It can be either a string "now" if you want to immediately start the call, or a Unix timestamp if you want to schedule the call in the future. If the value is a Unix timestamp, it should be a future timestamp, at least 1 minute ahead of the current time. |
| max_attempts integer | The max_attempts field represents the maximum number of attempts for the call. It is an optional field, but if present, it should be an integer value between 1 and 10. If max_attempts is not present, we assume that the value is 1, which means no retries if call was failed for any reason. |
| retry_after string | The retry_after field represents the time to wait before retrying the call. It should be in the format of a positive number followed by "s" for seconds, "m" for minutes, or "h" for hours (e.g., "1m", "5s", "2h"). Only required if max_attempts’s value was higher than 1 |
| working_hours boolean | The working_hours field represents whether the call should be initiated during working hours. |
| call_status_endpoint string | should be used if you want to provide your call status endpoint |