Documentation Index
Fetch the complete documentation index at: https://doc.rapida.ai/llms.txt
Use this file to discover all available pages before exploring further.
Creates an outbound phone call to the specified number using your configured assistant.
Parameters
Configuration for the client connection.
request
CreatePhoneCallRequest
required
assistant
AssistantDefinition
required
AssistantID which will be used.
Destination phone number in E.164 format (for example, +14155550123).
Caller ID phone number to originate the call from (E.164 format). If omitted, the system default will be used.
args
Map<string, google_protobuf_any_pb.Any>
Additional arguments passed to the call as a key-value map.
options
Map<string, google_protobuf_any_pb.Any>
Call options for runtime behavior and configuration.
metadata
Map<string, google_protobuf_any_pb.Any>
Arbitrary metadata to associate with the call for tracking and analytics.
Usage
import {
ConnectionConfig,
CreatePhoneCall,
AssistantDefinition,
CreatePhoneCallRequest,
} from '@rapidaai/react';
const phoneCallRequest = new CreatePhoneCallRequest();
const assistant = new AssistantDefinition();
assistant.setAssistantid("ASSISTANT_ID");
assistant.setVersion('latest');
phoneCallRequest.setAssistant(assistant);
phoneCallRequest.setFromnumber('FROM_NUMBER');
phoneCallRequest.setTonumber("TO_NUMBER");
let connectionCfg = ConnectionConfig.DefaultConnectionConfig(
ConnectionConfig.WithPersonalToken({
Authorization: token,
AuthId: authId,
ProjectId: projectId,
}),
);
CreatePhoneCall(connectionCfg, phoneCallRequest)
.then(x => {
console.log(x);
if (x.getSuccess()) {
return;
}
let err = x.getError();
if (err?.getHumanmessage()) setError(err?.getHumanmessage());
})
.catch(x => {
console.dir(x);
});
Response
Numeric status code for the operation
Indicates whether the operation was successful
Stable, machine-readable numeric code. Represented as a string in JS/TS; parse only if you need numeric comparisons.
Developer-oriented message with diagnostic details. Avoid showing directly to end-users.
Human-friendly description safe for display to end-users. Localize in your app if needed.
Unique identifier for the conversation instance.
Identifier for the Assistant associated with this conversation.
Project ID associated with this conversation.
Organization ID related to the conversation.
Source of the conversation (e.g., “phone-call”).
Identifier for the assistant provider model used in the conversation.
Unique identifier string for tracking this conversation.
Indicates the current status of the conversation (e.g., “ACTIVE”).
createdDate
google.protobuf.Timestamp
Timestamp indicating when the conversation was created.
updatedDate
google.protobuf.Timestamp
Timestamp indicating the last update to the conversation.
Metadata key (e.g., “talk.outgoing_api_response”, “talk.client”).
Metadata value, often a JSON string containing detailed data (e.g., account details, client information).
