java/resources/realtime/subresources/calls/index.md +0 −162 deleted
File Deleted View Diff
1# Calls
2
3## Accept call
4
5`realtime().calls().accept(CallAcceptParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`
6
7**post** `/realtime/calls/{call_id}/accept`
8
9Accept an incoming SIP call and configure the realtime session that will
10handle it.
11
12### Parameters
13
14- `CallAcceptParams params`
15
16 - `Optional<String> callId`
17
18 - `RealtimeSessionCreateRequest realtimeSessionCreateRequest`
19
20 Realtime session object configuration.
21
22### Example
23
24```java
25package com.openai.example;
26
27import com.openai.client.OpenAIClient;
28import com.openai.client.okhttp.OpenAIOkHttpClient;
29import com.openai.models.realtime.RealtimeSessionCreateRequest;
30import com.openai.models.realtime.calls.CallAcceptParams;
31
32public final class Main {
33 private Main() {}
34
35 public static void main(String[] args) {
36 OpenAIClient client = OpenAIOkHttpClient.fromEnv();
37
38 CallAcceptParams params = CallAcceptParams.builder()
39 .callId("call_id")
40 .realtimeSessionCreateRequest(RealtimeSessionCreateRequest.builder().build())
41 .build();
42 client.realtime().calls().accept(params);
43 }
44}
45```
46
47## Hang up call
48
49`realtime().calls().hangup(CallHangupParamsparams = CallHangupParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`
50
51**post** `/realtime/calls/{call_id}/hangup`
52
53End an active Realtime API call, whether it was initiated over SIP or
54WebRTC.
55
56### Parameters
57
58- `CallHangupParams params`
59
60 - `Optional<String> callId`
61
62### Example
63
64```java
65package com.openai.example;
66
67import com.openai.client.OpenAIClient;
68import com.openai.client.okhttp.OpenAIOkHttpClient;
69import com.openai.models.realtime.calls.CallHangupParams;
70
71public final class Main {
72 private Main() {}
73
74 public static void main(String[] args) {
75 OpenAIClient client = OpenAIOkHttpClient.fromEnv();
76
77 client.realtime().calls().hangup("call_id");
78 }
79}
80```
81
82## Refer call
83
84`realtime().calls().refer(CallReferParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`
85
86**post** `/realtime/calls/{call_id}/refer`
87
88Transfer an active SIP call to a new destination using the SIP REFER verb.
89
90### Parameters
91
92- `CallReferParams params`
93
94 - `Optional<String> callId`
95
96 - `String targetUri`
97
98 URI that should appear in the SIP Refer-To header. Supports values like
99 `tel:+14155550123` or `sip:agent@example.com`.
100
101### Example
102
103```java
104package com.openai.example;
105
106import com.openai.client.OpenAIClient;
107import com.openai.client.okhttp.OpenAIOkHttpClient;
108import com.openai.models.realtime.calls.CallReferParams;
109
110public final class Main {
111 private Main() {}
112
113 public static void main(String[] args) {
114 OpenAIClient client = OpenAIOkHttpClient.fromEnv();
115
116 CallReferParams params = CallReferParams.builder()
117 .callId("call_id")
118 .targetUri("tel:+14155550123")
119 .build();
120 client.realtime().calls().refer(params);
121 }
122}
123```
124
125## Reject call
126
127`realtime().calls().reject(CallRejectParamsparams = CallRejectParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`
128
129**post** `/realtime/calls/{call_id}/reject`
130
131Decline an incoming SIP call by returning a SIP status code to the caller.
132
133### Parameters
134
135- `CallRejectParams params`
136
137 - `Optional<String> callId`
138
139 - `Optional<Long> statusCode`
140
141 SIP response code to send back to the caller. Defaults to `603` (Decline)
142 when omitted.
143
144### Example
145
146```java
147package com.openai.example;
148
149import com.openai.client.OpenAIClient;
150import com.openai.client.okhttp.OpenAIOkHttpClient;
151import com.openai.models.realtime.calls.CallRejectParams;
152
153public final class Main {
154 private Main() {}
155
156 public static void main(String[] args) {
157 OpenAIClient client = OpenAIOkHttpClient.fromEnv();
158
159 client.realtime().calls().reject("call_id");
160 }
161}
162```