API ReferenceDIDs

DIDs

Gerencie números de telefone (DIDs) e vincule-os aos seus agentes.

Listar DIDs

GET
/api/did

Retorna todos os DIDs do usuário

Response
[
  {
    "id": "clxyz...",
    "phoneNumber": "+5511999887766",
    "countryCode": "55",
    "provider": "wavoip",
    "status": "active",
    "agentId": "clxyz...",
    "createdAt": "2026-03-01T00:00:00Z"
  }
]

Obter DID

GET
/api/did/:id

Retorna um DID específico

Criar DID

POST
/api/did

Registra um novo número de telefone

ParameterTypeRequiredDescription
phoneNumberstringRequiredNúmero completo (formato E.164)
countryCodestringRequiredCódigo do país (ex: "55")
providerstringOptionalProvedor (padrão: "wavoip")
agentIdstringOptionalID do agente para vincular
Request
curl -X POST https://api.vendoria.com.br/api/did \
  -H "X-Api-Key: vk_sua_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "phoneNumber": "+5511999887766",
    "countryCode": "55",
    "agentId": "clxyz..."
  }'

Atualizar DID

PATCH
/api/did/:id

Atualiza um DID

ParameterTypeRequiredDescription
agentIdstringOptionalID do novo agente
statusstringOptional"active" ou "inactive"

Deletar DID

DELETE
/api/did/:id

Remove um DID

Note

Remover um DID desvincula automaticamente o número do agente e dos trunks.