Assign Phone Number by String

Assign a phone number to an assistant by phone number string.

Auto-syncs from Twilio if the number doesn’t exist locally and auto_sync is True. This is the recommended way to assign newly purchased Twilio numbers.

Args: assistant_id: ID of the assistant to assign the phone number to request: JSON request containing phone_number, friendly_name (optional), and auto_sync

POST /api/v1/assistants/{assistant_id}/phone-numbers/assign-by-number

Assign Phone Number By String

cURL

curl --request POST \
  --url https://api.example.com/api/v1/assistants/{assistant_id}/phone-numbers/assign-by-number \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "<string>",
  "friendly_name": "<string>",
  "auto_sync": true
}
'

200

{
  "success": true,
  "message": "<string>",
  "data": null
}

This endpoint assigns an available phone number from your organization to a specific assistant. The phone number must already exist within your organization’s pool of numbers and not be currently assigned to another assistant.

Path Parameters

• assistant_id (string, required): The unique identifier of the assistant to whom the phone number will be assigned.

Request Body

• phone_number (string, required): The phone number to assign, specified in E.164 format (e.g., [phone]).

Request

{
  "phone_number": "[phone]"
}

Response

A successful assignment will return the updated phone number object, which now includes the assistant_id.

Response

{
  "id": "pn_1a2b3c4d5e6f7g8h",
  "phone_number": "[phone]",
  "assistant_id": "asst_a1b2c3d4e5f67890",
  "organization_id": "org_67890",
  "created_at": "2023-10-26T11:00:00Z",
  "updated_at": "2023-10-28T14:00:00Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

assistant_id · integer · required

Body

application/json

Schema for assigning a phone number to an assistant.

phone_number · string · required

Phone number in E.164 format (e.g., [phone])

friendly_name · string | null

Friendly name for the phone number (e.g., 'Customer Support Line')

auto_sync · boolean · default: true

Automatically sync from Twilio if number not found locally

Response

200

application/json

Successful Response

Standard API response format.

success · boolean · required

message · string · required

data · unknown