voipbin
API docs by Redocly

VoipBin API (1.0.0)

Download OpenAPI specification:Download

Auth

Authentication operations

Find more about authentication

Create a new customer account (self-service signup).

Initiates a new customer account registration. The request must include accepted_tos: true to confirm Terms of Service agreement.

On success, returns a customer object and a temporary token. On failure (e.g., duplicate email), still returns HTTP 200 with an empty body to prevent email enumeration attacks.

After signup, the customer receives a verification email. Use POST /auth/email-verify with the token from the email to verify the account.

Request Body schema: application/json
required
name
string

Display name for the customer account.

detail
string

Additional details about the customer.

email
required
string <email>

Email address for the new customer account. Must be unique across all customers.

phone_number
string

Contact phone number in E.164 format.

address
string

Mailing address of the customer.

webhook_method
string

HTTP method for webhook delivery. One of: POST, GET, PUT, DELETE.

webhook_uri
string

URI where webhook events will be delivered.

accepted_tos
required
boolean

Must be true to confirm acceptance of the Terms of Service. Requests with false or missing value are rejected with HTTP 400.

Responses

Request samples

Content type
application/json
{
  • "name": "Acme Corporation",
  • "detail": "Enterprise customer account",
  • "email": "[email protected]",
  • "phone_number": "+14155551234",
  • "address": "123 Main St, San Francisco, CA 94105",
  • "webhook_method": "POST",
  • "webhook_uri": "https://api.acme.com/webhooks/voipbin",
  • "accepted_tos": true
}

Response samples

Content type
application/json
{
  • "customer": {
    },
  • "temp_token": "tmp_a3Bf9xKmPq2nR7sT4wYzLp8mN5qR1xWe"
}

Verify customer email address.

Validates the email verification token sent to the customer's email during signup. On success, the customer's email is marked as verified and an access key is provisioned.

The token is a 64-character lowercase hexadecimal string included in the verification email.

Request Body schema: application/json
required
token
required
string

64-character lowercase hexadecimal verification token. Sent to the customer's email after POST /auth/signup.

Responses

Request samples

Content type
application/json
{
  • "token": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6abcd"
}

Response samples

Content type
application/json
{
  • "customer": {
    },
  • "accesskey": {
    }
}

Complete headless signup with OTP verification.

Completes a headless (API-based) signup flow by validating a one-time password (OTP) code. The temp_token is returned from POST /auth/signup and the code is the OTP sent to the customer.

On success, returns the customer ID and a provisioned access key.

Request Body schema: application/json
required
temp_token
required
string

Temporary token returned from the POST /auth/signup response.

code
required
string

One-time password (OTP) code sent to the customer for verification.

Responses

Request samples

Content type
application/json
{
  • "temp_token": "tmp_a3Bf9xKmPq2nR7sT4wYzLp8mN5qR1xWe",
  • "code": "123456"
}

Response samples

Content type
application/json
{
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "accesskey": {
    }
}

Schedule or immediately execute account deletion (self-service).

Marks the authenticated customer's account for deletion. The account enters 'frozen' state immediately. Active calls are terminated and new operations are blocked.

By default, the customer has 30 days to recover via DELETE /auth/unregister before permanent deletion.

If immediate is set to true, the account is frozen and then permanently deleted (PII anonymized, all resources cascade-deleted) in a single request. This cannot be undone.

Exactly one of password or confirmation_phrase must be provided:

  • Password-based accounts: provide password for re-authentication.
  • SSO or API-key authenticated requests: provide confirmation_phrase set to "DELETE".
query Parameters
accesskey
string

API access key token. Returned from the GET /accesskeys response. Alternative to Bearer token authentication.

Request Body schema: application/json
required
password
string

Account password for re-authentication. Required for password-based accounts. Mutually exclusive with confirmation_phrase.

confirmation_phrase
string

Must be exactly "DELETE". Required for SSO users and API-key authenticated requests. Mutually exclusive with password.

immediate
boolean

If true, skip the 30-day grace period and delete the account immediately. The account is frozen and then permanently deleted (PII anonymized, all resources cascade-deleted) in a single request. Default: false.

Responses

Request samples

Content type
application/json
{
  • "password": "mySecurePassword123",
  • "confirmation_phrase": "DELETE",
  • "immediate": false
}

Response samples

Content type
application/json
{
  • "id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Acme Corporation",
  • "detail": "Enterprise customer account",
  • "email": "[email protected]",
  • "phone_number": "+14155551234",
  • "address": "123 Main St, San Francisco, CA 94105",
  • "webhook_method": "POST",
  • "webhook_uri": "https://api.acme.com/webhooks/voipbin",
  • "billing_account_id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  • "email_verified": true,
  • "status": "active",
  • "tm_deletion_scheduled": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Cancel account deletion (self-service recover).

Cancels a scheduled deletion and restores the authenticated customer's account to active state. Only works during the 30-day grace period while the account is in 'frozen' status. No request body required.

query Parameters
accesskey
string

API access key token. Returned from the GET /accesskeys response. Alternative to Bearer token authentication.

Responses

Response samples

Content type
application/json
{
  • "id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Acme Corporation",
  • "detail": "Enterprise customer account",
  • "email": "[email protected]",
  • "phone_number": "+14155551234",
  • "address": "123 Main St, San Francisco, CA 94105",
  • "webhook_method": "POST",
  • "webhook_uri": "https://api.acme.com/webhooks/voipbin",
  • "billing_account_id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  • "email_verified": true,
  • "status": "active",
  • "tm_deletion_scheduled": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Accesskey

Operations related to accesskey

Find more about accesskey

Get list of accesskeys

Get accesskeys of the customer

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new accesskey.

Create a new accesskey.

Request Body schema: application/json
required
name
string
detail
string
expire
integer <int>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "expire": 0
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Production API Key",
  • "detail": "API key for production environment",
  • "token": "vb_a3Bf9xKmPq2nR7sT4wYzLp8mN5qR1xWe",
  • "token_prefix": "vb_a3Bf9xKm",
  • "tm_expire": "2027-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Get details of an accesskey

path Parameters
id
required
string

ID of the accesskey

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Production API Key",
  • "detail": "API key for production environment",
  • "token": "vb_a3Bf9xKmPq2nR7sT4wYzLp8mN5qR1xWe",
  • "token_prefix": "vb_a3Bf9xKm",
  • "tm_expire": "2027-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete an accesskey

path Parameters
id
required
string

ID of the accesskey

Responses

Update an accesskey

path Parameters
id
required
string

ID of the accesskey

Request Body schema: application/json
required
name
string
detail
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Production API Key",
  • "detail": "API key for production environment",
  • "token": "vb_a3Bf9xKmPq2nR7sT4wYzLp8mN5qR1xWe",
  • "token_prefix": "vb_a3Bf9xKm",
  • "tm_expire": "2027-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Activeflow

Operations related to activeflow

Find more about activeflow

Create a new activeflow

Endpoint to create a new activeflow.

Request Body schema: application/json
required

Request body to create a new activeflow.

id
string

ID of the activeflow.

flow_id
string

Flow id of.

Array of objects (FlowManagerAction)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "flow_id": "string",
  • "actions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "status": "running",
  • "reference_type": "call",
  • "reference_id": "f6a7b8c9-d0e1-2345-6789-0abcdef01234",
  • "reference_activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "on_complete_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "current_action": {
    },
  • "forward_action_id": "550e8400-e29b-41d4-a716-446655440000",
  • "executed_actions": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

List all activeflows

Retrieve a list of all activeflows.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Delete an activeflow

Endpoint to delete an activeflow by its ID.

path Parameters
id
required
string

The ID of the activeflow to delete.

Responses

Get an activeflow by ID

Retrieve details of a specific flow.

path Parameters
id
required
string

The ID of the activeflow.

Responses

Response samples

Content type
application/json
{
  • "id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "status": "running",
  • "reference_type": "call",
  • "reference_id": "f6a7b8c9-d0e1-2345-6789-0abcdef01234",
  • "reference_activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "on_complete_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "current_action": {
    },
  • "forward_action_id": "550e8400-e29b-41d4-a716-446655440000",
  • "executed_actions": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Stop an activeflow

Endpoint to stop an activeflow by its ID.

path Parameters
id
required
string

The ID of the activeflow to stop.

Responses

Response samples

Content type
application/json
{
  • "id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "status": "running",
  • "reference_type": "call",
  • "reference_id": "f6a7b8c9-d0e1-2345-6789-0abcdef01234",
  • "reference_activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "on_complete_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "current_action": {
    },
  • "forward_action_id": "550e8400-e29b-41d4-a716-446655440000",
  • "executed_actions": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Agent

Operations related to agent

Find more about agent

List agents

Get agents of the user.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

tag_ids
string

Comma separated tag ids.

status
string (AgentManagerAgentStatus)
Enum: "" "available" "away" "busy" "offline" "ringing"
Example: status=available

Agent status.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new agent

Endpoint to create a new agent.

Request Body schema: application/json
required

Request body to create a new agent.

username
required
string
password
required
string
name
required
string
detail
required
string
ring_method
required
string (AgentManagerAgentRingMethod)
Enum: "ringall" "linear"

Method used to ring the agent for incoming calls.

permission
required
integer <uint64> (AgentManagerAgentPermission)
Enum: 0 65535 1 15 16 32 64 240

Permission type

tag_ids
required
Array of strings
required
Array of objects (CommonAddress)

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "name": "string",
  • "detail": "string",
  • "ring_method": "ringall",
  • "permission": 64,
  • "tag_ids": [
    ],
  • "addresses": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "[email protected]",
  • "name": "John Smith",
  • "detail": "Senior support agent",
  • "ring_method": "ringall",
  • "status": "available",
  • "permission": 64,
  • "tag_ids": [
    ],
  • "addresses": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T10:00:00.000000Z"
}

Get the agent

Get the agent of the given ID.

path Parameters
id
required
string

The ID of the agent.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "[email protected]",
  • "name": "John Smith",
  • "detail": "Senior support agent",
  • "ring_method": "ringall",
  • "status": "available",
  • "permission": 64,
  • "tag_ids": [
    ],
  • "addresses": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T10:00:00.000000Z"
}

Delete the agent

Delete the agent of the given ID.

path Parameters
id
required
string

The ID of the agent.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "[email protected]",
  • "name": "John Smith",
  • "detail": "Senior support agent",
  • "ring_method": "ringall",
  • "status": "available",
  • "permission": 64,
  • "tag_ids": [
    ],
  • "addresses": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T10:00:00.000000Z"
}

Update an agent

Update an agent and return updated details.

path Parameters
id
required
string

The ID of the agent.

Request Body schema: application/json
required
name
string
detail
string
ring_method
string (AgentManagerAgentRingMethod)
Enum: "ringall" "linear"

Method used to ring the agent for incoming calls.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "ring_method": "ringall"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "[email protected]",
  • "name": "John Smith",
  • "detail": "Senior support agent",
  • "ring_method": "ringall",
  • "status": "available",
  • "permission": 64,
  • "tag_ids": [
    ],
  • "addresses": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T10:00:00.000000Z"
}

Update an agent's addresses

Update an agent's addresses and return updated details.

path Parameters
id
required
string

The ID of the agent.

Request Body schema: application/json
required
Array of objects (CommonAddress)

Responses

Request samples

Content type
application/json
{
  • "addresses": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "[email protected]",
  • "name": "John Smith",
  • "detail": "Senior support agent",
  • "ring_method": "ringall",
  • "status": "available",
  • "permission": 64,
  • "tag_ids": [
    ],
  • "addresses": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T10:00:00.000000Z"
}

Update an agent's tag IDs

Update an agent's tag IDs and return updated details.

path Parameters
id
required
string

The ID of the agent.

Request Body schema: application/json
required
tag_ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "tag_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "[email protected]",
  • "name": "John Smith",
  • "detail": "Senior support agent",
  • "ring_method": "ringall",
  • "status": "available",
  • "permission": 64,
  • "tag_ids": [
    ],
  • "addresses": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T10:00:00.000000Z"
}

Update an agent's permission

Update an agent's permission and return updated details.

path Parameters
id
required
string

The ID of the agent.

Request Body schema: application/json
required
permission
integer <uint64> (AgentManagerAgentPermission)
Enum: 0 65535 1 15 16 32 64 240

Permission type

Responses

Request samples

Content type
application/json
{
  • "permission": 64
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "[email protected]",
  • "name": "John Smith",
  • "detail": "Senior support agent",
  • "ring_method": "ringall",
  • "status": "available",
  • "permission": 64,
  • "tag_ids": [
    ],
  • "addresses": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T10:00:00.000000Z"
}

Update an agent's status

Update an agent's status and return updated details.

path Parameters
id
required
string

The ID of the agent.

Request Body schema: application/json
required
status
string (AgentManagerAgentStatus)
Enum: "" "available" "away" "busy" "offline" "ringing"

Current availability status of the agent.

Responses

Request samples

Content type
application/json
{
  • "status": "available"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "[email protected]",
  • "name": "John Smith",
  • "detail": "Senior support agent",
  • "ring_method": "ringall",
  • "status": "available",
  • "permission": 64,
  • "tag_ids": [
    ],
  • "addresses": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T10:00:00.000000Z"
}

Update an agent's password

Update an agent's password and return updated details.

path Parameters
id
required
string

The ID of the agent.

Request Body schema: application/json
required
password
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "[email protected]",
  • "name": "John Smith",
  • "detail": "Senior support agent",
  • "ring_method": "ringall",
  • "status": "available",
  • "permission": 64,
  • "tag_ids": [
    ],
  • "addresses": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T10:00:00.000000Z"
}

Billing

Operations related to billing

Find more about billing

Get detailed billing account info

Returns detailed billing account info for the given ID.

path Parameters
id
required
string

The ID of the billing account.

Responses

Response samples

Content type
application/json
{
  • "id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Production Account",
  • "detail": "Main billing account for production services",
  • "plan_type": "basic",
  • "balance_credit": 1500000,
  • "balance_token": 500,
  • "payment_type": "prepaid",
  • "payment_method": "credit card",
  • "tm_last_topup": "2026-01-15T09:30:00.000000Z",
  • "tm_next_topup": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update billing account

Updates the billing account information for the given ID.

path Parameters
id
required
string

The ID of the billing account.

Request Body schema: application/json
required
name
string
detail
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string"
}

Response samples

Content type
application/json
{
  • "id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Production Account",
  • "detail": "Main billing account for production services",
  • "plan_type": "basic",
  • "balance_credit": 1500000,
  • "balance_token": 500,
  • "payment_type": "prepaid",
  • "payment_method": "credit card",
  • "tm_last_topup": "2026-01-15T09:30:00.000000Z",
  • "tm_next_topup": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update billing account's payment info

Updates the payment info for the given billing account ID.

path Parameters
id
required
string

The ID of the billing account.

Request Body schema: application/json
required
payment_type
string (BillingManagerAccountPaymentType)
Enum: "" "prepaid"

The type of payment associated with the account.

payment_method
string (BillingManagerAccountPaymentMethod)
Enum: "" "credit card"

The method of payment used for the account.

Responses

Request samples

Content type
application/json
{
  • "payment_type": "prepaid",
  • "payment_method": "credit card"
}

Response samples

Content type
application/json
{
  • "id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Production Account",
  • "detail": "Main billing account for production services",
  • "plan_type": "basic",
  • "balance_credit": 1500000,
  • "balance_token": 500,
  • "payment_type": "prepaid",
  • "payment_method": "credit card",
  • "tm_last_topup": "2026-01-15T09:30:00.000000Z",
  • "tm_next_topup": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Add balance to billing account

Adds the given balance to the billing account.

path Parameters
id
required
string

The ID of the billing account.

Request Body schema: application/json
required
balance
number <float>

Responses

Request samples

Content type
application/json
{
  • "balance": 0.1
}

Response samples

Content type
application/json
{
  • "id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Production Account",
  • "detail": "Main billing account for production services",
  • "plan_type": "basic",
  • "balance_credit": 1500000,
  • "balance_token": 500,
  • "payment_type": "prepaid",
  • "payment_method": "credit card",
  • "tm_last_topup": "2026-01-15T09:30:00.000000Z",
  • "tm_next_topup": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Subtract balance from billing account

Subtracts the given balance from the billing account.

path Parameters
id
required
string

The ID of the billing account.

Request Body schema: application/json
required
balance
number <float>

Responses

Request samples

Content type
application/json
{
  • "balance": 0.1
}

Response samples

Content type
application/json
{
  • "id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Production Account",
  • "detail": "Main billing account for production services",
  • "plan_type": "basic",
  • "balance_credit": 1500000,
  • "balance_token": 500,
  • "payment_type": "prepaid",
  • "payment_method": "credit card",
  • "tm_last_topup": "2026-01-15T09:30:00.000000Z",
  • "tm_next_topup": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Get list of billings

Retrieve a list of the customer's billings.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Get a billing record by ID

Retrieves a single billing record by its unique identifier. Returns only the billing record without related account or reference resource data.

path Parameters
billing-id
required
string <uuid>
Example: 550e8400-e29b-41d4-a716-446655440000

The unique identifier of the billing record

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "account_id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  • "transaction_type": "usage",
  • "status": "progressing",
  • "reference_type": "call",
  • "reference_id": "f6a7b8c9-d0e1-2345-6789-0abcdef01234",
  • "cost_type": "call_pstn_outgoing",
  • "usage_duration": 125,
  • "billable_units": 3,
  • "rate_token_per_unit": 10,
  • "rate_credit_per_unit": 50000,
  • "amount_token": -30,
  • "amount_credit": -150000,
  • "balance_token_snapshot": 470,
  • "balance_credit_snapshot": 1350000,
  • "idempotency_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "tm_billing_start": "2026-01-15T09:30:00.000000Z",
  • "tm_billing_end": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Call

Operations related to call

Find more about call

Start call recording

Initiate recording for the specified call.

path Parameters
id
required
string

The ID of the call

Request Body schema: application/json
required
format
required
string
Value: "wav"

The format of the recording.

end_of_silence
required
integer

The duration of silence (in seconds) after which the recording will be stopped.

end_of_key
required
string

The key that will stop the recording.

duration
required
integer

The maximum duration of the recording (in seconds).

on_end_flow_id
required
string

The ID of the flow to be executed when the recording ends.

Responses

Request samples

Content type
application/json
{
  • "format": "wav",
  • "end_of_silence": 0,
  • "end_of_key": "string",
  • "duration": 0,
  • "on_end_flow_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
  • "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "type": "flow",
  • "master_call_id": "4d5e6f7a-8b9c-0123-def0-123456789012",
  • "chained_call_ids": [
    ],
  • "recording_id": "e5f6a7b8-c9d0-1234-5678-90abcdef0123",
  • "recording_ids": [
    ],
  • "groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
  • "source": {
    },
  • "destination": {
    },
  • "status": "progressing",
  • "action": {
    },
  • "direction": "outgoing",
  • "mute_direction": "both",
  • "hangup_by": "remote",
  • "hangup_reason": "normal",
  • "tm_progressing": "2026-01-15T09:30:00.000000Z",
  • "tm_ringing": "2026-01-15T09:30:00.000000Z",
  • "tm_hangup": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Stop call recording

Stop the ongoing recording for the specified call.

path Parameters
id
required
string

The ID of the call

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
  • "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "type": "flow",
  • "master_call_id": "4d5e6f7a-8b9c-0123-def0-123456789012",
  • "chained_call_ids": [
    ],
  • "recording_id": "e5f6a7b8-c9d0-1234-5678-90abcdef0123",
  • "recording_ids": [
    ],
  • "groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
  • "source": {
    },
  • "destination": {
    },
  • "status": "progressing",
  • "action": {
    },
  • "direction": "outgoing",
  • "mute_direction": "both",
  • "hangup_by": "remote",
  • "hangup_reason": "normal",
  • "tm_progressing": "2026-01-15T09:30:00.000000Z",
  • "tm_ringing": "2026-01-15T09:30:00.000000Z",
  • "tm_hangup": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Hang up the call

Ends the call.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
  • "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "type": "flow",
  • "master_call_id": "4d5e6f7a-8b9c-0123-def0-123456789012",
  • "chained_call_ids": [
    ],
  • "recording_id": "e5f6a7b8-c9d0-1234-5678-90abcdef0123",
  • "recording_ids": [
    ],
  • "groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
  • "source": {
    },
  • "destination": {
    },
  • "status": "progressing",
  • "action": {
    },
  • "direction": "outgoing",
  • "mute_direction": "both",
  • "hangup_by": "remote",
  • "hangup_reason": "normal",
  • "tm_progressing": "2026-01-15T09:30:00.000000Z",
  • "tm_ringing": "2026-01-15T09:30:00.000000Z",
  • "tm_hangup": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Hold the call

Puts the specified call on hold.

path Parameters
id
required
string

Responses

Unhold the call

Removes the hold status on the call.

path Parameters
id
required
string

Responses

Get media stream for the call

Retrieve the media stream information for a specific call.

path Parameters
id
required
string

The ID of the call

query Parameters
encapsulation
string

Responses

Enable Music on Hold (MOH)

Activates Music on Hold for the call.

path Parameters
id
required
string

Responses

Disable Music on Hold (MOH)

Deactivates Music on Hold for the call.

path Parameters
id
required
string

Responses

Mute the call

Mutes the specified call.

path Parameters
id
required
string
Request Body schema: application/json
direction
string (CallManagerCallMuteDirection)
Enum: "" "both" "out" "in"

Possible mute directions for the call

Responses

Request samples

Content type
application/json
{
  • "direction": "both"
}

Unmute the call

Unmutes the specified call.

path Parameters
id
required
string
Request Body schema: application/json
direction
string (CallManagerCallMuteDirection)
Enum: "" "both" "out" "in"

Possible mute directions for the call

Responses

Request samples

Content type
application/json
{
  • "direction": "both"
}

Silence a call

Mute the audio stream for the specified call.

path Parameters
id
required
string

The ID of the call

Responses

Un-silence a call

Unmute the audio stream for the specified call.

path Parameters
id
required
string

The ID of the call

Responses

Talk to the call

Initiates a talking action to the call.

path Parameters
id
required
string
Request Body schema: application/json
text
string
language
string
provider
string

TTS provider to use (gcp or aws). If empty, defaults to GCP. If the selected provider fails, the system falls back to the alternative provider with the default voice for the language.

voice_id
string

Provider-specific voice ID. If empty, uses the default voice for the given language. On fallback, the voice_id is reset to the alternative provider's default.

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "language": "string",
  • "provider": "string",
  • "voice_id": "string"
}

Get detail call info

Returns detailed information about the specified call.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
  • "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "type": "flow",
  • "master_call_id": "4d5e6f7a-8b9c-0123-def0-123456789012",
  • "chained_call_ids": [
    ],
  • "recording_id": "e5f6a7b8-c9d0-1234-5678-90abcdef0123",
  • "recording_ids": [
    ],
  • "groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
  • "source": {
    },
  • "destination": {
    },
  • "status": "progressing",
  • "action": {
    },
  • "direction": "outgoing",
  • "mute_direction": "both",
  • "hangup_by": "remote",
  • "hangup_reason": "normal",
  • "tm_progressing": "2026-01-15T09:30:00.000000Z",
  • "tm_ringing": "2026-01-15T09:30:00.000000Z",
  • "tm_hangup": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete up the call

Delete the call

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
  • "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "type": "flow",
  • "master_call_id": "4d5e6f7a-8b9c-0123-def0-123456789012",
  • "chained_call_ids": [
    ],
  • "recording_id": "e5f6a7b8-c9d0-1234-5678-90abcdef0123",
  • "recording_ids": [
    ],
  • "groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
  • "source": {
    },
  • "destination": {
    },
  • "status": "progressing",
  • "action": {
    },
  • "direction": "outgoing",
  • "mute_direction": "both",
  • "hangup_by": "remote",
  • "hangup_reason": "normal",
  • "tm_progressing": "2026-01-15T09:30:00.000000Z",
  • "tm_ringing": "2026-01-15T09:30:00.000000Z",
  • "tm_hangup": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Get list of calls

Returns a list of calls for the given customer.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Make an outbound call

Creates a temporary flow and initiates a call with the specified flow.

Request Body schema: application/json
flow_id
string
Array of objects (FlowManagerAction)
object (CommonAddress)

Contains source or destination detail info.

Array of objects (CommonAddress)

Responses

Request samples

Content type
application/json
{
  • "flow_id": "string",
  • "actions": [
    ],
  • "source": {
    },
  • "destinations": [
    ]
}

Response samples

Content type
application/json
{
  • "calls": [
    ],
  • "groupcalls": [
    ]
}

Campaign

Operations related to campaign

Find more about campaign

Get campaign call details

Retrieve detailed information for a specific campaign call.

path Parameters
id
required
string

The ID of the campaign call

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "outplan_id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  • "outdial_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "outdial_target_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "queue_id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
  • "activeflow_id": "550e8400-e29b-41d4-a716-446655440000",
  • "flow_id": "550e8400-e29b-41d4-a716-446655440000",
  • "reference_type": "call",
  • "reference_id": "550e8400-e29b-41d4-a716-446655440000",
  • "status": "progressing",
  • "result": "success",
  • "source": {
    },
  • "destination": {
    },
  • "destination_index": 0,
  • "try_count": 2,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete a campaign call

Deletes an existing campaign call.

path Parameters
id
required
string

The ID of the campaign call to delete

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "outplan_id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  • "outdial_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "outdial_target_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "queue_id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
  • "activeflow_id": "550e8400-e29b-41d4-a716-446655440000",
  • "flow_id": "550e8400-e29b-41d4-a716-446655440000",
  • "reference_type": "call",
  • "reference_id": "550e8400-e29b-41d4-a716-446655440000",
  • "status": "progressing",
  • "result": "success",
  • "source": {
    },
  • "destination": {
    },
  • "destination_index": 0,
  • "try_count": 2,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Get list of campaign calls

Retrieve a list of campaign calls for a given customer.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Update campaign's actions

Updates the actions of a specific campaign and return the updated campaign info.

path Parameters
id
required
string

ID of the campaign

Request Body schema: application/json
required
required
Array of objects (FlowManagerAction)

Responses

Request samples

Content type
application/json
{
  • "actions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "call",
  • "name": "Q1 Outbound Campaign",
  • "detail": "Quarterly customer outreach campaign",
  • "status": "run",
  • "service_level": 80,
  • "end_handle": "stop",
  • "actions": [
    ],
  • "outplan_id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  • "outdial_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "queue_id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
  • "next_campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update campaign's actions

Updates the actions of a specific campaign and return the updated campaign info.

path Parameters
id
required
string

ID of the campaign

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Update campaign's service level

Updates the sevice level of a specific campaign and return the updated campaign info.

path Parameters
id
required
string

ID of the campaign

Request Body schema: application/json
required
next_campaign_id
required
string

The next campaign's id.

Responses

Request samples

Content type
application/json
{
  • "next_campaign_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "call",
  • "name": "Q1 Outbound Campaign",
  • "detail": "Quarterly customer outreach campaign",
  • "status": "run",
  • "service_level": 80,
  • "end_handle": "stop",
  • "actions": [
    ],
  • "outplan_id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  • "outdial_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "queue_id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
  • "next_campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update campaign's resource info

Updates the resource info of a specific campaign and return the updated campaign info.

path Parameters
id
required
string

ID of the campaign

Request Body schema: application/json
required
outplan_id
required
string

outplan's id.

outdial_id
required
string

outplan's id.

queue_id
required
string

queue's id.

next_campaign_id
required
string

next campaign's id.

Responses

Request samples

Content type
application/json
{
  • "outplan_id": "string",
  • "outdial_id": "string",
  • "queue_id": "string",
  • "next_campaign_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "call",
  • "name": "Q1 Outbound Campaign",
  • "detail": "Quarterly customer outreach campaign",
  • "status": "run",
  • "service_level": 80,
  • "end_handle": "stop",
  • "actions": [
    ],
  • "outplan_id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  • "outdial_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "queue_id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
  • "next_campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update campaign's service level

Updates the sevice level of a specific campaign and return the updated campaign info.

path Parameters
id
required
string

ID of the campaign

Request Body schema: application/json
required
service_level
required
integer

The campaign's service level.

Responses

Request samples

Content type
application/json
{
  • "service_level": 0
}

Response samples

Content type
application/json
{
  • "id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "call",
  • "name": "Q1 Outbound Campaign",
  • "detail": "Quarterly customer outreach campaign",
  • "status": "run",
  • "service_level": 80,
  • "end_handle": "stop",
  • "actions": [
    ],
  • "outplan_id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  • "outdial_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "queue_id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
  • "next_campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update campaign status

Updates the status of a specific campaign.

path Parameters
id
required
string

ID of the campaign

Request Body schema: application/json
required
status
required
string (CampaignManagerCampaignStatus)
Enum: "stop" "stopping" "run"

Status of the campaign.

Responses

Request samples

Content type
application/json
{
  • "status": "run"
}

Response samples

Content type
application/json
{
  • "id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "call",
  • "name": "Q1 Outbound Campaign",
  • "detail": "Quarterly customer outreach campaign",
  • "status": "run",
  • "service_level": 80,
  • "end_handle": "stop",
  • "actions": [
    ],
  • "outplan_id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  • "outdial_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "queue_id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
  • "next_campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Get campaign details

Retrieves detailed information about a specific campaign by its ID.

path Parameters
id
required
string

ID of the campaign

Responses

Response samples

Content type
application/json
{
  • "id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "call",
  • "name": "Q1 Outbound Campaign",
  • "detail": "Quarterly customer outreach campaign",
  • "status": "run",
  • "service_level": 80,
  • "end_handle": "stop",
  • "actions": [
    ],
  • "outplan_id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  • "outdial_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "queue_id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
  • "next_campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update a campaign

Updates the details of an existing campaign and returns the updated campaign.

path Parameters
id
required
string

ID of the campaign

Request Body schema: application/json
required
name
required
string

Updated name of the campaign

detail
required
string

Updated details of the campaign

type
required
string (CampaignManagerCampaignType)
Enum: "call" "flow"

Type of campaign.

service_level
required
integer

Updated service level of the campaign

end_handle
required
string (CampaignManagerCampaignEndHandle)
Enum: "stop" "continue"

Behavior of the campaign after outdial has no more targets.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "type": "call",
  • "service_level": 0,
  • "end_handle": "stop"
}

Response samples

Content type
application/json
{
  • "id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "call",
  • "name": "Q1 Outbound Campaign",
  • "detail": "Quarterly customer outreach campaign",
  • "status": "run",
  • "service_level": 80,
  • "end_handle": "stop",
  • "actions": [
    ],
  • "outplan_id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  • "outdial_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "queue_id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
  • "next_campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete a campaign

Deletes a campaign by its ID.

path Parameters
id
required
string

ID of the campaign

Responses

Response samples

Content type
application/json
{
  • "id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "call",
  • "name": "Q1 Outbound Campaign",
  • "detail": "Quarterly customer outreach campaign",
  • "status": "run",
  • "service_level": 80,
  • "end_handle": "stop",
  • "actions": [
    ],
  • "outplan_id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  • "outdial_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "queue_id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
  • "next_campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Get a list of campaigns

Retrieves a paginated list of campaigns.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new campaign

Creates a new campaign with the provided details and returns the created campaign.

Request Body schema: application/json
required
name
required
string

Name of the campaign

detail
required
string

Detailed description of the campaign

type
required
string (CampaignManagerCampaignType)
Enum: "call" "flow"

Type of campaign.

service_level
required
integer

Service level of the campaign

end_handle
required
string (CampaignManagerCampaignEndHandle)
Enum: "stop" "continue"

Behavior of the campaign after outdial has no more targets.

required
Array of objects (FlowManagerAction)

Actions associated with the campaign

outplan_id
required
string

Outplan ID for the campaign

outdial_id
required
string

Outdial ID for the campaign

queue_id
required
string

Queue ID for the campaign

next_campaign_id
required
string

ID of the next campaign

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "type": "call",
  • "service_level": 0,
  • "end_handle": "stop",
  • "actions": [
    ],
  • "outplan_id": "string",
  • "outdial_id": "string",
  • "queue_id": "string",
  • "next_campaign_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "call",
  • "name": "Q1 Outbound Campaign",
  • "detail": "Quarterly customer outreach campaign",
  • "status": "run",
  • "service_level": 80,
  • "end_handle": "stop",
  • "actions": [
    ],
  • "outplan_id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  • "outdial_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "queue_id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
  • "next_campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

AI

Operations related to ai

Find more about ai

Retrieve details of a aicall message

Fetches detailed information about a specific aicall message by ID.

path Parameters
id
required
string

The ID of the aicall message

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "aicall_id": "550e8400-e29b-41d4-a716-446655440000",
  • "role": "assistant",
  • "content": "Hello, how can I help you today?",
  • "direction": "incoming",
  • "tool_calls": [
    ],
  • "tool_call_id": "call_abc123",
  • "tm_create": "2026-01-15T09:30:00.000000Z"
}

Delete a aicall message

Deletes a specific aicall message by ID and returns its details.

path Parameters
id
required
string

The ID of the aicall message

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "aicall_id": "550e8400-e29b-41d4-a716-446655440000",
  • "role": "assistant",
  • "content": "Hello, how can I help you today?",
  • "direction": "incoming",
  • "tool_calls": [
    ],
  • "tool_call_id": "call_abc123",
  • "tm_create": "2026-01-15T09:30:00.000000Z"
}

Retrieve a list of aicall messages

Fetches a paginated list of aicall messages.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

aicall_id
required
string

The aicall id.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Send a aicall message

Creates and send a new aicall message and returns the details of the created message.

Request Body schema: application/json
required
aicall_id
required
string
role
required
string (AIManagerMessageRole)
Enum: "" "system" "user" "assistant" "function" "tool"

Role of the entity in the conversation.

content
required
string

Responses

Request samples

Content type
application/json
{
  • "aicall_id": "string",
  • "role": "assistant",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "aicall_id": "550e8400-e29b-41d4-a716-446655440000",
  • "role": "assistant",
  • "content": "Hello, how can I help you today?",
  • "direction": "incoming",
  • "tool_calls": [
    ],
  • "tool_call_id": "call_abc123",
  • "tm_create": "2026-01-15T09:30:00.000000Z"
}

Get details of a specific ai call

Retrieves detailed information about a ai call identified by its ID.

path Parameters
id
required
string

The ID of the ai call.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "assistance_type": "ai",
  • "assistance_id": "550e8400-e29b-41d4-a716-446655440000",
  • "ai_engine_model": "openai.gpt-4o",
  • "ai_tts_type": "elevenlabs",
  • "ai_tts_voice_id": "21m00Tcm4TlvDq8ikWAM",
  • "ai_stt_type": "deepgram",
  • "parameter": {
    },
  • "activeflow_id": "550e8400-e29b-41d4-a716-446655440000",
  • "reference_type": "call",
  • "reference_id": "550e8400-e29b-41d4-a716-446655440000",
  • "confbridge_id": "550e8400-e29b-41d4-a716-446655440000",
  • "status": "progressing",
  • "gender": "female",
  • "language": "en-US",
  • "tm_end": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete a specific ai call

Deletes a ai call identified by its ID.

path Parameters
id
required
string

The ID of the ai call.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "assistance_type": "ai",
  • "assistance_id": "550e8400-e29b-41d4-a716-446655440000",
  • "ai_engine_model": "openai.gpt-4o",
  • "ai_tts_type": "elevenlabs",
  • "ai_tts_voice_id": "21m00Tcm4TlvDq8ikWAM",
  • "ai_stt_type": "deepgram",
  • "parameter": {
    },
  • "activeflow_id": "550e8400-e29b-41d4-a716-446655440000",
  • "reference_type": "call",
  • "reference_id": "550e8400-e29b-41d4-a716-446655440000",
  • "confbridge_id": "550e8400-e29b-41d4-a716-446655440000",
  • "status": "progressing",
  • "gender": "female",
  • "language": "en-US",
  • "tm_end": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Gets a list of ai calls

Retrieves a paginated list of ai calls based on the provided query parameters.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new aicall.

Creates a new aicall and returns the created aicall's details.

Request Body schema: application/json
required
assistance_type
required
string (AIManagerAIcallAssistanceType)
Enum: "" "ai" "team"

Type of assistance entity associated with the AI call.

assistance_id
required
string
reference_type
required
string (AIManagerAIcallReferenceType)
Enum: "" "call" "conversation" "task"

Type of reference associated with the ai call.

reference_id
required
string
gender
required
string (AIManagerAIcallGender)
Enum: "" "male" "female" "neutral"

Gender associated with the AI call.

language
required
string

Responses

Request samples

Content type
application/json
{
  • "assistance_type": "ai",
  • "assistance_id": "string",
  • "reference_type": "call",
  • "reference_id": "string",
  • "gender": "female",
  • "language": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "assistance_type": "ai",
  • "assistance_id": "550e8400-e29b-41d4-a716-446655440000",
  • "ai_engine_model": "openai.gpt-4o",
  • "ai_tts_type": "elevenlabs",
  • "ai_tts_voice_id": "21m00Tcm4TlvDq8ikWAM",
  • "ai_stt_type": "deepgram",
  • "parameter": {
    },
  • "activeflow_id": "550e8400-e29b-41d4-a716-446655440000",
  • "reference_type": "call",
  • "reference_id": "550e8400-e29b-41d4-a716-446655440000",
  • "confbridge_id": "550e8400-e29b-41d4-a716-446655440000",
  • "status": "progressing",
  • "gender": "female",
  • "language": "en-US",
  • "tm_end": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Get ai details.

Retrieves detailed information for a specific ai by its ID.

path Parameters
id
required
string

The ID of the ai.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Customer Support Bot",
  • "detail": "AI assistant for handling customer inquiries",
  • "engine_model": "openai.gpt-4o",
  • "parameter": { },
  • "engine_key": "sk-...redacted...",
  • "init_prompt": "You are a helpful customer support assistant.",
  • "tts_type": "elevenlabs",
  • "tts_voice_id": "en-US-Neural2-F",
  • "stt_type": "deepgram",
  • "tool_names": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete a ai.

Deletes an existing ai by its ID.

path Parameters
id
required
string

The ID of the ai.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Customer Support Bot",
  • "detail": "AI assistant for handling customer inquiries",
  • "engine_model": "openai.gpt-4o",
  • "parameter": { },
  • "engine_key": "sk-...redacted...",
  • "init_prompt": "You are a helpful customer support assistant.",
  • "tts_type": "elevenlabs",
  • "tts_voice_id": "en-US-Neural2-F",
  • "stt_type": "deepgram",
  • "tool_names": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update a ai.

Updates an existing ai's details and returns the updated information.

path Parameters
id
required
string

The ID of the ai.

Request Body schema: application/json
required
name
required
string
detail
required
string
engine_model
required
string (AIManagerAIEngineModel)
Enum: "openai.o1-mini" "openai.o1-preview" "openai.o1" "openai.o3-mini" "openai.gpt-4o" "openai.gpt-4o-mini" "openai.gpt-4-turbo" "openai.gpt-4-vision-preview" "openai.gpt-4" "openai.gpt-3.5-turbo" "dialogflow.cx" "dialogflow.es" "grok.grok-3" "grok.grok-3-mini"

Model of the AI engine. Uses target.model format (e.g., openai.gpt-4o). The target prefix identifies the provider, and the model name follows after the dot.

required
object

Data associated with the ai's engine, can be dynamic and vary based on the engine type.

engine_key
required
string

API key or credential for the AI engine.

init_prompt
required
string
tts_type
required
string

Text-to-speech engine type.

tts_voice_id
required
string

Voice ID for the text-to-speech engine.

stt_type
required
string

Speech-to-text engine type.

tool_names
Array of strings

List of tool names to enable for this AI. Use ["all"] to enable all available tools.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "engine_model": "openai.gpt-4o",
  • "parameter": { },
  • "engine_key": "string",
  • "init_prompt": "string",
  • "tts_type": "string",
  • "tts_voice_id": "string",
  • "stt_type": "string",
  • "tool_names": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Customer Support Bot",
  • "detail": "AI assistant for handling customer inquiries",
  • "engine_model": "openai.gpt-4o",
  • "parameter": { },
  • "engine_key": "sk-...redacted...",
  • "init_prompt": "You are a helpful customer support assistant.",
  • "tts_type": "elevenlabs",
  • "tts_voice_id": "en-US-Neural2-F",
  • "stt_type": "deepgram",
  • "tool_names": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Gets a list of ais.

Retrieves a paginated list of ais.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new ai.

Creates a new ai and returns the created ai's details.

Request Body schema: application/json
required
name
required
string
detail
required
string
engine_model
required
string (AIManagerAIEngineModel)
Enum: "openai.o1-mini" "openai.o1-preview" "openai.o1" "openai.o3-mini" "openai.gpt-4o" "openai.gpt-4o-mini" "openai.gpt-4-turbo" "openai.gpt-4-vision-preview" "openai.gpt-4" "openai.gpt-3.5-turbo" "dialogflow.cx" "dialogflow.es" "grok.grok-3" "grok.grok-3-mini"

Model of the AI engine. Uses target.model format (e.g., openai.gpt-4o). The target prefix identifies the provider, and the model name follows after the dot.

required
object

Data associated with the ai's engine, can be dynamic and vary based on the engine type.

engine_key
required
string

API key or credential for the AI engine.

init_prompt
required
string
tts_type
required
string

Text-to-speech engine type.

tts_voice_id
required
string

Voice ID for the text-to-speech engine.

stt_type
required
string

Speech-to-text engine type.

tool_names
Array of strings

List of tool names to enable for this AI. Use ["all"] to enable all available tools.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "engine_model": "openai.gpt-4o",
  • "parameter": { },
  • "engine_key": "string",
  • "init_prompt": "string",
  • "tts_type": "string",
  • "tts_voice_id": "string",
  • "stt_type": "string",
  • "tool_names": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Customer Support Bot",
  • "detail": "AI assistant for handling customer inquiries",
  • "engine_model": "openai.gpt-4o",
  • "parameter": { },
  • "engine_key": "sk-...redacted...",
  • "init_prompt": "You are a helpful customer support assistant.",
  • "tts_type": "elevenlabs",
  • "tts_voice_id": "en-US-Neural2-F",
  • "stt_type": "deepgram",
  • "tool_names": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Get ai summary details.

Retrieves detailed information for a specific ai summary by its ID.

path Parameters
id
required
string

The ID of the ai summary.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "activeflow_id": "550e8400-e29b-41d4-a716-446655440000",
  • "on_end_flow_id": "550e8400-e29b-41d4-a716-446655440000",
  • "reference_type": "call",
  • "reference_id": "550e8400-e29b-41d4-a716-446655440000",
  • "status": "progressing",
  • "language": "en-US",
  • "content": "The customer called to inquire about their account balance and was assisted by the support agent.",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete a ai summary.

Deletes an existing ai summary by its ID.

path Parameters
id
required
string

The ID of the ai.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "activeflow_id": "550e8400-e29b-41d4-a716-446655440000",
  • "on_end_flow_id": "550e8400-e29b-41d4-a716-446655440000",
  • "reference_type": "call",
  • "reference_id": "550e8400-e29b-41d4-a716-446655440000",
  • "status": "progressing",
  • "language": "en-US",
  • "content": "The customer called to inquire about their account balance and was assisted by the support agent.",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Gets a list of ai summaries.

Retrieves a paginated list of ai summaries.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new ai summary.

Creates a new ai summary and returns the created ai summary's details.

Request Body schema: application/json
required
on_end_flow_id
required
string

The ID of the flow to be executed when the ai summary ends.

reference_type
required
string (AIManagerSummaryReferenceType)
Enum: "" "call" "conference" "transcribe" "recording"

Type of reference for the AI summary.

reference_id
required
string

The ID of the reference for the ai summary.

language
required
string

The language of the ai summary.

Responses

Request samples

Content type
application/json
{
  • "on_end_flow_id": "string",
  • "reference_type": "call",
  • "reference_id": "string",
  • "language": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "activeflow_id": "550e8400-e29b-41d4-a716-446655440000",
  • "on_end_flow_id": "550e8400-e29b-41d4-a716-446655440000",
  • "reference_type": "call",
  • "reference_id": "550e8400-e29b-41d4-a716-446655440000",
  • "status": "progressing",
  • "language": "en-US",
  • "content": "The customer called to inquire about their account balance and was assisted by the support agent.",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Conference

Operations related to conference

Find more about conference

Get conference call details

Retrieve detailed information about a specific conference call using its ID.

path Parameters
id
required
string

The ID of the conferencecall.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "conference_id": "8b9c0d1e-2f3a-4567-0123-456789abcdef",
  • "reference_type": "call",
  • "reference_id": "f6a7b8c9-d0e1-2345-6789-0abcdef01234",
  • "status": "joined",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Remove a conference call

Remove a specific conference call from the system by its ID.

path Parameters
id
required
string

The ID of the conferencecall to delete.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "conference_id": "8b9c0d1e-2f3a-4567-0123-456789abcdef",
  • "reference_type": "call",
  • "reference_id": "f6a7b8c9-d0e1-2345-6789-0abcdef01234",
  • "status": "joined",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Get list of conference calls

Retrieve a paginated list of conference calls for the authenticated customer.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Start media streaming for a conference

Start the in/out media streaming of the specified conference.

path Parameters
id
required
string

The ID of the conference

query Parameters
encapsulation
required
string
Example: encapsulation=mediasocket

The encapsulation for media stream.

Responses

Start conference recording

Initiate recording for the specified conference.

path Parameters
id
required
string

The ID of the conference

Request Body schema: application/json
required
format
required
string
Value: "wav"

The format of the recording.

duration
required
integer

The maximum duration of the recording (in seconds).

on_end_flow_id
required
string

The ID of the flow to be executed when the recording ends.

Responses

Request samples

Content type
application/json
{
  • "format": "wav",
  • "duration": 0,
  • "on_end_flow_id": "string"
}

Stop conference recording

Stop the ongoing recording for the specified conference.

path Parameters
id
required
string

The ID of the conference

Responses

Start conference transcription

Begin transcription for the specified conference.

path Parameters
id
required
string

The ID of the conference

Request Body schema: application/json
required
language
required
string

The language for transcription.

Responses

Request samples

Content type
application/json
{
  • "language": "en-US"
}

Stop conference transcription

Stop the ongoing transcription for the specified conference.

path Parameters
id
required
string

The ID of the conference

Responses

Get conference details

Retrieve detailed information about a specific conference.

path Parameters
id
required
string

The ID of the conference

Responses

Response samples

Content type
application/json
{
  • "id": "8b9c0d1e-2f3a-4567-0123-456789abcdef",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "conference",
  • "status": "progressing",
  • "name": "Team Standup",
  • "detail": "Daily team standup meeting",
  • "data": { },
  • "timeout": 3600,
  • "pre_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "post_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "conferencecall_ids": [
    ],
  • "recording_id": "e5f6a7b8-c9d0-1234-5678-90abcdef0123",
  • "recording_ids": [
    ],
  • "transcribe_id": "9c0d1e2f-3a4b-5678-1234-567890abcdef",
  • "transcribe_ids": [
    ],
  • "tm_end": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update conference details

Update the details of a specific conference.

path Parameters
id
required
string

The ID of the conference

Request Body schema: application/json
required
name
required
string
detail
required
string
required
object

Custom data associated with the conference.

timeout
required
integer
pre_flow_id
required
string
post_flow_id
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "data": { },
  • "timeout": 0,
  • "pre_flow_id": "string",
  • "post_flow_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "8b9c0d1e-2f3a-4567-0123-456789abcdef",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "conference",
  • "status": "progressing",
  • "name": "Team Standup",
  • "detail": "Daily team standup meeting",
  • "data": { },
  • "timeout": 3600,
  • "pre_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "post_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "conferencecall_ids": [
    ],
  • "recording_id": "e5f6a7b8-c9d0-1234-5678-90abcdef0123",
  • "recording_ids": [
    ],
  • "transcribe_id": "9c0d1e2f-3a4b-5678-1234-567890abcdef",
  • "transcribe_ids": [
    ],
  • "tm_end": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete a conference

Delete a specific conference. All participants will be removed.

path Parameters
id
required
string

The ID of the conference

Responses

Response samples

Content type
application/json
{
  • "id": "8b9c0d1e-2f3a-4567-0123-456789abcdef",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "conference",
  • "status": "progressing",
  • "name": "Team Standup",
  • "detail": "Daily team standup meeting",
  • "data": { },
  • "timeout": 3600,
  • "pre_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "post_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "conferencecall_ids": [
    ],
  • "recording_id": "e5f6a7b8-c9d0-1234-5678-90abcdef0123",
  • "recording_ids": [
    ],
  • "transcribe_id": "9c0d1e2f-3a4b-5678-1234-567890abcdef",
  • "transcribe_ids": [
    ],
  • "tm_end": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Get list of conferences

Retrieve a paginated list of conferences for the customer.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new conference

Create a new conference with the provided details.

Request Body schema: application/json
required
type
required
string (ConferenceManagerConferenceType)
Enum: "" "conference" "connect" "queue"

Types of conferences.

id
string
name
required
string
detail
required
string
timeout
required
integer
required
object

Custom data associated with the conference.

pre_flow_id
required
string
post_flow_id
required
string

Responses

Request samples

Content type
application/json
{
  • "type": "conference",
  • "id": "string",
  • "name": "string",
  • "detail": "string",
  • "timeout": 0,
  • "data": { },
  • "pre_flow_id": "string",
  • "post_flow_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "8b9c0d1e-2f3a-4567-0123-456789abcdef",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "conference",
  • "status": "progressing",
  • "name": "Team Standup",
  • "detail": "Daily team standup meeting",
  • "data": { },
  • "timeout": 3600,
  • "pre_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "post_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "conferencecall_ids": [
    ],
  • "recording_id": "e5f6a7b8-c9d0-1234-5678-90abcdef0123",
  • "recording_ids": [
    ],
  • "transcribe_id": "9c0d1e2f-3a4b-5678-1234-567890abcdef",
  • "transcribe_ids": [
    ],
  • "tm_end": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Conversation

Operations related to conversation

Find more about conversation

Get details of a conversation account

Fetches details of the conversation account specified by ID.

path Parameters
id
required
string

The ID of the conversation account.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "sms",
  • "name": "Main SMS Account",
  • "detail": "Primary SMS messaging account",
  • "secret": "whsec_...redacted...",
  • "token": "xoxb_...redacted...",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update a conversation account

Updates the details of the conversation account specified by ID.

path Parameters
id
required
string

The ID of the conversation account.

Request Body schema: application/json
required
name
string
detail
string
secret
string
token
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "secret": "string",
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "sms",
  • "name": "Main SMS Account",
  • "detail": "Primary SMS messaging account",
  • "secret": "whsec_...redacted...",
  • "token": "xoxb_...redacted...",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete a conversation account

Deletes the conversation account specified by ID.

path Parameters
id
required
string

The ID of the conversation account.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "sms",
  • "name": "Main SMS Account",
  • "detail": "Primary SMS messaging account",
  • "secret": "whsec_...redacted...",
  • "token": "xoxb_...redacted...",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Gets a list of conversation accounts

Fetches a paginated list of conversation accounts.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new conversation account

Creates a new conversation account and returns its details.

Request Body schema: application/json
required
type
required
string (ConversationManagerAccountType)
Enum: "line" "sms"

Type of the account.

name
required
string
detail
required
string
secret
required
string
token
required
string

Responses

Request samples

Content type
application/json
{
  • "type": "sms",
  • "name": "string",
  • "detail": "string",
  • "secret": "string",
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "sms",
  • "name": "Main SMS Account",
  • "detail": "Primary SMS messaging account",
  • "secret": "whsec_...redacted...",
  • "token": "xoxb_...redacted...",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Gets a list of conversation messages

Gets a paginated list of messages for a specific conversation.

path Parameters
id
required
string

The ID of the conversation.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Send a message

Sends a message to a specific conversation and returns the sent message info.

path Parameters
id
required
string

The ID of the conversation.

Request Body schema: application/json
required
text
required
string

The message text.

required
Array of objects (ConversationManagerMedia)

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "medias": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "conversation_id": "550e8400-e29b-41d4-a716-446655440000",
  • "direction": "incoming",
  • "status": "sent",
  • "reference_type": "call",
  • "reference_id": "f6a7b8c9-d0e1-2345-6789-0abcdef01234",
  • "text": "Hello, how can I help you today?",
  • "medias": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Returns detailed conversation info

Returns detailed information about a specific conversation by its ID.

path Parameters
id
required
string

The ID of the conversation.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
  • "account_id": "550e8400-e29b-41d4-a716-446655440000",
  • "name": "Customer Support Chat",
  • "detail": "Support conversation with customer",
  • "type": "message",
  • "dialog_id": "chatroom-abc123",
  • "self": {
    },
  • "peer": {
    },
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update conversation info

Updates the details of a specific conversation by its ID.

path Parameters
id
required
string

The ID of the conversation.

Request Body schema: application/json
required
owner_type
string
owner_id
string
name
string
detail
string

Responses

Request samples

Content type
application/json
{
  • "owner_type": "string",
  • "owner_id": "string",
  • "name": "string",
  • "detail": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
  • "account_id": "550e8400-e29b-41d4-a716-446655440000",
  • "name": "Customer Support Chat",
  • "detail": "Support conversation with customer",
  • "type": "message",
  • "dialog_id": "chatroom-abc123",
  • "self": {
    },
  • "peer": {
    },
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Gets a list of conversations

Gets a list of conversations with pagination. Filters can be provided in the request body.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Request Body schema: application/json
optional

Optional filters for searching conversations

customer_id
string <uuid>

Filter by customer ID

account_id
string <uuid>

Filter by account ID

dialog_id
string

Filter by dialog ID

type
string
Enum: "message" "line"

Filter by conversation type

deleted
boolean

Include deleted conversations if true

Responses

Request samples

Content type
application/json
{
  • "customer_id": "64a3cbd8-e863-11ec-85de-1bcd09d3872e",
  • "deleted": false
}

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Customer

Operations related to customer

Find more about customer

Update a customer's billing account ID

Modify the billing account ID associated with a customer.

Request Body schema: application/json
required

Billing account update payload

billing_account_id
required
string

The new billing account ID for the customer.

Responses

Request samples

Content type
application/json
{
  • "billing_account_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Acme Corporation",
  • "detail": "Enterprise customer account",
  • "email": "[email protected]",
  • "phone_number": "+14155551234",
  • "address": "123 Main St, San Francisco, CA 94105",
  • "webhook_method": "POST",
  • "webhook_uri": "https://api.acme.com/webhooks/voipbin",
  • "billing_account_id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  • "email_verified": true,
  • "status": "active",
  • "tm_deletion_scheduled": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Get customer info

Retrieve the information of the customer.

Responses

Response samples

Content type
application/json
{
  • "id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Acme Corporation",
  • "detail": "Enterprise customer account",
  • "email": "[email protected]",
  • "phone_number": "+14155551234",
  • "address": "123 Main St, San Francisco, CA 94105",
  • "webhook_method": "POST",
  • "webhook_uri": "https://api.acme.com/webhooks/voipbin",
  • "billing_account_id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  • "email_verified": true,
  • "status": "active",
  • "tm_deletion_scheduled": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update a customer

Update the information of a customer and retrieve the updated details.

Request Body schema: application/json
required

Customer update payload

name
required
string

The new name of the customer.

detail
required
string

Additional details about the customer.

email
required
string

The customer's email address.

phone_number
required
string

The customer's phone number.

address
required
string

The customer's address.

webhook_method
required
string (CustomerManagerCustomerWebhookMethod)
Enum: "" "POST" "GET" "PUT" "DELETE"

The HTTP method used for webhook (e.g., POST, GET, PUT, DELETE).

webhook_uri
required
string

Webhook URI.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "email": "string",
  • "phone_number": "string",
  • "address": "string",
  • "webhook_method": "POST",
  • "webhook_uri": "string"
}

Response samples

Content type
application/json
{
  • "id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Acme Corporation",
  • "detail": "Enterprise customer account",
  • "email": "[email protected]",
  • "phone_number": "+14155551234",
  • "address": "123 Main St, San Francisco, CA 94105",
  • "webhook_method": "POST",
  • "webhook_uri": "https://api.acme.com/webhooks/voipbin",
  • "billing_account_id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  • "email_verified": true,
  • "status": "active",
  • "tm_deletion_scheduled": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Schedule customer deletion (freeze account).

Marks the customer for deletion. The account enters 'frozen' state immediately. Active calls are terminated and new operations are blocked. The customer has 30 days to recover before permanent deletion. Admin-only endpoint.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Acme Corporation",
  • "detail": "Enterprise customer account",
  • "email": "[email protected]",
  • "phone_number": "+14155551234",
  • "address": "123 Main St, San Francisco, CA 94105",
  • "webhook_method": "POST",
  • "webhook_uri": "https://api.acme.com/webhooks/voipbin",
  • "billing_account_id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  • "email_verified": true,
  • "status": "active",
  • "tm_deletion_scheduled": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Cancel customer deletion (recover account).

Cancels a scheduled deletion and restores the account to active state. Only works during the 30-day grace period. Admin-only endpoint.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Acme Corporation",
  • "detail": "Enterprise customer account",
  • "email": "[email protected]",
  • "phone_number": "+14155551234",
  • "address": "123 Main St, San Francisco, CA 94105",
  • "webhook_method": "POST",
  • "webhook_uri": "https://api.acme.com/webhooks/voipbin",
  • "billing_account_id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  • "email_verified": true,
  • "status": "active",
  • "tm_deletion_scheduled": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update a customer's billing account ID.

Updates the billing account ID for a specific customer.

path Parameters
id
required
string
Request Body schema: application/json
required
billing_account_id
required
string

Responses

Request samples

Content type
application/json
{
  • "billing_account_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Acme Corporation",
  • "detail": "Enterprise customer account",
  • "email": "[email protected]",
  • "phone_number": "+14155551234",
  • "address": "123 Main St, San Francisco, CA 94105",
  • "webhook_method": "POST",
  • "webhook_uri": "https://api.acme.com/webhooks/voipbin",
  • "billing_account_id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  • "email_verified": true,
  • "status": "active",
  • "tm_deletion_scheduled": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Retrieve customer details.

Fetches detailed information about a specific customer by their ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Acme Corporation",
  • "detail": "Enterprise customer account",
  • "email": "[email protected]",
  • "phone_number": "+14155551234",
  • "address": "123 Main St, San Francisco, CA 94105",
  • "webhook_method": "POST",
  • "webhook_uri": "https://api.acme.com/webhooks/voipbin",
  • "billing_account_id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  • "email_verified": true,
  • "status": "active",
  • "tm_deletion_scheduled": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update a customer.

Updates the details of an existing customer and returns the updated information.

path Parameters
id
required
string
Request Body schema: application/json
required
name
required
string
detail
required
string
email
required
string
phone_number
required
string
address
required
string
webhook_method
required
string (CustomerManagerCustomerWebhookMethod)
Enum: "" "POST" "GET" "PUT" "DELETE"

The HTTP method used for webhook (e.g., POST, GET, PUT, DELETE).

webhook_uri
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "email": "string",
  • "phone_number": "string",
  • "address": "string",
  • "webhook_method": "POST",
  • "webhook_uri": "string"
}

Response samples

Content type
application/json
{
  • "id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Acme Corporation",
  • "detail": "Enterprise customer account",
  • "email": "[email protected]",
  • "phone_number": "+14155551234",
  • "address": "123 Main St, San Francisco, CA 94105",
  • "webhook_method": "POST",
  • "webhook_uri": "https://api.acme.com/webhooks/voipbin",
  • "billing_account_id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  • "email_verified": true,
  • "status": "active",
  • "tm_deletion_scheduled": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete a customer.

Removes a customer by their ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Acme Corporation",
  • "detail": "Enterprise customer account",
  • "email": "[email protected]",
  • "phone_number": "+14155551234",
  • "address": "123 Main St, San Francisco, CA 94105",
  • "webhook_method": "POST",
  • "webhook_uri": "https://api.acme.com/webhooks/voipbin",
  • "billing_account_id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  • "email_verified": true,
  • "status": "active",
  • "tm_deletion_scheduled": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Gets a list of customers.

Retrieves a paginated list of customers.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new customer.

Creates a new customer with the provided details and returns the created customer.

Request Body schema: application/json
required
name
required
string
detail
required
string
email
required
string
phone_number
required
string
address
required
string
webhook_method
required
string (CustomerManagerCustomerWebhookMethod)
Enum: "" "POST" "GET" "PUT" "DELETE"

The HTTP method used for webhook (e.g., POST, GET, PUT, DELETE).

webhook_uri
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "email": "string",
  • "phone_number": "string",
  • "address": "string",
  • "webhook_method": "POST",
  • "webhook_uri": "string"
}

Response samples

Content type
application/json
{
  • "id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Acme Corporation",
  • "detail": "Enterprise customer account",
  • "email": "[email protected]",
  • "phone_number": "+14155551234",
  • "address": "123 Main St, San Francisco, CA 94105",
  • "webhook_method": "POST",
  • "webhook_uri": "https://api.acme.com/webhooks/voipbin",
  • "billing_account_id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  • "email_verified": true,
  • "status": "active",
  • "tm_deletion_scheduled": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Extension

Operations related to extension

Find more about extension

Get extension details

Retrieves details of a specific extension by its ID.

path Parameters
id
required
string

The ID of the extension.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Reception Desk",
  • "detail": "Main reception extension for building A",
  • "extension": "1001",
  • "domain_name": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "1001",
  • "password": "s3cur3P@ss",
  • "direct_hash": "a8f3b2c1d4e5",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Update an extension

Updates an existing extension and returns the updated details.

path Parameters
id
required
string

The ID of the extension.

Request Body schema: application/json
required
name
required
string
detail
required
string
password
required
string
direct
boolean

Enable (true) or disable (false) direct extension access

direct_regenerate
boolean

Regenerate the direct extension hash (only when direct is enabled)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "password": "string",
  • "direct": true,
  • "direct_regenerate": true
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Reception Desk",
  • "detail": "Main reception extension for building A",
  • "extension": "1001",
  • "domain_name": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "1001",
  • "password": "s3cur3P@ss",
  • "direct_hash": "a8f3b2c1d4e5",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Delete an extension

Deletes an existing extension by its ID.

path Parameters
id
required
string

The ID of the extension.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Reception Desk",
  • "detail": "Main reception extension for building A",
  • "extension": "1001",
  • "domain_name": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "1001",
  • "password": "s3cur3P@ss",
  • "direct_hash": "a8f3b2c1d4e5",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Get a list of extensions

Retrieves a list of extensions.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new extension

Creates a new extension and returns its details.

Request Body schema: application/json
required
extension
required
string
password
required
string
name
required
string
detail
required
string

Responses

Request samples

Content type
application/json
{
  • "extension": "string",
  • "password": "string",
  • "name": "string",
  • "detail": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Reception Desk",
  • "detail": "Main reception extension for building A",
  • "extension": "1001",
  • "domain_name": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "1001",
  • "password": "s3cur3P@ss",
  • "direct_hash": "a8f3b2c1d4e5",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

File

Operations related to file

Returns detail file info

Retrieves detailed information about a file by its ID.

path Parameters
id
required
string

The ID of the file.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "reference_type": "recording",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "name": "meeting-recording.wav",
  • "detail": "Recording of the sales meeting",
  • "filename": "550e8400-e29b-41d4-a716-446655440000.wav",
  • "filesize": 5242880,
  • "uri_download": "https://storage.voipbin.net/files/550e8400-e29b-41d4-a716-446655440000.wav",
  • "tm_download_expire": "2026-02-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Delete a file

Deletes a file identified by its ID.

path Parameters
id
required
string

The ID of the file.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "reference_type": "recording",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "name": "meeting-recording.wav",
  • "detail": "Recording of the sales meeting",
  • "filename": "550e8400-e29b-41d4-a716-446655440000.wav",
  • "filesize": 5242880,
  • "uri_download": "https://storage.voipbin.net/files/550e8400-e29b-41d4-a716-446655440000.wav",
  • "tm_download_expire": "2026-02-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Gets a list of files

Retrieves a paginated list of files.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Upload file

Upload file.

Request Body schema: multipart/form-data
required
file
required
string <binary>

The file to be uploaded.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "reference_type": "recording",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "name": "meeting-recording.wav",
  • "detail": "Recording of the sales meeting",
  • "filename": "550e8400-e29b-41d4-a716-446655440000.wav",
  • "filesize": 5242880,
  • "uri_download": "https://storage.voipbin.net/files/550e8400-e29b-41d4-a716-446655440000.wav",
  • "tm_download_expire": "2026-02-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Flow

Operations related to flow

Find more about flow

Retrieve flow details

Retrieves the details of a specific flow by its ID.

path Parameters
id
required
string

The ID of the flow.

Responses

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "flow",
  • "name": "Inbound Call Handler",
  • "detail": "Main flow for handling inbound customer calls",
  • "actions": [
    ],
  • "on_complete_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update a flow

Updates the details of an existing flow and returns the updated information.

path Parameters
id
required
string

The ID of the flow.

Request Body schema: application/json
required
name
required
string

The updated name of the flow.

detail
required
string

The updated details of the flow.

required
Array of objects (FlowManagerAction)

Updated list of actions associated with the flow.

on_complete_flow_id
string

ID of the flow to be executed on completion.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "actions": [
    ],
  • "on_complete_flow_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "flow",
  • "name": "Inbound Call Handler",
  • "detail": "Main flow for handling inbound customer calls",
  • "actions": [
    ],
  • "on_complete_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete a flow

Deletes an existing flow by its ID.

path Parameters
id
required
string

The ID of the flow.

Responses

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "flow",
  • "name": "Inbound Call Handler",
  • "detail": "Main flow for handling inbound customer calls",
  • "actions": [
    ],
  • "on_complete_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Retrieve a list of flows

Retrieves a paginated list of flows accessible to the authenticated agent.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new flow

Creates a new flow with the provided details and returns the created flow's information.

Request Body schema: application/json
required
name
required
string

The name of the flow.

detail
required
string

Detailed information about the flow.

required
Array of objects (FlowManagerAction)

List of actions associated with the flow.

on_complete_flow_id
string

The ID of the flow to execute upon completion.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "actions": [
    ],
  • "on_complete_flow_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "flow",
  • "name": "Inbound Call Handler",
  • "detail": "Main flow for handling inbound customer calls",
  • "actions": [
    ],
  • "on_complete_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Groupcall

Operations related to groupcall

Find more about groupcall

Hangup the groupcall

Ends the groupcall with the specified ID.

path Parameters
id
required
string

The ID of the groupcall.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
  • "status": "progressing",
  • "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "source": {
    },
  • "destinations": [
    ],
  • "master_call_id": "4d5e6f7a-8b9c-0123-def0-123456789012",
  • "master_groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
  • "ring_method": "ring_all",
  • "answer_method": "hangup_others",
  • "answer_call_id": "550e8400-e29b-41d4-a716-446655440000",
  • "call_ids": [
    ],
  • "answer_groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
  • "groupcall_ids": [
    ],
  • "call_count": 2,
  • "groupcall_count": 1,
  • "dial_index": 0,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Get detailed information of a groupcall

Returns the details of the groupcall with the specified ID.

path Parameters
id
required
string

The ID of the groupcall.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
  • "status": "progressing",
  • "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "source": {
    },
  • "destinations": [
    ],
  • "master_call_id": "4d5e6f7a-8b9c-0123-def0-123456789012",
  • "master_groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
  • "ring_method": "ring_all",
  • "answer_method": "hangup_others",
  • "answer_call_id": "550e8400-e29b-41d4-a716-446655440000",
  • "call_ids": [
    ],
  • "answer_groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
  • "groupcall_ids": [
    ],
  • "call_count": 2,
  • "groupcall_count": 1,
  • "dial_index": 0,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete a groupcall

Deletes the groupcall with the specified ID.

path Parameters
id
required
string

The ID of the groupcall.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
  • "status": "progressing",
  • "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "source": {
    },
  • "destinations": [
    ],
  • "master_call_id": "4d5e6f7a-8b9c-0123-def0-123456789012",
  • "master_groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
  • "ring_method": "ring_all",
  • "answer_method": "hangup_others",
  • "answer_call_id": "550e8400-e29b-41d4-a716-446655440000",
  • "call_ids": [
    ],
  • "answer_groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
  • "groupcall_ids": [
    ],
  • "call_count": 2,
  • "groupcall_count": 1,
  • "dial_index": 0,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Get a list of groupcalls

Retrieves a list of groupcalls based on the provided parameters.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new groupcall

Creates a new groupcall with the specified information and returns the created groupcall.

Request Body schema: application/json
required
object (CommonAddress)

Contains source or destination detail info.

required
Array of objects (CommonAddress)
flow_id
required
string
required
Array of objects (FlowManagerAction)
ring_method
required
string (CallManagerGroupcallRingMethod)
Enum: "" "ring_all" "linear"

Method used for dialing

answer_method
required
string (CallManagerGroupcallAnswerMethod)
Enum: "" "hangup_others"

Method to handle answered calls

Responses

Request samples

Content type
application/json
{
  • "source": {
    },
  • "destinations": [
    ],
  • "flow_id": "string",
  • "actions": [
    ],
  • "ring_method": "ring_all",
  • "answer_method": "hangup_others"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
  • "status": "progressing",
  • "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "source": {
    },
  • "destinations": [
    ],
  • "master_call_id": "4d5e6f7a-8b9c-0123-def0-123456789012",
  • "master_groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
  • "ring_method": "ring_all",
  • "answer_method": "hangup_others",
  • "answer_call_id": "550e8400-e29b-41d4-a716-446655440000",
  • "call_ids": [
    ],
  • "answer_groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
  • "groupcall_ids": [
    ],
  • "call_count": 2,
  • "groupcall_count": 1,
  • "dial_index": 0,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Me

Operations related to myself data

Get the logged-in agent

Retrieves the information of the currently logged-in agent.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "[email protected]",
  • "name": "John Smith",
  • "detail": "Senior support agent",
  • "ring_method": "ringall",
  • "status": "available",
  • "permission": 64,
  • "tag_ids": [
    ],
  • "addresses": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T10:00:00.000000Z"
}

Message

Operations related to message

Find more about message

Get a message by ID

Retrieves the message of the given ID.

path Parameters
id
required
string

The ID of the message.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "sms",
  • "source": {
    },
  • "targets": [
    ],
  • "text": "Your appointment is confirmed for tomorrow at 2 PM.",
  • "direction": "outbound",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete a message by ID

Deletes the message with the given ID and returns the deleted message.

path Parameters
id
required
string

The ID of the message to delete.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "sms",
  • "source": {
    },
  • "targets": [
    ],
  • "text": "Your appointment is confirmed for tomorrow at 2 PM.",
  • "direction": "outbound",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

List all messages

Retrieves a list of messages for the given customer.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Send a message and return the sent message

Sends a message with the provided information and returns the sent message details.

Request Body schema: application/json
required
object (CommonAddress)

Contains source or destination detail info.

required
Array of objects (CommonAddress)

List of destinations for the message.

text
required
string

The content of the message.

Responses

Request samples

Content type
application/json
{
  • "source": {
    },
  • "destinations": [
    ],
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "sms",
  • "source": {
    },
  • "targets": [
    ],
  • "text": "Your appointment is confirmed for tomorrow at 2 PM.",
  • "direction": "outbound",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Number

Operations related to number

Find more about number

List available numbers

Get available phone numbers for the specified country or virtual numbers.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

country_code
string

The ISO country code. Required when type is not virtual.

type
string (NumberManagerNumberType)
Enum: "normal" "virtual"
Example: type=normal

The type of available numbers to retrieve (normal or virtual). Defaults to normal.

Responses

Response samples

Content type
application/json
{
  • "result": [
    ]
}

Update the order number's flow ID

Update the flow ID of the order number identified by the provided ID.

path Parameters
id
required
string

The ID of the order number to update.

Request Body schema: application/json
call_flow_id
required
string

The ID of the updated call flow.

message_flow_id
required
string

The ID of the updated message flow.

Responses

Request samples

Content type
application/json
{
  • "call_flow_id": "string",
  • "message_flow_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "number": "+14155551234",
  • "type": "normal",
  • "call_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "message_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "name": "Main Support Line",
  • "detail": "Primary inbound number for customer support",
  • "status": "active",
  • "t38_enabled": false,
  • "emergency_enabled": false,
  • "tm_purchase": "2026-01-15T09:30:00.000000Z",
  • "tm_renew": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Get order number by ID

Get the details of the order number identified by the provided ID.

path Parameters
id
required
string

The ID of the order number.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "number": "+14155551234",
  • "type": "normal",
  • "call_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "message_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "name": "Main Support Line",
  • "detail": "Primary inbound number for customer support",
  • "status": "active",
  • "t38_enabled": false,
  • "emergency_enabled": false,
  • "tm_purchase": "2026-01-15T09:30:00.000000Z",
  • "tm_renew": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete order number by ID

Delete the order number identified by the provided ID.

path Parameters
id
required
string

The ID of the order number to delete.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "number": "+14155551234",
  • "type": "normal",
  • "call_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "message_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "name": "Main Support Line",
  • "detail": "Primary inbound number for customer support",
  • "status": "active",
  • "t38_enabled": false,
  • "emergency_enabled": false,
  • "tm_purchase": "2026-01-15T09:30:00.000000Z",
  • "tm_renew": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update order number by ID

Update the order number's details with the provided information.

path Parameters
id
required
string

The ID of the order number to update.

Request Body schema: application/json
call_flow_id
required
string

The ID of the updated call flow.

message_flow_id
required
string

The ID of the updated message flow.

name
required
string

The updated name of the number.

detail
required
string

Updated details for the number.

Responses

Request samples

Content type
application/json
{
  • "call_flow_id": "string",
  • "message_flow_id": "string",
  • "name": "string",
  • "detail": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "number": "+14155551234",
  • "type": "normal",
  • "call_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "message_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "name": "Main Support Line",
  • "detail": "Primary inbound number for customer support",
  • "status": "active",
  • "t38_enabled": false,
  • "emergency_enabled": false,
  • "tm_purchase": "2026-01-15T09:30:00.000000Z",
  • "tm_renew": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

List order numbers

Get a list of order numbers based on the customer's information.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new number

Create a new order number and return the details of the created number.

Request Body schema: application/json
required
number
required
string

The phone number.

type
string (NumberManagerNumberType)
Enum: "normal" "virtual"

The type of the number.

call_flow_id
required
string

The ID of the call flow.

message_flow_id
required
string

The ID of the message flow.

name
required
string

The name of the number.

detail
required
string

Additional details about the number.

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "type": "normal",
  • "call_flow_id": "string",
  • "message_flow_id": "string",
  • "name": "string",
  • "detail": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "number": "+14155551234",
  • "type": "normal",
  • "call_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "message_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "name": "Main Support Line",
  • "detail": "Primary inbound number for customer support",
  • "status": "active",
  • "t38_enabled": false,
  • "emergency_enabled": false,
  • "tm_purchase": "2026-01-15T09:30:00.000000Z",
  • "tm_renew": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Renew the numbers

Renew the specified numbers and return the updated number details.

Request Body schema: application/json
tm_renew
required
string

The timestamp for renewing the number.

Responses

Request samples

Content type
application/json
{
  • "tm_renew": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Outdial

Operations related to outdial

Find more about outdial

Update an outdial's campaign ID.

Updates the campaign ID of the specified outdial and returns the updated outdial information.

path Parameters
id
required
string

The ID of the outdial to update.

Request Body schema: application/json
campaign_id
required
string

Responses

Request samples

Content type
application/json
{
  • "campaign_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "name": "Q1 Target List",
  • "detail": "Outbound dial list for Q1 campaign",
  • "data": "custom-data",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update an outdial's data.

Updates the data of the specified outdial and returns the updated outdial details.

path Parameters
id
required
string

The ID of the outdial to update.

Request Body schema: application/json
data
required
string

Responses

Request samples

Content type
application/json
{
  • "data": "string"
}

Response samples

Content type
application/json
{
  • "id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "name": "Q1 Target List",
  • "detail": "Outbound dial list for Q1 campaign",
  • "data": "custom-data",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Retrieve an outdial target by its ID.

Gets the details of a specific outdial target using its ID.

path Parameters
id
required
string

The ID of the outdial.

target_id
required
string

The ID of the outdial target.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "outdial_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "name": "John Smith",
  • "detail": "Priority customer",
  • "data": "vip-tag",
  • "status": "idle",
  • "destination_0": {
    },
  • "destination_1": {
    },
  • "destination_2": {
    },
  • "destination_3": {
    },
  • "destination_4": {
    },
  • "try_count_0": 0,
  • "try_count_1": 0,
  • "try_count_2": 0,
  • "try_count_3": 0,
  • "try_count_4": 0,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete an outdial target.

Deletes a specific outdial target based on its ID.

path Parameters
id
required
string

The ID of the outdial to delete the target from.

target_id
required
string

The ID of the target to delete.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "outdial_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "name": "John Smith",
  • "detail": "Priority customer",
  • "data": "vip-tag",
  • "status": "idle",
  • "destination_0": {
    },
  • "destination_1": {
    },
  • "destination_2": {
    },
  • "destination_3": {
    },
  • "destination_4": {
    },
  • "try_count_0": 0,
  • "try_count_1": 0,
  • "try_count_2": 0,
  • "try_count_3": 0,
  • "try_count_4": 0,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Retrieve a list of outdial targets.

Gets a list of outdial targets based on the specified page size and page token.

path Parameters
id
required
string

The ID of the outdial to associate with the target.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new target for an outdial.

Creates a new target for the specified outdial and returns the created target information.

path Parameters
id
required
string

The ID of the outdial to associate with the target.

Request Body schema: application/json
name
required
string
detail
required
string
data
required
string
required
object (CommonAddress)

Contains source or destination detail info.

required
object (CommonAddress)

Contains source or destination detail info.

required
object (CommonAddress)

Contains source or destination detail info.

required
object (CommonAddress)

Contains source or destination detail info.

required
object (CommonAddress)

Contains source or destination detail info.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "data": "string",
  • "destination_0": {
    },
  • "destination_1": {
    },
  • "destination_2": {
    },
  • "destination_3": {
    },
  • "destination_4": {
    }
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "outdial_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "name": "John Smith",
  • "detail": "Priority customer",
  • "data": "vip-tag",
  • "status": "idle",
  • "destination_0": {
    },
  • "destination_1": {
    },
  • "destination_2": {
    },
  • "destination_3": {
    },
  • "destination_4": {
    },
  • "try_count_0": 0,
  • "try_count_1": 0,
  • "try_count_2": 0,
  • "try_count_3": 0,
  • "try_count_4": 0,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Retrieve an outdial by its ID.

Returns detailed information of a specific outdial based on the provided ID.

path Parameters
id
required
string

The ID of the outdial to retrieve.

Responses

Response samples

Content type
application/json
{
  • "id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "name": "Q1 Target List",
  • "detail": "Outbound dial list for Q1 campaign",
  • "data": "custom-data",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete an existing outdial.

Deletes an outdial specified by its ID.

path Parameters
id
required
string

The ID of the outdial to delete.

Responses

Response samples

Content type
application/json
{
  • "id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "name": "Q1 Target List",
  • "detail": "Outbound dial list for Q1 campaign",
  • "data": "custom-data",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update an outdial.

Updates the specified outdial and returns the updated information.

path Parameters
id
required
string

The ID of the outdial to update.

Request Body schema: application/json
name
required
string
detail
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string"
}

Response samples

Content type
application/json
{
  • "id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "name": "Q1 Target List",
  • "detail": "Outbound dial list for Q1 campaign",
  • "data": "custom-data",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Retrieve a list of outdials.

Gets a list of outdials based on the specified page size and page token.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new outdial.

Creates a new outdial with the specified information and returns the created outdial details.

Request Body schema: application/json
campaign_id
required
string
name
required
string
detail
required
string
data
required
string

Responses

Request samples

Content type
application/json
{
  • "campaign_id": "string",
  • "name": "string",
  • "detail": "string",
  • "data": "string"
}

Response samples

Content type
application/json
{
  • "id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "campaign_id": "c3d4e5f6-a7b8-9012-3456-7890abcdef01",
  • "name": "Q1 Target List",
  • "detail": "Outbound dial list for Q1 campaign",
  • "data": "custom-data",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Outplan

Operations related to outplan

Find more about outplan

Update dial information of an existing outplan.

Updates the dial information for the outplan specified by the given ID and returns the updated outplan.

path Parameters
id
required
string

The ID of the outplan to update.

Request Body schema: application/json
required
required
object (CommonAddress)

Contains source or destination detail info.

dial_timeout
required
integer

The new dial timeout in seconds.

try_interval
required
integer

The new interval between retry attempts.

max_try_count_0
required
integer

The new maximum retry count for destination 0.

max_try_count_1
required
integer

The new maximum retry count for destination 1.

max_try_count_2
required
integer

The new maximum retry count for destination 2.

max_try_count_3
required
integer

The new maximum retry count for destination 3.

max_try_count_4
required
integer

The new maximum retry count for destination 4.

Responses

Request samples

Content type
application/json
{
  • "source": {
    },
  • "dial_timeout": 0,
  • "try_interval": 0,
  • "max_try_count_0": 0,
  • "max_try_count_1": 0,
  • "max_try_count_2": 0,
  • "max_try_count_3": 0,
  • "max_try_count_4": 0
}

Response samples

Content type
application/json
{
  • "id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Standard Outbound Plan",
  • "detail": "Default outbound dialing plan for campaigns",
  • "source": {
    },
  • "dial_timeout": 30000,
  • "try_interval": 60000,
  • "max_try_count_0": 3,
  • "max_try_count_1": 2,
  • "max_try_count_2": 1,
  • "max_try_count_3": 1,
  • "max_try_count_4": 1,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Retrieve outplan details by ID.

Retrieves the details of the specified outplan based on the given ID.

path Parameters
id
required
string

The unique identifier of the outplan.

Responses

Response samples

Content type
application/json
{
  • "id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Standard Outbound Plan",
  • "detail": "Default outbound dialing plan for campaigns",
  • "source": {
    },
  • "dial_timeout": 30000,
  • "try_interval": 60000,
  • "max_try_count_0": 3,
  • "max_try_count_1": 2,
  • "max_try_count_2": 1,
  • "max_try_count_3": 1,
  • "max_try_count_4": 1,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete an existing outplan.

Deletes the outplan specified by the given ID.

path Parameters
id
required
string

The ID of the outplan to delete.

Responses

Response samples

Content type
application/json
{
  • "id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Standard Outbound Plan",
  • "detail": "Default outbound dialing plan for campaigns",
  • "source": {
    },
  • "dial_timeout": 30000,
  • "try_interval": 60000,
  • "max_try_count_0": 3,
  • "max_try_count_1": 2,
  • "max_try_count_2": 1,
  • "max_try_count_3": 1,
  • "max_try_count_4": 1,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update dial information of an existing outplan.

Updates the dial information for the outplan specified by the given ID and returns the updated outplan.

path Parameters
id
required
string

The ID of the outplan to update.

Request Body schema: application/json
required
name
required
string

The new name of the outplan.

detail
required
string

The new detail of the outplan.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string"
}

Response samples

Content type
application/json
{
  • "id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Standard Outbound Plan",
  • "detail": "Default outbound dialing plan for campaigns",
  • "source": {
    },
  • "dial_timeout": 30000,
  • "try_interval": 60000,
  • "max_try_count_0": 3,
  • "max_try_count_1": 2,
  • "max_try_count_2": 1,
  • "max_try_count_3": 1,
  • "max_try_count_4": 1,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Retrieve a list of outplans.

Retrieves a paginated list of outplans based on the provided parameters.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new outplan.

Creates a new outplan with the provided details and returns the created outplan.

Request Body schema: application/json
required
name
required
string

The name of the outplan.

detail
required
string

Additional details about the outplan.

required
object (CommonAddress)

Contains source or destination detail info.

dial_timeout
required
integer

The dial timeout in seconds.

try_interval
required
integer

The interval between retry attempts.

max_try_count_0
required
integer

Maximum retry count for destination 0.

max_try_count_1
required
integer

Maximum retry count for destination 1.

max_try_count_2
required
integer

Maximum retry count for destination 2.

max_try_count_3
required
integer

Maximum retry count for destination 3.

max_try_count_4
required
integer

Maximum retry count for destination 4.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "source": {
    },
  • "dial_timeout": 0,
  • "try_interval": 0,
  • "max_try_count_0": 0,
  • "max_try_count_1": 0,
  • "max_try_count_2": 0,
  • "max_try_count_3": 0,
  • "max_try_count_4": 0
}

Response samples

Content type
application/json
{
  • "id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Standard Outbound Plan",
  • "detail": "Default outbound dialing plan for campaigns",
  • "source": {
    },
  • "dial_timeout": 30000,
  • "try_interval": 60000,
  • "max_try_count_0": 3,
  • "max_try_count_1": 2,
  • "max_try_count_2": 1,
  • "max_try_count_3": 1,
  • "max_try_count_4": 1,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Provider

Operations related to provider

Find more about provider

Get provider by ID

Retrieves the provider details for the specified ID.

path Parameters
id
required
string

The ID of the provider

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "type": "sip",
  • "hostname": "sip.provider.example.com",
  • "tech_prefix": "9",
  • "tech_postfix": "#",
  • "tech_headers": {
    },
  • "name": "Twilio SIP Provider",
  • "detail": "Primary outbound SIP provider",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Delete provider by ID

Deletes the provider with the specified ID.

path Parameters
id
required
string

The ID of the provider to delete.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "type": "sip",
  • "hostname": "sip.provider.example.com",
  • "tech_prefix": "9",
  • "tech_postfix": "#",
  • "tech_headers": {
    },
  • "name": "Twilio SIP Provider",
  • "detail": "Primary outbound SIP provider",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Update provider information

Updates the provider details for the given ID with the provided information.

path Parameters
id
required
string

The ID of the provider to update.

Request Body schema: application/json
type
required
string (RouteManagerProviderType)
Value: "sip"

Defines the type of the provider. Currently, only 'sip' is supported for VoIP/SIP providers.

hostname
required
string
tech_prefix
required
string
tech_postfix
required
string
tech_headers
required
object
name
required
string
detail
required
string

Responses

Request samples

Content type
application/json
{
  • "type": "sip",
  • "hostname": "string",
  • "tech_prefix": "string",
  • "tech_postfix": "string",
  • "tech_headers": { },
  • "name": "string",
  • "detail": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "type": "sip",
  • "hostname": "sip.provider.example.com",
  • "tech_prefix": "9",
  • "tech_postfix": "#",
  • "tech_headers": {
    },
  • "name": "Twilio SIP Provider",
  • "detail": "Primary outbound SIP provider",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

List providers of the given customer

Returns a list of providers for the authenticated customer.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new provider

Creates a new provider with the provided details.

Request Body schema: application/json
type
required
string (RouteManagerProviderType)
Value: "sip"

Defines the type of the provider. Currently, only 'sip' is supported for VoIP/SIP providers.

hostname
required
string
tech_prefix
required
string
tech_postfix
required
string
tech_headers
required
object
name
required
string
detail
required
string

Responses

Request samples

Content type
application/json
{
  • "type": "sip",
  • "hostname": "string",
  • "tech_prefix": "string",
  • "tech_postfix": "string",
  • "tech_headers": { },
  • "name": "string",
  • "detail": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "type": "sip",
  • "hostname": "sip.provider.example.com",
  • "tech_prefix": "9",
  • "tech_postfix": "#",
  • "tech_headers": {
    },
  • "name": "Twilio SIP Provider",
  • "detail": "Primary outbound SIP provider",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Queue

Operations related to queue

Find more about queue

Kick a queue call from the queue

Removes the specified queue call from the queue.

path Parameters
id
required
string

The ID of the queue call.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "reference_type": "call",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "status": "waiting",
  • "service_agent_id": "c3d4e5f6-a7b8-9c0d-1e2f-3a4b5c6d7e8f",
  • "duration_waiting": 45000,
  • "duration_service": 180000,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_service": "2026-01-15T09:35:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Get detailed queue call information

Returns detailed information for the specified queue call ID.

path Parameters
id
required
string

The ID of the queue call.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "reference_type": "call",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "status": "waiting",
  • "service_agent_id": "c3d4e5f6-a7b8-9c0d-1e2f-3a4b5c6d7e8f",
  • "duration_waiting": 45000,
  • "duration_service": 180000,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_service": "2026-01-15T09:35:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Delete a queue call

Deletes the specified queue call.

path Parameters
id
required
string

The ID of the queue call to delete.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "reference_type": "call",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "status": "waiting",
  • "service_agent_id": "c3d4e5f6-a7b8-9c0d-1e2f-3a4b5c6d7e8f",
  • "duration_waiting": 45000,
  • "duration_service": 180000,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_service": "2026-01-15T09:35:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

List queue calls

Returns a list of queue calls for the given customer.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Kick a queue call by reference ID

Removes the queue call associated with the given reference ID from the queue.

path Parameters
id
required
string

The reference ID of the queue call.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "reference_type": "call",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "status": "waiting",
  • "service_agent_id": "c3d4e5f6-a7b8-9c0d-1e2f-3a4b5c6d7e8f",
  • "duration_waiting": 45000,
  • "duration_service": 180000,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_service": "2026-01-15T09:35:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Update the queue's routing method

Updates the routing method of the specified queue.

path Parameters
id
required
string
Request Body schema: application/json
routing_method
required
string (QueueManagerQueueRoutingMethod)
Enum: "" "random"

Responses

Request samples

Content type
application/json
{
  • "routing_method": "random"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Sales Queue",
  • "detail": "Handles incoming sales inquiries",
  • "routing_method": "random",
  • "tag_ids": [
    ],
  • "wait_flow_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "wait_timeout": 300000,
  • "service_timeout": 600000,
  • "wait_queuecall_ids": [
    ],
  • "service_queuecall_ids": [
    ],
  • "total_incoming_count": 150,
  • "total_serviced_count": 120,
  • "total_abandoned_count": 10,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Update the queue's tag IDs

Updates the tag IDs of the specified queue.

path Parameters
id
required
string
Request Body schema: application/json
tag_ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "tag_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Sales Queue",
  • "detail": "Handles incoming sales inquiries",
  • "routing_method": "random",
  • "tag_ids": [
    ],
  • "wait_flow_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "wait_timeout": 300000,
  • "service_timeout": 600000,
  • "wait_queuecall_ids": [
    ],
  • "service_queuecall_ids": [
    ],
  • "total_incoming_count": 150,
  • "total_serviced_count": 120,
  • "total_abandoned_count": 10,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Get the queue by ID

Retrieves the details of a specific queue by its ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Sales Queue",
  • "detail": "Handles incoming sales inquiries",
  • "routing_method": "random",
  • "tag_ids": [
    ],
  • "wait_flow_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "wait_timeout": 300000,
  • "service_timeout": 600000,
  • "wait_queuecall_ids": [
    ],
  • "service_queuecall_ids": [
    ],
  • "total_incoming_count": 150,
  • "total_serviced_count": 120,
  • "total_abandoned_count": 10,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Delete a queue by ID

Deletes the queue specified by the given ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Sales Queue",
  • "detail": "Handles incoming sales inquiries",
  • "routing_method": "random",
  • "tag_ids": [
    ],
  • "wait_flow_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "wait_timeout": 300000,
  • "service_timeout": 600000,
  • "wait_queuecall_ids": [
    ],
  • "service_queuecall_ids": [
    ],
  • "total_incoming_count": 150,
  • "total_serviced_count": 120,
  • "total_abandoned_count": 10,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Update the queue details

Updates the details of the queue identified by the given ID.

path Parameters
id
required
string
Request Body schema: application/json
required
name
required
string
detail
required
string
routing_method
required
string (QueueManagerQueueRoutingMethod)
Enum: "" "random"
tag_ids
required
Array of strings
wait_flow_id
required
string

Flow ID for the wait queue.

wait_timeout
required
integer
service_timeout
required
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "routing_method": "random",
  • "tag_ids": [
    ],
  • "wait_flow_id": "string",
  • "wait_timeout": 0,
  • "service_timeout": 0
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Sales Queue",
  • "detail": "Handles incoming sales inquiries",
  • "routing_method": "random",
  • "tag_ids": [
    ],
  • "wait_flow_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "wait_timeout": 300000,
  • "service_timeout": 600000,
  • "wait_queuecall_ids": [
    ],
  • "service_queuecall_ids": [
    ],
  • "total_incoming_count": 150,
  • "total_serviced_count": 120,
  • "total_abandoned_count": 10,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

List queues of the customer

Retrieves a list of queues associated with the customer.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new queue

Creates a new queue with the provided details.

Request Body schema: application/json
name
required
string
detail
required
string
routing_method
required
string (QueueManagerQueueRoutingMethod)
Enum: "" "random"
tag_ids
required
Array of strings
wait_flow_id
required
string

Flow ID for the wait queue.

wait_timeout
required
integer
service_timeout
required
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "routing_method": "random",
  • "tag_ids": [
    ],
  • "wait_flow_id": "string",
  • "wait_timeout": 0,
  • "service_timeout": 0
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Sales Queue",
  • "detail": "Handles incoming sales inquiries",
  • "routing_method": "random",
  • "tag_ids": [
    ],
  • "wait_flow_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "wait_timeout": 300000,
  • "service_timeout": 600000,
  • "wait_queuecall_ids": [
    ],
  • "service_queuecall_ids": [
    ],
  • "total_incoming_count": 150,
  • "total_serviced_count": 120,
  • "total_abandoned_count": 10,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Recording

Operations related to recording

Find more about recording

Download the recording file

Retrieves the specified recording file and redirects to the download URI.

path Parameters
id
required
string

The recording file's ID.

Responses

Response samples

Content type
application/json
"string"

Get recording details

Retrieves detailed information about a specific recording.

path Parameters
id
required
string

The recording's ID.

Responses

Response samples

Content type
application/json
{
  • "id": "e5f6a7b8-c9d0-1234-5678-90abcdef0123",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "call",
  • "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
  • "reference_type": "call",
  • "reference_id": "f6a7b8c9-d0e1-2345-6789-0abcdef01234",
  • "status": "recording",
  • "format": "wav",
  • "activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "on_end_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "tm_start": "2026-01-15T09:30:00.000000Z",
  • "tm_end": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete recording

Deletes the specified recording and returns the deleted recording information.

path Parameters
id
required
string

The recording's ID.

Responses

Response samples

Content type
application/json
{
  • "id": "e5f6a7b8-c9d0-1234-5678-90abcdef0123",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "call",
  • "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
  • "reference_type": "call",
  • "reference_id": "f6a7b8c9-d0e1-2345-6789-0abcdef01234",
  • "status": "recording",
  • "format": "wav",
  • "activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "on_end_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "tm_start": "2026-01-15T09:30:00.000000Z",
  • "tm_end": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

List recordings

Retrieves a list of recordings for the given customer.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Route

Operations related to route

Find more about route

Get a route

Returns the details of the route for the given ID.

path Parameters
id
required
string

The route's ID.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "US Outbound Route",
  • "detail": "Routes calls to US numbers via primary provider",
  • "provider_id": "e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b",
  • "priority": 1,
  • "target": "1",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Delete the route

Deletes the route for the given ID.

path Parameters
id
required
string

The route's ID.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "US Outbound Route",
  • "detail": "Routes calls to US numbers via primary provider",
  • "provider_id": "e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b",
  • "priority": 1,
  • "target": "1",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Update a route

Updates a route with the provided details and returns the updated route.

path Parameters
id
required
string

The route's ID.

Request Body schema: application/json
required
name
required
string

The name of the route.

detail
required
string

The detail information of the route.

provider_id
required
string

The provider ID for the route.

priority
required
integer

The priority of the route.

target
required
string

The target of the route.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "provider_id": "string",
  • "priority": 0,
  • "target": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "US Outbound Route",
  • "detail": "Routes calls to US numbers via primary provider",
  • "provider_id": "e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b",
  • "priority": 1,
  • "target": "1",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

List routes

Returns a list of routes for the given customer with pagination.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

customer_id
string

target customer id

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new route

Creates a new route with the provided details.

Request Body schema: application/json
required
customer_id
required
string

The ID of the customer for the route.

name
required
string

The name of the route.

detail
required
string

The detail information of the route.

provider_id
required
string

The provider ID for the route.

priority
required
integer

The priority of the route.

target
required
string

The target of the route.

Responses

Request samples

Content type
application/json
{
  • "customer_id": "string",
  • "name": "string",
  • "detail": "string",
  • "provider_id": "string",
  • "priority": 0,
  • "target": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "US Outbound Route",
  • "detail": "Routes calls to US numbers via primary provider",
  • "provider_id": "e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b",
  • "priority": 1,
  • "target": "1",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Service Agent

Operations related to individual agent service

Retrieve detailed information of a service agent

Fetches detailed information of a specific service agent by its ID.

path Parameters
id
required
string

The ID of the service agent.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "[email protected]",
  • "name": "John Smith",
  • "detail": "Senior support agent",
  • "ring_method": "ringall",
  • "status": "available",
  • "permission": 64,
  • "tag_ids": [
    ],
  • "addresses": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T10:00:00.000000Z"
}

Retrieve a list of service agents

Fetches a list of service agents with pagination support.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Retrieve detailed information of a specific call

Fetches detailed information about a specific call by its ID.

path Parameters
id
required
string

The ID of the call.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
  • "flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "type": "flow",
  • "master_call_id": "4d5e6f7a-8b9c-0123-def0-123456789012",
  • "chained_call_ids": [
    ],
  • "recording_id": "e5f6a7b8-c9d0-1234-5678-90abcdef0123",
  • "recording_ids": [
    ],
  • "groupcall_id": "5e6f7a8b-9c0d-1234-ef01-234567890123",
  • "source": {
    },
  • "destination": {
    },
  • "status": "progressing",
  • "action": {
    },
  • "direction": "outgoing",
  • "mute_direction": "both",
  • "hangup_by": "remote",
  • "hangup_reason": "normal",
  • "tm_progressing": "2026-01-15T09:30:00.000000Z",
  • "tm_ringing": "2026-01-15T09:30:00.000000Z",
  • "tm_hangup": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Retrieve a list of calls for the given customer

Fetches a list of calls for the given service agent, with pagination support.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Get list of conversation messages

Retrieves a paginated list of messages for a specific conversation.

path Parameters
id
required
string

The ID of the conversation.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Send a message to the conversation

Sends a message to a specific conversation and returns the details of the sent message.

path Parameters
id
required
string

The ID of the conversation.

Request Body schema: application/json
required

The details of the message to be sent.

text
required
string

The text content of the message.

required
Array of objects (ConversationManagerMedia)

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "medias": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "conversation_id": "550e8400-e29b-41d4-a716-446655440000",
  • "direction": "incoming",
  • "status": "sent",
  • "reference_type": "call",
  • "reference_id": "f6a7b8c9-d0e1-2345-6789-0abcdef01234",
  • "text": "Hello, how can I help you today?",
  • "medias": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Get detailed conversation info

Retrieves detailed information about a specific conversation by its ID.

path Parameters
id
required
string

The ID of the conversation.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
  • "account_id": "550e8400-e29b-41d4-a716-446655440000",
  • "name": "Customer Support Chat",
  • "detail": "Support conversation with customer",
  • "type": "message",
  • "dialog_id": "chatroom-abc123",
  • "self": {
    },
  • "peer": {
    },
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Get list of conversations

Retrieves a paginated list of conversations associated with the authenticated agent.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Get customer details

Retrieves detailed information about the customer associated with the authenticated agent.

Responses

Response samples

Content type
application/json
{
  • "id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Acme Corporation",
  • "detail": "Enterprise customer account",
  • "email": "[email protected]",
  • "phone_number": "+14155551234",
  • "address": "123 Main St, San Francisco, CA 94105",
  • "webhook_method": "POST",
  • "webhook_uri": "https://api.acme.com/webhooks/voipbin",
  • "billing_account_id": "b8c9d0e1-f2a3-4567-8901-23456789abcd",
  • "email_verified": true,
  • "status": "active",
  • "tm_deletion_scheduled": "2026-01-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Get extension details

Retrieves detailed information about a specific extension by its ID.

path Parameters
id
required
string

The ID of the extension.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Reception Desk",
  • "detail": "Main reception extension for building A",
  • "extension": "1001",
  • "domain_name": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "1001",
  • "password": "s3cur3P@ss",
  • "direct_hash": "a8f3b2c1d4e5",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Get list of extensions

Retrieves a paginated list of extensions associated with the authenticated agent.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Get file details

Retrieves detailed information about a specific file by its ID.

path Parameters
id
required
string

The ID of the file.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "reference_type": "recording",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "name": "meeting-recording.wav",
  • "detail": "Recording of the sales meeting",
  • "filename": "550e8400-e29b-41d4-a716-446655440000.wav",
  • "filesize": 5242880,
  • "uri_download": "https://storage.voipbin.net/files/550e8400-e29b-41d4-a716-446655440000.wav",
  • "tm_download_expire": "2026-02-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Delete a file

Deletes a specific file by its ID.

path Parameters
id
required
string

The ID of the file.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "reference_type": "recording",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "name": "meeting-recording.wav",
  • "detail": "Recording of the sales meeting",
  • "filename": "550e8400-e29b-41d4-a716-446655440000.wav",
  • "filesize": 5242880,
  • "uri_download": "https://storage.voipbin.net/files/550e8400-e29b-41d4-a716-446655440000.wav",
  • "tm_download_expire": "2026-02-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Upload a file

Uploads a file and returns the details of the uploaded file.

Request Body schema: multipart/form-data
required
file
required
string <binary>

The file to upload.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "reference_type": "recording",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "name": "meeting-recording.wav",
  • "detail": "Recording of the sales meeting",
  • "filename": "550e8400-e29b-41d4-a716-446655440000.wav",
  • "filesize": 5242880,
  • "uri_download": "https://storage.voipbin.net/files/550e8400-e29b-41d4-a716-446655440000.wav",
  • "tm_download_expire": "2026-02-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Get list of files

Retrieves a paginated list of files associated with the authenticated agent.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Update authenticated agent's addresses

Updates the address details of the authenticated agent and returns the updated information.

Request Body schema: application/json
required
required
Array of objects (CommonAddress)

The updated list of addresses.

Responses

Request samples

Content type
application/json
{
  • "addresses": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "[email protected]",
  • "name": "John Smith",
  • "detail": "Senior support agent",
  • "ring_method": "ringall",
  • "status": "available",
  • "permission": 64,
  • "tag_ids": [
    ],
  • "addresses": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T10:00:00.000000Z"
}

Update authenticated agent's password

Updates the password of the authenticated agent.

Request Body schema: application/json
required
password
required
string

The new password for the agent.

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "[email protected]",
  • "name": "John Smith",
  • "detail": "Senior support agent",
  • "ring_method": "ringall",
  • "status": "available",
  • "permission": 64,
  • "tag_ids": [
    ],
  • "addresses": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T10:00:00.000000Z"
}

Update authenticated agent's status

Updates the status of the authenticated agent and returns the updated information.

Request Body schema: application/json
required
status
required
string (AgentManagerAgentStatus)
Enum: "" "available" "away" "busy" "offline" "ringing"

Current availability status of the agent.

Responses

Request samples

Content type
application/json
{
  • "status": "available"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "[email protected]",
  • "name": "John Smith",
  • "detail": "Senior support agent",
  • "ring_method": "ringall",
  • "status": "available",
  • "permission": 64,
  • "tag_ids": [
    ],
  • "addresses": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T10:00:00.000000Z"
}

Get authenticated agent's details

Retrieves detailed information about the authenticated agent.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "[email protected]",
  • "name": "John Smith",
  • "detail": "Senior support agent",
  • "ring_method": "ringall",
  • "status": "available",
  • "permission": 64,
  • "tag_ids": [
    ],
  • "addresses": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T10:00:00.000000Z"
}

Update authenticated agent's information

Updates the basic information of the authenticated agent and returns the updated details.

Request Body schema: application/json
required
name
required
string

The updated name of the agent.

detail
required
string

Additional details about the agent.

ring_method
required
string (AgentManagerAgentRingMethod)
Enum: "ringall" "linear"

Method used to ring the agent for incoming calls.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "ring_method": "ringall"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "username": "[email protected]",
  • "name": "John Smith",
  • "detail": "Senior support agent",
  • "ring_method": "ringall",
  • "status": "available",
  • "permission": 64,
  • "tag_ids": [
    ],
  • "addresses": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T10:00:00.000000Z"
}

Establish a WebSocket connection

Creates a new WebSocket connection for the authenticated agent.

Remove a participant from a talk chat

Removes a specific participant from a talk chat.

path Parameters
id
required
string

The talk chat ID.

participant_id
required
string

The participant ID.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "chat_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
  • "tm_joined": "2026-01-15T10:00:00.000000Z"
}

Get participants of a talk chat

Returns a list of participants in a specific talk chat.

path Parameters
id
required
string

The talk chat ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a participant to a talk chat

Adds a new participant to a specific talk chat.

path Parameters
id
required
string

The talk chat ID.

Request Body schema: application/json
owner_type
required
string

Type of the owner (agent, customer, etc.).

owner_id
required
string

ID of the owner to add as participant.

Responses

Request samples

Content type
application/json
{
  • "owner_type": "string",
  • "owner_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "chat_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
  • "tm_joined": "2026-01-15T10:00:00.000000Z"
}

Join a talk chat

Allows the authenticated agent to join a "talk" type chat (public channel). This is a convenience endpoint that automatically adds the agent as a participant. Only works for "talk" type chats - for group/direct chats, use the participants endpoint.

path Parameters
id
required
string

The talk chat ID to join.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "chat_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
  • "tm_joined": "2026-01-15T10:00:00.000000Z"
}

Get talk chat by ID

Returns details of a specific talk chat.

path Parameters
id
required
string

The talk chat ID.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "direct",
  • "name": "Sales Team Chat",
  • "detail": "Internal chat for the sales team",
  • "member_count": 5,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Update talk chat

Updates a specific talk chat's name and/or detail.

path Parameters
id
required
string

The talk chat ID.

Request Body schema: application/json
required
name
string

The new name of the talk chat.

detail
string

The new detail/description of the talk chat.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "direct",
  • "name": "Sales Team Chat",
  • "detail": "Internal chat for the sales team",
  • "member_count": 5,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Delete talk chat

Deletes a specific talk chat (soft delete).

path Parameters
id
required
string

The talk chat ID.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "direct",
  • "name": "Sales Team Chat",
  • "detail": "Internal chat for the sales team",
  • "member_count": 5,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Get list of talk chats

Returns a list of talk chats for the authenticated agent.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new talk chat

Creates a new talk chat and returns the created talk's details.

Participant requirements by type:

  • direct: Requires exactly 1 other participant (creator is automatically added as second participant)
  • group: Can start with 0 or more participants (creator is automatically added, members can be added/removed later)
  • talk: No additional participants required (creator is automatically added)

Note: If the creator includes themselves in the participants list, they will not be added twice.

Request Body schema: application/json
type
required
string (TalkManagerTalkType)
Enum: "direct" "group" "talk"

Type of the talk.

name
string

Talk name (optional).

detail
string

Talk description/detail (optional).

Array of objects (TalkManagerParticipantInput)

List of participants to add to the chat (creator is added automatically).

Responses

Request samples

Content type
application/json
{
  • "type": "direct",
  • "name": "string",
  • "detail": "string",
  • "participants": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "direct",
  • "name": "Sales Team Chat",
  • "detail": "Internal chat for the sales team",
  • "member_count": 5,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Get list of public talk channels

Returns a list of all public "talk" type channels for the customer. This endpoint is for discovering available public channels that the agent can join. Unlike /service_agents/talk_chats which returns only joined chats, this returns all public channels regardless of participation.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Add a reaction to a talk message

Adds an emoji reaction to a specific talk message.

path Parameters
id
required
string

The talk message ID.

Request Body schema: application/json
emoji
required
string

Emoji character for the reaction.

Responses

Request samples

Content type
application/json
{
  • "emoji": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "chat_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
  • "parent_id": "a7b8c9d0-e1f2-3a4b-5c6d-7e8f9a0b1c2d",
  • "type": "normal",
  • "text": "Hello team, any updates on the project?",
  • "medias": [
    ],
  • "metadata": {
    },
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Get talk message by ID

Returns details of a specific talk message.

path Parameters
id
required
string

The talk message ID.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "chat_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
  • "parent_id": "a7b8c9d0-e1f2-3a4b-5c6d-7e8f9a0b1c2d",
  • "type": "normal",
  • "text": "Hello team, any updates on the project?",
  • "medias": [
    ],
  • "metadata": {
    },
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Delete talk message

Deletes a specific talk message (soft delete).

path Parameters
id
required
string

The talk message ID.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "chat_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
  • "parent_id": "a7b8c9d0-e1f2-3a4b-5c6d-7e8f9a0b1c2d",
  • "type": "normal",
  • "text": "Hello team, any updates on the project?",
  • "medias": [
    ],
  • "metadata": {
    },
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Get list of talk messages for a specific chat

Returns a list of talk messages for a specific chat.

query Parameters
chat_id
required
string

Chat ID to filter messages

page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new talk message

Creates a new talk message and returns the created message's details.

Request Body schema: application/json
chat_id
required
string

Talk chat ID.

parent_id
string

Parent message ID for threading (optional).

type
required
string (TalkManagerMessageType)
Enum: "normal" "system"

Type of the message.

text
required
string

Message text content.

Array of objects (TalkManagerMedia)

Media attachments (optional).

Responses

Request samples

Content type
application/json
{
  • "chat_id": "string",
  • "parent_id": "string",
  • "type": "normal",
  • "text": "string",
  • "medias": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "chat_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
  • "parent_id": "a7b8c9d0-e1f2-3a4b-5c6d-7e8f9a0b1c2d",
  • "type": "normal",
  • "text": "Hello team, any updates on the project?",
  • "medias": [
    ],
  • "metadata": {
    },
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Update phone number on contact

Update a phone number on the contact.

path Parameters
id
required
string

The ID of the contact.

phone_number_id
required
string

The ID of the phone number.

Request Body schema: application/json
required
number
string
type
string
Enum: "mobile" "work" "home" "fax" "other"
is_primary
boolean

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "type": "mobile",
  • "is_primary": true
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Remove phone number from contact

Remove a phone number from the contact.

path Parameters
id
required
string

The ID of the contact.

phone_number_id
required
string

The ID of the phone number.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Add phone number to contact

Add a new phone number to the contact.

path Parameters
id
required
string

The ID of the contact.

Request Body schema: application/json
required
number
required
string
type
string
Enum: "mobile" "work" "home" "fax" "other"
is_primary
boolean

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "type": "mobile",
  • "is_primary": true
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update email on contact

Update an email address on the contact.

path Parameters
id
required
string

The ID of the contact.

email_id
required
string

The ID of the email.

Request Body schema: application/json
required
address
string <email>
type
string
Enum: "work" "personal" "other"
is_primary
boolean

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Remove email from contact

Remove an email address from the contact.

path Parameters
id
required
string

The ID of the contact.

email_id
required
string

The ID of the email.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Add email to contact

Add a new email address to the contact.

path Parameters
id
required
string

The ID of the contact.

Request Body schema: application/json
required
address
required
string <email>
type
string
Enum: "work" "personal" "other"
is_primary
boolean

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Remove tag from contact

Remove a tag from the contact.

path Parameters
id
required
string

The ID of the contact.

tag_id
required
string

The ID of the tag.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Add tag to contact

Add a tag to the contact.

path Parameters
id
required
string

The ID of the contact.

Request Body schema: application/json
required
tag_id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "tag_id": "39c8a0b3-fbe8-4801-95bf-e8a0792edf1d"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Get the contact

Get the contact of the given ID.

path Parameters
id
required
string

The ID of the contact.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update a contact

Update a contact and return updated details.

path Parameters
id
required
string

The ID of the contact.

Request Body schema: application/json
required
first_name
string
last_name
string
display_name
string
company
string
job_title
string
external_id
string
notes
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "display_name": "string",
  • "company": "string",
  • "job_title": "string",
  • "external_id": "string",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete the contact

Delete the contact of the given ID.

path Parameters
id
required
string

The ID of the contact.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Lookup contact

Find a contact by phone number or email.

query Parameters
phone
string

Phone number in E.164 format to lookup.

email
string

Email address to lookup.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

List contacts

Get contacts for the service agent's customer.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new contact

Create a new contact for the service agent's customer.

Request Body schema: application/json
required

Request body to create a new contact.

first_name
string
last_name
string
display_name
string
company
string
job_title
string
source
string
Enum: "manual" "import" "api" "sync"
external_id
string
notes
string
Array of objects
Array of objects
tag_ids
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "display_name": "string",
  • "company": "string",
  • "job_title": "string",
  • "source": "manual",
  • "external_id": "string",
  • "notes": "string",
  • "phone_numbers": [
    ],
  • "emails": [],
  • "tag_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Retrieve detailed information of a tag

Fetches detailed information of a specific tag by its ID.

path Parameters
id
required
string

The ID of the tag.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "VIP Customer",
  • "detail": "Tag for high-priority VIP customers",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Retrieve a list of tags

Fetches a list of tags with pagination support.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Speaking

Operations related to real-time streaming TTS sessions

List speaking sessions

Returns a list of speaking sessions for the authenticated customer.

query Parameters
page_size
integer
page_token
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a speaking session

Creates a new streaming TTS session on a call or conference.

Request Body schema: application/json
reference_type
required
string

Type of the referenced entity (call, confbridge)

reference_id
required
string

ID of the referenced entity

language
string

TTS language (e.g. en-US)

provider
string

TTS provider. Defaults to elevenlabs.

voice_id
string

Provider-specific voice ID. If empty, uses default for language.

direction
string

Audio injection direction (in, out, both). Defaults to none.

Responses

Request samples

Content type
application/json
{
  • "reference_type": "string",
  • "reference_id": "string",
  • "language": "string",
  • "provider": "string",
  • "voice_id": "string",
  • "direction": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "reference_type": "call",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "language": "en-US",
  • "provider": "elevenlabs",
  • "voice_id": "21m00Tcm4TlvDq8ikWAM",
  • "direction": "both",
  • "status": "active",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Get a speaking session

Returns details of a speaking session.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "reference_type": "call",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "language": "en-US",
  • "provider": "elevenlabs",
  • "voice_id": "21m00Tcm4TlvDq8ikWAM",
  • "direction": "both",
  • "status": "active",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Delete a speaking session

Soft-deletes a speaking session. Stops the session if still active.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "reference_type": "call",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "language": "en-US",
  • "provider": "elevenlabs",
  • "voice_id": "21m00Tcm4TlvDq8ikWAM",
  • "direction": "both",
  • "status": "active",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Send text to a speaking session

Adds text to the speech queue. Can be called multiple times.

path Parameters
id
required
string
Request Body schema: application/json
text
required
string

Text to be spoken.

Responses

Request samples

Content type
application/json
{
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "reference_type": "call",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "language": "en-US",
  • "provider": "elevenlabs",
  • "voice_id": "21m00Tcm4TlvDq8ikWAM",
  • "direction": "both",
  • "status": "active",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Flush a speaking session

Cancels current speech and clears all queued messages. Session stays open.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "reference_type": "call",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "language": "en-US",
  • "provider": "elevenlabs",
  • "voice_id": "21m00Tcm4TlvDq8ikWAM",
  • "direction": "both",
  • "status": "active",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Stop a speaking session

Terminates the session. Closes AudioSocket and ElevenLabs connections.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "reference_type": "call",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "language": "en-US",
  • "provider": "elevenlabs",
  • "voice_id": "21m00Tcm4TlvDq8ikWAM",
  • "direction": "both",
  • "status": "active",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Storage

Operations related to storage

Find more about storage

Get details of a given account's storage account

Retrieves the details of a given account's storage account.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "total_file_count": 42,
  • "total_file_size": 1073741824,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Get details of a specific storage account

Retrieves the details of a specific storage account by its ID.

path Parameters
id
required
string

The ID of the storage account.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "total_file_count": 42,
  • "total_file_size": 1073741824,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Delete a specific storage account

Deletes a specific storage account by its ID and returns the details of the deleted account.

path Parameters
id
required
string

The ID of the storage account.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "total_file_count": 42,
  • "total_file_size": 1073741824,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Get a list of storage accounts

Retrieves a list of storage accounts with the provided pagination details.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new storage account

Creates a new storage account with the provided information and returns the created account details.

Request Body schema: application/json
customer_id
required
string

Responses

Request samples

Content type
application/json
{
  • "customer_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "total_file_count": 42,
  • "total_file_size": 1073741824,
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Get file details by ID

Retrieves detailed information for a specific file by ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "reference_type": "recording",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "name": "meeting-recording.wav",
  • "detail": "Recording of the sales meeting",
  • "filename": "550e8400-e29b-41d4-a716-446655440000.wav",
  • "filesize": 5242880,
  • "uri_download": "https://storage.voipbin.net/files/550e8400-e29b-41d4-a716-446655440000.wav",
  • "tm_download_expire": "2026-02-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Delete a file

Deletes a file by ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "reference_type": "recording",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "name": "meeting-recording.wav",
  • "detail": "Recording of the sales meeting",
  • "filename": "550e8400-e29b-41d4-a716-446655440000.wav",
  • "filesize": 5242880,
  • "uri_download": "https://storage.voipbin.net/files/550e8400-e29b-41d4-a716-446655440000.wav",
  • "tm_download_expire": "2026-02-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Get a list of files

Retrieves a paginated list of files.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Upload a file and create a call with it

Creates a temporary file and initiates a call with the temporary file.

Request Body schema: multipart/form-data
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "owner_type": "agent",
  • "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  • "reference_type": "recording",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "name": "meeting-recording.wav",
  • "detail": "Recording of the sales meeting",
  • "filename": "550e8400-e29b-41d4-a716-446655440000.wav",
  • "filesize": 5242880,
  • "uri_download": "https://storage.voipbin.net/files/550e8400-e29b-41d4-a716-446655440000.wav",
  • "tm_download_expire": "2026-02-15T09:30:00.000000Z",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Tag

Operations related to tag

Find more about tag

Get the tag

Retrieves the tag details by its ID.

path Parameters
id
required
string

The ID of the tag.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "VIP Customer",
  • "detail": "Tag for high-priority VIP customers",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Delete the tag

Deletes the tag identified by the given ID.

path Parameters
id
required
string

The ID of the tag to be deleted.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "VIP Customer",
  • "detail": "Tag for high-priority VIP customers",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Update the tag info

Updates the tag's name and detail information.

path Parameters
id
required
string

The ID of the tag.

Request Body schema: application/json
name
required
string
detail
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "VIP Customer",
  • "detail": "Tag for high-priority VIP customers",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Create a new tag.

Creates a new tag with the specified information.

Request Body schema: application/json
name
required
string
detail
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "VIP Customer",
  • "detail": "Tag for high-priority VIP customers",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

List tags

Retrieves a list of tags for the customer.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Transcribe

Operations related to transcribe

Find more about transcribe

Stop an ongoing transcription

Stops an ongoing transcription for the specified ID and returns the result.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "on_end_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "reference_type": "call",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "status": "progressing",
  • "language": "en-US",
  • "direction": "both",
  • "provider": "gcp",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Get detailed transcribe info

Retrieves detailed information about a specific transcription by ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "on_end_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "reference_type": "call",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "status": "progressing",
  • "language": "en-US",
  • "direction": "both",
  • "provider": "gcp",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Delete a transcribe

Deletes a transcription by ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "on_end_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "reference_type": "call",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "status": "progressing",
  • "language": "en-US",
  • "direction": "both",
  • "provider": "gcp",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Get list of transcribes

Retrieves a paginated list of transcriptions for the authenticated customer.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a transcribe

Creates a transcription of a recording and returns the result.

Request Body schema: application/json
required
reference_type
required
string (TranscribeManagerTranscribeReferenceType)
Enum: "unknown" "recording" "call" "confbridge"
reference_id
required
string

The ID of the reference for the transcription.

language
required
string

The language of the transcription.

direction
required
string (TranscribeManagerTranscribeDirection)
Enum: "both" "in" "out"
provider
string (TranscribeManagerTranscribeProvider)
Enum: "" "gcp" "aws"
on_end_flow_id
required
string

The ID of the flow to be executed when the transcription ends.

Responses

Request samples

Content type
application/json
{
  • "reference_type": "call",
  • "reference_id": "string",
  • "language": "string",
  • "direction": "both",
  • "provider": "gcp",
  • "on_end_flow_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "activeflow_id": "d4e5f6a7-b8c9-0123-4567-890abcdef012",
  • "on_end_flow_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "reference_type": "call",
  • "reference_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "status": "progressing",
  • "language": "en-US",
  • "direction": "both",
  • "provider": "gcp",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Retrieve a list of transcripts

Fetch a list of transcripts associated with the customer.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

transcribe_id
required
string

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Transfer

Operations related to transfer

Find more about transfer

Start a transfer

Initiates a call transfer and returns the result.

Request Body schema: application/json
required
transfer_type
required
string (TransferManagerTransferType)
Enum: "attended" "blind"
transferer_call_id
required
string

Call ID of the transfer initiator.

required
Array of objects (CommonAddress)

Addresses of the transfer recipients.

Responses

Request samples

Content type
application/json
{
  • "transfer_type": "blind",
  • "transferer_call_id": "string",
  • "transferee_addresses": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "type": "blind",
  • "transferer_call_id": "c9d0e1f2-a3b4-5c6d-7e8f-9a0b1c2d3e4f",
  • "transferee_addresses": [
    ],
  • "transferee_call_id": "d0e1f2a3-b4c5-6d7e-8f9a-0b1c2d3e4f5a",
  • "groupcall_id": "e1f2a3b4-c5d6-7e8f-9a0b-1c2d3e4f5a6b",
  • "confbridge_id": "f2a3b4c5-d6e7-8f9a-0b1c-2d3e4f5a6b7c",
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Trunk

Operations related to trunk

Find more about trunk

Retrieve trunk details.

Retrieves the details of a specific trunk by its ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Primary SIP Trunk",
  • "detail": "Main SIP trunk for outbound calls",
  • "domain_name": "sip.example.com",
  • "auth_types": [
    ],
  • "username": "trunk_user",
  • "password": "s3cur3P@ss",
  • "allowed_ips": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Update a trunk.

Updates the details of an existing trunk and returns the updated trunk's information.

path Parameters
id
required
string
Request Body schema: application/json
required
name
required
string
detail
required
string
auth_types
required
Array of strings (RegistrarManagerAuthType)
Items Enum: "basic" "ip"
username
required
string
password
required
string
allowed_ips
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "auth_types": [
    ],
  • "username": "string",
  • "password": "string",
  • "allowed_ips": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Primary SIP Trunk",
  • "detail": "Main SIP trunk for outbound calls",
  • "domain_name": "sip.example.com",
  • "auth_types": [
    ],
  • "username": "trunk_user",
  • "password": "s3cur3P@ss",
  • "allowed_ips": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Delete a trunk.

Deletes an existing trunk by its ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Primary SIP Trunk",
  • "detail": "Main SIP trunk for outbound calls",
  • "domain_name": "sip.example.com",
  • "auth_types": [
    ],
  • "username": "trunk_user",
  • "password": "s3cur3P@ss",
  • "allowed_ips": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Retrieve a list of trunks.

Retrieves a paginated list of trunks.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new trunk.

Creates a new trunk with the provided details and returns the created trunk's information.

Request Body schema: application/json
required
name
required
string
detail
required
string
domain_name
required
string
auth_types
required
Array of strings (RegistrarManagerAuthType)
Items Enum: "basic" "ip"
username
required
string
password
required
string
allowed_ips
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "detail": "string",
  • "domain_name": "string",
  • "auth_types": [
    ],
  • "username": "string",
  • "password": "string",
  • "allowed_ips": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Primary SIP Trunk",
  • "detail": "Main SIP trunk for outbound calls",
  • "domain_name": "sip.example.com",
  • "auth_types": [
    ],
  • "username": "trunk_user",
  • "password": "s3cur3P@ss",
  • "allowed_ips": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-16T14:20:00.000000Z",
  • "tm_delete": "2026-01-17T18:45:00.000000Z"
}

Websocket

Operations related to websocket

Find more about websocket

Create a new websocket connection.

Establishes a new websocket connection for real-time communication.

Timeline

Operations related to timeline events

Get timeline events for a resource

Returns timeline events for the specified resource in WebhookMessage format.

path Parameters
resource_type
required
string
Enum: "calls" "conferences" "flows" "activeflows"

The type of resource (calls, conferences, flows, activeflows)

resource_id
required
string <uuid>

The UUID of the resource

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Get SIP analysis for a call

Returns SIP messages and RTCP quality stats for the specified call from Homer SIP capture. Internal-to-internal messages (where both src and dst IPs are RFC 1918 private addresses) are filtered out. RTCP stats are extracted from X-RTP-Stat headers in BYE messages before filtering.

path Parameters
call_id
required
string <uuid>

The UUID of the call

Responses

Response samples

Content type
application/json
{
  • "sip_messages": [
    ],
  • "rtcp_stats": {
    }
}

Get PCAP download for a call

Returns PCAP file containing SIP messages for the specified call. Internal-to-internal packets (where both src and dst IPs are RFC 1918 private addresses) are filtered out.

path Parameters
call_id
required
string <uuid>

The UUID of the call

Responses

RAG

Operations related to RAG (Retrieval-Augmented Generation)

Query RAG documentation system

Submit a natural language query to the RAG documentation system and receive an answer grounded in the indexed documentation sources.

Request Body schema: application/json
required

Query parameters for the RAG system.

query
required
string

The natural language question to ask.

doc_types
Array of strings (RagManagerDocType)
Items Enum: "devdoc" "openapi" "design" "guideline"

Optional list of document types to search. If empty, all types are searched.

top_k
integer

Number of top relevant chunks to retrieve. Defaults to server configuration if not specified.

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "doc_types": [
    ],
  • "top_k": 0
}

Response samples

Content type
application/json
{
  • "answer": "To authenticate, use the POST /auth/login endpoint with your credentials.",
  • "sources": [
    ]
}

Team

Team operations

Team Tutorial

Get team details.

Retrieves detailed information for a specific team by its ID.

path Parameters
id
required
string

The ID of the team.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Customer Support Team",
  • "detail": "Multi-agent team for handling customer inquiries",
  • "start_member_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  • "members": [
    ],
  • "parameter": {
    },
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete a team.

Deletes an existing team by its ID.

path Parameters
id
required
string

The ID of the team.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Customer Support Team",
  • "detail": "Multi-agent team for handling customer inquiries",
  • "start_member_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  • "members": [
    ],
  • "parameter": {
    },
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update a team.

Updates an existing team's details and returns the updated information.

path Parameters
id
required
string

The ID of the team.

Request Body schema: application/json
required
name
required
string

Name of the team.

detail
required
string

Detailed description of the team.

start_member_id
required
string <uuid>

The member ID that starts the conversation. Must reference one of the members in the members array.

required
Array of objects (AIManagerTeamMember) non-empty

List of team members forming the graph nodes.

object

Custom key-value parameter data for the team. Supports flow variable substitution at runtime.

Responses

Request samples

Content type
application/json
{
  • "name": "Customer Support Team",
  • "detail": "Multi-agent team for handling customer inquiries",
  • "start_member_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  • "members": [
    ],
  • "parameter": {
    }
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Customer Support Team",
  • "detail": "Multi-agent team for handling customer inquiries",
  • "start_member_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  • "members": [
    ],
  • "parameter": {
    },
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Gets a list of teams.

Retrieves a paginated list of teams.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new team.

Creates a new team that composes multiple AI members into a directed graph for Pipecat Flows.

Request Body schema: application/json
required
name
required
string

Name of the team.

detail
required
string

Detailed description of the team.

start_member_id
required
string <uuid>

The member ID that starts the conversation. Must reference one of the members in the members array.

required
Array of objects (AIManagerTeamMember) non-empty

List of team members forming the graph nodes. Must contain at least one member.

object

Custom key-value parameter data for the team. Supports flow variable substitution at runtime.

Responses

Request samples

Content type
application/json
{
  • "name": "Customer Support Team",
  • "detail": "Multi-agent team for handling customer inquiries",
  • "start_member_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  • "members": [
    ],
  • "parameter": {
    }
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "name": "Customer Support Team",
  • "detail": "Multi-agent team for handling customer inquiries",
  • "start_member_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  • "members": [
    ],
  • "parameter": {
    },
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Contact

List contacts

Get contacts for the customer.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Create a new contact

Create a new contact for the customer.

Request Body schema: application/json
required

Request body to create a new contact.

first_name
string
last_name
string
display_name
string
company
string
job_title
string
source
string
Enum: "manual" "import" "api" "sync"
external_id
string
notes
string
Array of objects
Array of objects
tag_ids
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "display_name": "string",
  • "company": "string",
  • "job_title": "string",
  • "source": "manual",
  • "external_id": "string",
  • "notes": "string",
  • "phone_numbers": [
    ],
  • "emails": [],
  • "tag_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Lookup contact

Find a contact by phone number or email.

query Parameters
phone
string

Phone number in E.164 format to lookup.

email
string

Email address to lookup.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Get the contact

Get the contact of the given ID.

path Parameters
id
required
string

The ID of the contact.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update a contact

Update a contact and return updated details.

path Parameters
id
required
string

The ID of the contact.

Request Body schema: application/json
required
first_name
string
last_name
string
display_name
string
company
string
job_title
string
external_id
string
notes
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "display_name": "string",
  • "company": "string",
  • "job_title": "string",
  • "external_id": "string",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete the contact

Delete the contact of the given ID.

path Parameters
id
required
string

The ID of the contact.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Add phone number to contact

Add a new phone number to the contact.

path Parameters
id
required
string

The ID of the contact.

Request Body schema: application/json
required
number
required
string
type
string
Enum: "mobile" "work" "home" "fax" "other"
is_primary
boolean

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "type": "mobile",
  • "is_primary": true
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update phone number on contact

Update a phone number on the contact.

path Parameters
id
required
string

The ID of the contact.

phone_number_id
required
string

The ID of the phone number.

Request Body schema: application/json
required
number
string
type
string
Enum: "mobile" "work" "home" "fax" "other"
is_primary
boolean

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "type": "mobile",
  • "is_primary": true
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Remove phone number from contact

Remove a phone number from the contact.

path Parameters
id
required
string

The ID of the contact.

phone_number_id
required
string

The ID of the phone number.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Add email to contact

Add a new email address to the contact.

path Parameters
id
required
string

The ID of the contact.

Request Body schema: application/json
required
address
required
string <email>
type
string
Enum: "work" "personal" "other"
is_primary
boolean

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Update email on contact

Update an email address on the contact.

path Parameters
id
required
string

The ID of the contact.

email_id
required
string

The ID of the email.

Request Body schema: application/json
required
address
string <email>
type
string
Enum: "work" "personal" "other"
is_primary
boolean

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Remove email from contact

Remove an email address from the contact.

path Parameters
id
required
string

The ID of the contact.

email_id
required
string

The ID of the email.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Add tag to contact

Add a tag to the contact.

path Parameters
id
required
string

The ID of the contact.

Request Body schema: application/json
required
tag_id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "tag_id": "39c8a0b3-fbe8-4801-95bf-e8a0792edf1d"
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Remove tag from contact

Remove a tag from the contact.

path Parameters
id
required
string

The ID of the contact.

tag_id
required
string

The ID of the tag.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "first_name": "John",
  • "last_name": "Smith",
  • "display_name": "John Smith",
  • "company": "Acme Corporation",
  • "job_title": "Software Engineer",
  • "source": "manual",
  • "external_id": "CRM-12345",
  • "phone_numbers": [
    ],
  • "emails": [
    ],
  • "tag_ids": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Email

Retrieve email details

Retrieves the details of a specific email by its ID.

path Parameters
id
required
string

The ID of the email.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "source": {
    },
  • "destinations": [
    ],
  • "status": "delivered",
  • "subject": "Your Call Recording is Ready",
  • "content": "Please find your call recording attached.",
  • "attachments": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Delete a email

Deletes an existing email by its ID.

path Parameters
id
required
string

The ID of the email.

Responses

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "source": {
    },
  • "destinations": [
    ],
  • "status": "delivered",
  • "subject": "Your Call Recording is Ready",
  • "content": "Please find your call recording attached.",
  • "attachments": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}

Retrieve a list of emails

Retrieves a paginated list of emails accessible to the authenticated agent.

query Parameters
page_size
integer
Example: page_size=25

Number of results to return per page.

page_token
string

Cursor token for pagination. Use the next_page_token value from the previous response.

Responses

Response samples

Content type
application/json
{
  • "next_page_token": "string",
  • "result": [
    ]
}

Send an email

Send an email with the provided details and returns the created email's information.

Request Body schema: application/json
required
required
Array of objects (CommonAddress)

The email addresses to send the email to.

subject
required
string

The subject of the email.

content
required
string

The content of the email.

required
Array of objects (EmailManagerEmailAttachment)

List of attachments to include in the email.

Responses

Request samples

Content type
application/json
{
  • "destinations": [
    ],
  • "subject": "string",
  • "content": "string",
  • "attachments": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "550e8400-e29b-41d4-a716-446655440000",
  • "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  • "source": {
    },
  • "destinations": [
    ],
  • "status": "delivered",
  • "subject": "Your Call Recording is Ready",
  • "content": "Please find your call recording attached.",
  • "attachments": [
    ],
  • "tm_create": "2026-01-15T09:30:00.000000Z",
  • "tm_update": "2026-01-15T09:30:00.000000Z",
  • "tm_delete": "2026-01-15T09:30:00.000000Z"
}