Bring Your Own Number

Register your own external phone number with Twilio to use within your workspace.

POST /v1/api/twilio/register-external-number

Register External Number

cURL

curl --request POST \
  --url https://api.trillet.ai/v1/api/twilio/register-external-number \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "phoneNumber": "<string>",
  "provider": "<string>",
  "credentials": {
    "accountSid": "<string>",
    "authToken": "<string>"
  }
}
'

{
  "status": "success",
  "message": "Phone number registered successfully"
}

Headers

x-workspace-id · string · required

Workspace identifier for the API.

Request Body

phoneNumber · string · required

The external phone number to register, in E.164 format (e.g., [phone]).

provider · string · required

The provider for the phone number. Currently, only "twilio" is supported.

credentials · object · required

The credentials required for the provider.

Show Credentials Details

accountSid · string · required

The Account SID from Twilio.

authToken · string · required

The Auth Token from Twilio.

Response Fields

status · string

The status of the request, indicating success or failure.

message · string

A message providing feedback about the registration process.

Example Response

{
  "status": "success",
  "message": "Phone number registered successfully"
}