General Documentation
Agents
Agent Executions
Test Suites
Projects
WhatsApp Conversations
Customers
WhatsApp Configs
Agent Test Chats
Conversation Assignments
WhatsApp Templates
WhatsApp Contact Notes
Agent Snapshots
WhatsApp Sandbox
List sandbox sessions
Returns a list of WhatsApp sandbox sessions for the project associated with the API key
GET
/
sandbox_sessions
Copy
curl --request GET \
--url https://app.kapso.ai/api/v1/sandbox_sessions \
--header 'X-API-Key: <api-key>'
Copy
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"phone_number": "+12345678901",
"status": "pending_activation",
"activation_code": "ABC123",
"activation_message": "Your WhatsApp Sandbox activation code is: ABC123",
"activation_link": "https://wa.me/12345678901?text=ABC123",
"activated_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"agent": {
"id": "agent-123abc",
"name": "Customer Support Agent",
"description": "Handles initial customer support queries",
"project_id": "project-456def",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
],
"meta": {
"page": 123,
"per_page": 123,
"total_pages": 123,
"total_count": 123
}
}
Authorizations
API key required for all endpoints
Query Parameters
Required range:
x >= 1
Required range:
1 <= x <= 100
Response
200
application/json
A list of sandbox sessions
The response is of type object
.
Copy
curl --request GET \
--url https://app.kapso.ai/api/v1/sandbox_sessions \
--header 'X-API-Key: <api-key>'
Copy
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"phone_number": "+12345678901",
"status": "pending_activation",
"activation_code": "ABC123",
"activation_message": "Your WhatsApp Sandbox activation code is: ABC123",
"activation_link": "https://wa.me/12345678901?text=ABC123",
"activated_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"agent": {
"id": "agent-123abc",
"name": "Customer Support Agent",
"description": "Handles initial customer support queries",
"project_id": "project-456def",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
],
"meta": {
"page": 123,
"per_page": 123,
"total_pages": 123,
"total_count": 123
}
}
Assistant
Responses are generated using AI and may contain mistakes.