Class CallReferParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
public final class CallReferParams implements Params
Transfer an active SIP call to a new destination using the SIP REFER verb.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classCallReferParams.BuilderA builder for CallReferParams.
public final classCallReferParams.BodyParameters required to transfer a SIP call to a new destination using the Realtime API.
-
Method Summary
Modifier and Type Method Description final Optional<String>callId()final StringtargetUri()URI that should appear in the SIP Refer-To header. final JsonField<String>_targetUri()Returns the raw JSON value of targetUri. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final CallReferParams.BuildertoBuilder()final CallReferParams.Body_body()final String_pathParam(Integer index)Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static CallReferParams.Builderbuilder()Returns a mutable builder for constructing an instance of CallReferParams. -
-
Method Detail
-
targetUri
final String targetUri()
URI that should appear in the SIP Refer-To header. Supports values like
tel:+14155550123orsip:[email protected].
-
_targetUri
final JsonField<String> _targetUri()
Returns the raw JSON value of targetUri.
Unlike targetUri, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final CallReferParams.Builder toBuilder()
-
_body
final CallReferParams.Body _body()
-
_pathParam
final String _pathParam(Integer index)
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static CallReferParams.Builder builder()
Returns a mutable builder for constructing an instance of CallReferParams.
The following fields are required:
.targetUri()
-
-
-
-