Package com.intercom.api.resources.unstable.calls

Class CallsClient

java.lang.Object

com.intercom.api.resources.unstable.calls.CallsClient

public class CallsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
CallsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
AiCallResponse	collectFinVoiceCallByExternalId(CollectFinVoiceCallByExternalIdRequest request)	Retrieve information about a Fin Voice call using the external call identifier.
AiCallResponse	collectFinVoiceCallByExternalId(CollectFinVoiceCallByExternalIdRequest request, RequestOptions requestOptions)	Retrieve information about a Fin Voice call using the external call identifier.
AiCallResponse	collectFinVoiceCallById(CollectFinVoiceCallByIdRequest request)	Retrieve information about a Fin Voice call using the external reference ID.
AiCallResponse	collectFinVoiceCallById(CollectFinVoiceCallByIdRequest request, RequestOptions requestOptions)	Retrieve information about a Fin Voice call using the external reference ID.
Error	collectFinVoiceCallByPhoneNumber(CollectFinVoiceCallByPhoneNumberRequest request)	Retrieve information about a Fin Voice call using the phone number.
Error	collectFinVoiceCallByPhoneNumber(CollectFinVoiceCallByPhoneNumberRequest request, RequestOptions requestOptions)	Retrieve information about a Fin Voice call using the phone number.
CallList	listCalls()	Retrieve a paginated list of calls.
CallList	listCalls(ListCallsRequest request)	Retrieve a paginated list of calls.
CallList	listCalls(ListCallsRequest request, RequestOptions requestOptions)	Retrieve a paginated list of calls.
ListCallsWithTranscriptsResponse	listCallsWithTranscripts(ListCallsWithTranscriptsRequest request)	Retrieve calls by a list of conversation ids and include transcripts when available.
ListCallsWithTranscriptsResponse	listCallsWithTranscripts(ListCallsWithTranscriptsRequest request, RequestOptions requestOptions)	Retrieve calls by a list of conversation ids and include transcripts when available.
AiCallResponse	registerFinVoiceCall()	Register a Fin Voice call with Intercom.
AiCallResponse	registerFinVoiceCall(java.util.Optional<RegisterFinVoiceCallRequest> request)	Register a Fin Voice call with Intercom.
AiCallResponse	registerFinVoiceCall(java.util.Optional<RegisterFinVoiceCallRequest> request, RequestOptions requestOptions)	Register a Fin Voice call with Intercom.
Call	showCall(ShowCallRequest request)	Retrieve a single call by id.
Call	showCall(ShowCallRequest request, RequestOptions requestOptions)	Retrieve a single call by id.
void	showCallRecording(ShowCallRecordingRequest request)	Redirects to a signed URL for the call's recording if it exists.
void	showCallRecording(ShowCallRecordingRequest request, RequestOptions requestOptions)	Redirects to a signed URL for the call's recording if it exists.
java.lang.String	showCallTranscript(ShowCallTranscriptRequest request)	Returns the transcript for the specified call as a downloadable text file.
java.lang.String	showCallTranscript(ShowCallTranscriptRequest request, RequestOptions requestOptions)	Returns the transcript for the specified call as a downloadable text file.
RawCallsClient	withRawResponse()	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

CallsClient

public CallsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawCallsClient withRawResponse()

Get responses with HTTP metadata like headers

listCalls

public CallList listCalls()

Retrieve a paginated list of calls.

listCalls

public CallList listCalls(ListCallsRequest request)

Retrieve a paginated list of calls.

listCalls

public CallList listCalls(ListCallsRequest request,
                          RequestOptions requestOptions)

Retrieve a paginated list of calls.

showCall

public Call showCall(ShowCallRequest request)

Retrieve a single call by id.

showCall

public Call showCall(ShowCallRequest request,
                     RequestOptions requestOptions)

Retrieve a single call by id.

showCallRecording

public void showCallRecording(ShowCallRecordingRequest request)

Redirects to a signed URL for the call's recording if it exists.

showCallRecording

public void showCallRecording(ShowCallRecordingRequest request,
                              RequestOptions requestOptions)

Redirects to a signed URL for the call's recording if it exists.

showCallTranscript

public java.lang.String showCallTranscript(ShowCallTranscriptRequest request)

Returns the transcript for the specified call as a downloadable text file.

showCallTranscript

public java.lang.String showCallTranscript(ShowCallTranscriptRequest request,
                                           RequestOptions requestOptions)

Returns the transcript for the specified call as a downloadable text file.

listCallsWithTranscripts

public ListCallsWithTranscriptsResponse listCallsWithTranscripts(ListCallsWithTranscriptsRequest request)

Retrieve calls by a list of conversation ids and include transcripts when available. A maximum of 20 conversation_ids can be provided. If none are provided or more than 20 are provided, a 400 error is returned.

listCallsWithTranscripts

public ListCallsWithTranscriptsResponse listCallsWithTranscripts(ListCallsWithTranscriptsRequest request,
                                                                 RequestOptions requestOptions)

Retrieve calls by a list of conversation ids and include transcripts when available. A maximum of 20 conversation_ids can be provided. If none are provided or more than 20 are provided, a 400 error is returned.

registerFinVoiceCall

public AiCallResponse registerFinVoiceCall()

Register a Fin Voice call with Intercom. This endpoint creates an external reference that links an external call identifier to an Intercom call and conversation.

The call can be from different sources:

• AWS Connect (default)
• Five9
• Zoom Phone

registerFinVoiceCall

public AiCallResponse registerFinVoiceCall(java.util.Optional<RegisterFinVoiceCallRequest> request)

Register a Fin Voice call with Intercom. This endpoint creates an external reference that links an external call identifier to an Intercom call and conversation.

The call can be from different sources:

• AWS Connect (default)
• Five9
• Zoom Phone

registerFinVoiceCall

public AiCallResponse registerFinVoiceCall(java.util.Optional<RegisterFinVoiceCallRequest> request,
                                           RequestOptions requestOptions)

Register a Fin Voice call with Intercom. This endpoint creates an external reference that links an external call identifier to an Intercom call and conversation.

The call can be from different sources:

• AWS Connect (default)
• Five9
• Zoom Phone

collectFinVoiceCallById

public AiCallResponse collectFinVoiceCallById(CollectFinVoiceCallByIdRequest request)

Retrieve information about a Fin Voice call using the external reference ID.

collectFinVoiceCallById

public AiCallResponse collectFinVoiceCallById(CollectFinVoiceCallByIdRequest request,
                                              RequestOptions requestOptions)

Retrieve information about a Fin Voice call using the external reference ID.

collectFinVoiceCallByExternalId

public AiCallResponse collectFinVoiceCallByExternalId(CollectFinVoiceCallByExternalIdRequest request)

Retrieve information about a Fin Voice call using the external call identifier.

collectFinVoiceCallByExternalId

public AiCallResponse collectFinVoiceCallByExternalId(CollectFinVoiceCallByExternalIdRequest request,
                                                      RequestOptions requestOptions)

Retrieve information about a Fin Voice call using the external call identifier.

collectFinVoiceCallByPhoneNumber

public Error collectFinVoiceCallByPhoneNumber(CollectFinVoiceCallByPhoneNumberRequest request)

Retrieve information about a Fin Voice call using the phone number.

Returns the most recent matched call for the given phone number, ordered by creation date.

collectFinVoiceCallByPhoneNumber

public Error collectFinVoiceCallByPhoneNumber(CollectFinVoiceCallByPhoneNumberRequest request,
                                              RequestOptions requestOptions)

Retrieve information about a Fin Voice call using the phone number.

Returns the most recent matched call for the given phone number, ordered by creation date.