WayloAIWaylo Docs
APIReferencePhone numbers

List phone numbers

GET
/phone-numbers

Numbers in one workspace, offset-paginated.

Access: workspace_viewer · API key phone_numbers:read

Authorization

api-key
headerAuthorizationBearer <sk_waylo_<lookup><secret><checksum>>

Query Parameters

page?number
Range1 <= value <= 10000
Default1
limit?number
Range1 <= value <= 100
Default25
orderDirection?string
Default"desc"
Value in"asc""desc"
workspaceId*string
Formatuuid
active?boolean
agentId?string
Formatuuid
connectionId?string
Formatuuid
orderBy?string
Value in"e164""name""status""active""agentName""connectionName""createdAt""updatedAt"
search?string

Free-text search over the searchBy fields.

Length1 <= length <= 255
searchBy?string

Comma-separated: e164, name.

Header Parameters

Authorization*string

Your API key.

Response Body

Success

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.poc.app.waylovoice.ai/phone-numbers?workspaceId=497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Authorization: Bearer sk_waylo_...'
Example Response
[  {    "id": "string",    "workspaceId": "string",    "connectionId": "string",    "connectionName": "string",    "provider": "twilio",    "e164": "string",    "providerNumberId": "string",    "name": "string",    "agentId": "bc309ecf-5f66-4057-93c5-6611cc9cb7b2",    "agentName": "string",    "status": "activating",    "statusReason": "string",    "active": true,    "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",    "createdByUserName": "string",    "updatedByUserId": "b38eaad7-8efa-49e7-b0aa-619916a3821e",    "updatedByUserName": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Import phone number POST

Import a number the connected account already owns and attach it to the Waylo trunk. Importing replaces the number's current call routing at the carrier. Refused when the account does not own it (422), when another workspace or tenant has it active (409), or when the agent is not in the workspace (422). Answers with the number, `active` or `failed` with a `statusReason` — a failure is its state, not a failed request, retried with provision. **Access:** workspace_admin · API key `phone_numbers:write`

Provision phone number POST

Retry provisioning one number: attach it to the connection's trunk and ensure the dispatch rule. Answers with the number, `active` or `failed` with a `statusReason` — a failure is its state, not a failed request. **Access:** workspace_admin · API key `phone_numbers:write`