Preview an existing number's incoming call routing

Verifies live Twilio ownership and voice capability and checks the assistant through the existing workspace Voice Config connection. Makes no provider changes.

GET

https://api.channelautomation.com/api/voice-workspace-numbers/{sid}/preview

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

sid
string
required

Query parameters

assistantId
string
required
format: uuid

Header parameters

x-workspace-id
string
required

Returns

200

Current answering destination and version to confirm

JSON

success
optional
boolean
preview
optional
object
- phoneNumber
  optional
  string
- voiceDestination
  optional
  string
- routingVersion
  optional
  string
- assignedAssistantId
  optional
  string
  or null
- alreadyImported
  optional
  boolean
}

400

Invalid number or assistant

401

403

Workspace access or feature disabled

404

Number not in workspace

409

Conflicting configuration

412

Integration configuration required

500

Unexpected error

502

Voice provider rejected request

503

Provider or database unavailable

Preview an existing number's incoming call routing

curl --request GET \
  --url 'https://api.channelautomation.com/api/voice-workspace-numbers/<sid>/preview?assistantId=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  --header 'Authorization: Bearer <token>' \
  --header 'x-workspace-id: string'

const url = 'https://api.channelautomation.com/api/voice-workspace-numbers/<sid>/preview?assistantId=497f6eca-6276-4993-bfeb-53cbbbba6f08';
const options = {
  method: 'GET',
  headers: {'x-workspace-id': 'string', Authorization: 'Bearer <token>'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/voice-workspace-numbers/<sid>/preview?assistantId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

headers = {
    "x-workspace-id": "string",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

Response example

{
  "success": true,
  "preview": {
    "phoneNumber": "string",
    "voiceDestination": "string",
    "routingVersion": "string",
    "assignedAssistantId": "string",
    "alreadyImported": true
  }
}