Gets paginated phone deployments for an assistant. Use user-scoped authentication because the operation requires organization and project context.
Parameters
Configuration for the client connection.
request
GetAllAssistantDeploymentRequest
required
Deployment list request.
Assistant ID for the deployments.
Pagination configuration for the request.
Number of deployments to return per page.
Optional filtering criteria to apply to the deployment search.
Value to match against the field.
Criteria logic. Accepted values: should or must.
Usage
import {
ConnectionConfig,
GetAllAssistantDeploymentRequest,
GetAllAssistantPhoneDeployment,
Paginate,
} from "@rapidaai/react";
const auth = ConnectionConfig.WithDebugger({
authorization: "AUTHORIZATION_TOKEN_PLACEHOLDER",
userId: "AUTH_ID_PLACEHOLDER",
projectId: "PROJECT_ID_PLACEHOLDER",
});
const connectionCfg = ConnectionConfig.DefaultConnectionConfig(auth);
const pagination = new Paginate();
pagination.setPage(1);
pagination.setPagesize(20);
const request = new GetAllAssistantDeploymentRequest();
request.setAssistantid("ASSISTANT_ID_PLACEHOLDER");
request.setPaginate(pagination);
const response = await GetAllAssistantPhoneDeployment(connectionCfg, request);
console.dir(response.toObject());
Response
Numeric status code for the operation.
Indicates whether the operation was successful.
data
AssistantPhoneDeployment[]
Phone deployments returned by the request.
Unique identifier for the phone deployment.
Assistant ID for the deployment.
First message the assistant sends when the session starts.
Message used when the assistant cannot understand or handle input.
Speech-to-text provider configuration.
Text-to-speech provider configuration.
Provider-specific options.
Current deployment status.
Number of idle-timeout retries.
Message sent on idle timeout.
Maximum session duration in seconds.
Timestamp when the deployment was created.
Timestamp when the deployment was last updated.
Pagination metadata.
Current page returned by the API.
Total number of matching deployments.
Error details when the operation fails.
Stable, machine-readable numeric code.
Developer-oriented message with diagnostic details.
Human-friendly description safe for display to end users.
Errors
| Code | Meaning |
|---|
1015001 | Unauthenticated request. |
1015002 | Missing authentication scope. |
1015003 | Invalid assistantId. |
1015004 | Invalid request. |
1015005 | Unable to get assistant phone deployments. |