DocumentationAPI ReferenceChangelog

Envocal API

API Reference API Changelog

Endpoints

List phone numbers of a tenant GETAdd a phone number POSTGet a phone number GETDelete a phone number DELETEChange a phone number PUT
Phone numbers

Add a phone number

List phone numbers of a tenant GET

Requires phone_numbers:read

Get a phone number GET

Requires phone_numbers:read

POST
/v1/tenants/{tenantId}/phone-numbers

Registers a number to the tenant so it can be assigned to an agent. Calls to the number must also be routed to the platform by your telephony provider (SIP trunk). Numbers are unique across the platform.

Required permission: phone_numbers:write

Authorization

Bearer
headerAuthorizationBearer <token>

Tenant API key (evk_…), created in Studio → Vault → API keys.

Path Parameters

tenantId*string

Tenant id, or current for the key's own tenant. Must be the key's tenant or one of its sub-tenants.

Request Body

The number.

  1. body
  1. body
  2. …

A new phone number.

number*string

The number in E.164 format, e.g. +46812345678.

Response Body

Created.

  1. response
  1. response
  2. …

A phone number registered on the platform.

id*string

Phone number id.

number*string

The number in E.164 format, e.g. +46812345678.

tenantId*string

Tenant that owns the number.

assignedAgentId?string

Agent answering calls to this number, if assigned.

assignedAgentName?string

Name of that agent.

Example Request
curl -X POST 'https://api.envocal.ai/v1/tenants/string/phone-numbers' \  -H 'Content-Type: application/json' \  -d '{  "number": "string"}'
Example Response
{  "id": "string",  "number": "string",  "tenantId": "string",  "assignedAgentId": "string",  "assignedAgentName": "string"}
Example Request
curl -X POST 'https://api.envocal.ai/v1/tenants/string/phone-numbers' \
  -H 'Content-Type: application/json' \
  -d '{
  "number": "string"
}'
{
  "id": "string",
  "number": "string",
  "tenantId": "string",
  "assignedAgentId": "string",
  "assignedAgentName": "string"
}