Calls

Accept call

realtime().calls().accept(CallAcceptParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

post /realtime/calls/{call_id}/accept

Accept an incoming SIP call and configure the realtime session that will handle it.

Parameters

• CallAcceptParams params

  • Optional<String> callId

  • RealtimeSessionCreateRequest realtimeSessionCreateRequest

    Realtime session object configuration.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.realtime.RealtimeSessionCreateRequest;
import com.openai.models.realtime.calls.CallAcceptParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        CallAcceptParams params = CallAcceptParams.builder()
            .callId("call_id")
            .realtimeSessionCreateRequest(RealtimeSessionCreateRequest.builder().build())
            .build();
        client.realtime().calls().accept(params);
    }
}

Hang up call

realtime().calls().hangup(CallHangupParamsparams = CallHangupParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

post /realtime/calls/{call_id}/hangup

End an active Realtime API call, whether it was initiated over SIP or WebRTC.

Parameters

• CallHangupParams params

  • Optional<String> callId

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.realtime.calls.CallHangupParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        client.realtime().calls().hangup("call_id");
    }
}

Refer call

realtime().calls().refer(CallReferParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

post /realtime/calls/{call_id}/refer

Transfer an active SIP call to a new destination using the SIP REFER verb.

Parameters

• CallReferParams params

  • Optional<String> callId

  • String targetUri

    URI that should appear in the SIP Refer-To header. Supports values like tel:+14155550123 or sip:agent@example.com.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.realtime.calls.CallReferParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        CallReferParams params = CallReferParams.builder()
            .callId("call_id")
            .targetUri("tel:+14155550123")
            .build();
        client.realtime().calls().refer(params);
    }
}

Reject call

realtime().calls().reject(CallRejectParamsparams = CallRejectParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

post /realtime/calls/{call_id}/reject

Decline an incoming SIP call by returning a SIP status code to the caller.

Parameters

• CallRejectParams params

  • Optional<String> callId

  • Optional<Long> statusCode

    SIP response code to send back to the caller. Defaults to 603 (Decline) when omitted.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.realtime.calls.CallRejectParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        client.realtime().calls().reject("call_id");
    }
}