> ## Documentation Index
> Fetch the complete documentation index at: https://docs.salvy.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
# Criar número virtual
> Cria um novo número virtual.
Para utilizar nossas APIs e Webhooks de linhas virtuais, é necessário aderir ao nosso manual de branding
Permite criar números de telefone virtuais para uso em serviços como a API Oficial META.
**Recomendação:** Antes de criar um número virtual, consulte a [lista de DDDs
disponíveis](/api-reference/v1/virtual-phone-accounts/list-area-codes). A
disponibilidade pode variar ao longo do tempo.
No [sandbox](/api-reference/v1/environments), este endpoint sempre retorna o mesmo número de demonstração, independentemente do DDD informado.
## OpenAPI
````yaml api-reference/v1/openapi.json POST /api/v1/virtual-phone-accounts
openapi: 3.1.0
info:
version: v1
title: Salvy API
x-logo:
url: web/logo.png
servers:
- url: https://api.salvy.com.br
description: Salvy API URL
security:
- bearerAuth: []
tags:
- name: Public API
- name: Outgoing Webhooks
paths:
/api/v1/virtual-phone-accounts:
post:
tags:
- Public API
description: Cria um novo número virtual.
operationId: publicCreateVirtualPhoneAccountV1
parameters: []
requestBody:
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
employeeId:
description: ID do colaborador associado ao número virtual.
example: 0140a8c6-3815-45b7-9e60-8e137cad845c
type: string
identifier:
default: null
description: >-
Identificador do número virtual. Utilize para facilitar a
gestão dos números virtuais.
example: meu-número-virtual
anyOf:
- type: string
- type: 'null'
costCenter:
default: null
description: Centro de custo associado ao número virtual.
example: marketing
anyOf:
- type: string
- type: 'null'
areaCode:
type: number
minimum: 11
maximum: 99
description: Código de área (DDD) associado ao número virtual.
example: 11
redirectPhoneNumber:
description: >-
Número (incluindo DDD) para o qual serão encaminhadas as
chamadas recebidas.
example: '11912341234'
type: string
redirectExpiresAt:
format: datetime
description: >-
Data de expiração do redirecionamento de chamadas. Caso não
seja informada, o redirecionamento terá validade de 72
horas.
example: '2024-01-03T00:00:00Z'
type: string
pattern: >-
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
required:
- areaCode
- redirectPhoneNumber
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
id:
example: 0140a8c6-3815-45b7-9e60-8e137cad845c
title: UUID
type: string
description: A valid UUID string, in any version.
examples:
- 123e4567-e89b-12d3-a456-426614174000
- 123e4567-e89b-12d3-a456-426614174001
identifier:
anyOf:
- type: string
- type: 'null'
description: >-
Identificador do número virtual. Utilize para facilitar a
gestão dos números virtuais.
example: meu-número-virtual
phoneNumber:
description: >-
Número virtual recém-criado, formatado conforme o padrão
internacional E.164.
example: '+551151231234'
title: PhoneNumberE164
type: string
examples:
- '+5511999999999'
- '+551139999999'
status:
type: string
enum:
- pending
- active
- blocked
- canceled
createdAt:
type: string
format: date-time
canceledAt:
anyOf:
- type: string
format: date-time
- type: 'null'
cancelReason:
anyOf:
- type: string
- type: 'null'
redirectPhoneNumber:
anyOf:
- description: >-
Número designado para receber chamadas direcionadas ao
número virtual recém-criado, formatado conforme o
padrão internacional E.164.
example: '+5511912341234'
title: PhoneNumberE164
type: string
examples:
- '+5511999999999'
- '+551139999999'
- type: 'null'
redirectExpiresAt:
anyOf:
- type: string
format: date-time
- type: 'null'
description: Data de expiração do redirecionamento de chamadas.
example: '2024-01-03T00:00:00Z'
costCenter:
anyOf:
- type: string
- type: 'null'
description: Centro de custo associado ao número virtual.
example: marketing
required:
- id
- identifier
- phoneNumber
- status
- createdAt
- canceledAt
- cancelReason
- redirectPhoneNumber
- redirectExpiresAt
- costCenter
additionalProperties: false
'401':
description: ''
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
code:
type: string
enum:
- unauthorized
message:
type: string
publicDetails:
type: object
propertyNames:
type: string
additionalProperties:
type: string
required:
- code
- message
- publicDetails
additionalProperties: false
'403':
description: ''
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
code:
type: string
enum:
- forbidden
- virtual-phone-account-beta-tester
- company-tier-limit-exceeded
- insufficient-scope
message:
type: string
publicDetails:
type: object
propertyNames:
type: string
additionalProperties:
type: string
required:
- code
- message
- publicDetails
additionalProperties: false
'404':
description: ''
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
code:
type: string
enum:
- resource-not-found
message:
type: string
publicDetails:
type: object
propertyNames:
type: string
additionalProperties:
type: string
required:
- code
- message
- publicDetails
additionalProperties: false
'409':
description: ''
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
code:
type: string
enum:
- did-area-code-out-of-stock
message:
type: string
publicDetails:
type: object
propertyNames:
type: string
additionalProperties:
type: string
required:
- code
- message
- publicDetails
additionalProperties: false
'413':
description: ''
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
code:
type: string
enum:
- payload-too-large
message:
type: string
publicDetails:
type: object
propertyNames:
type: string
additionalProperties:
type: string
required:
- code
- message
- publicDetails
additionalProperties: false
'422':
description: ''
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
code:
type: string
enum:
- input-validation-error
- unprocessable-entity
- missing-area-code-inventory-config
- company-not-active
- company-has-pending-verification
- invalid-company-environment
message:
type: string
publicDetails:
type: object
propertyNames:
type: string
additionalProperties:
type: string
required:
- code
- message
- publicDetails
additionalProperties: false
'500':
description: ''
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
code:
type: string
enum:
- unknown
message:
type: string
publicDetails:
type: object
propertyNames:
type: string
additionalProperties:
type: string
required:
- code
- message
- publicDetails
additionalProperties: false
deprecated: false
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: key
````