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. A
disponibilidade pode variar ao longo do tempo.
No sandbox, este endpoint aceita apenas o DDD 41 e sempre retorna o mesmo número de demonstração, +5541963475701. Outro DDD retorna 409 com o código did-area-code-out-of-stock.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Salvy API","colors":{"primary":"#141414","light":"#F4F2EE","dark":"#141414"},"logo":{"light":"https://mintcdn.com/salvy-88fe5c1a/aD8_RTPjR92WjoTu/logo/light.svg?fit=max\u0026auto=format\u0026n=aD8_RTPjR92WjoTu\u0026q=85\u0026s=7178c70a1bd802f95c5ee9f7b1db46eb","dark":"https://mintcdn.com/salvy-88fe5c1a/aD8_RTPjR92WjoTu/logo/dark.svg?fit=max\u0026auto=format\u0026n=aD8_RTPjR92WjoTu\u0026q=85\u0026s=051c12a119e79f1642976a34164ff8a6"},"favicon":"https://mintcdn.com/salvy-88fe5c1a/aD8_RTPjR92WjoTu/favicon.svg?fit=max\u0026auto=format\u0026n=aD8_RTPjR92WjoTu\u0026q=85\u0026s=f26d50e69740ed3a04896d820cac4e7f","navbar":{"links":[{"href":"https://wa.me/551151963488","label":"Suporte"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.salvy.com.br"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/use-salvy"}},"contextual":{"options":["copy","download-spec","view"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"salvy-88fe5c1a","hasAudioNarration":false,"actualSubdomain":"salvy-88fe5c1a","customDomains":["docs.salvy.com.br"],"gitSource":{"type":"github","owner":"salvyltd","repo":"salvy-public-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aedcda225df1b8f9bf5bbf4","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"Referência API","count":145},{"language":"default","tag":"Webhooks","count":26},{"language":"default","tag":"Equipamentos","count":20},{"language":"default","tag":"Documentação","count":19},{"language":"default","tag":"Linhas","count":17},{"language":"default","tag":"Números virtuais","count":15},{"language":"default","tag":"MCP","count":14},{"language":"default","tag":"Colaboradores","count":11},{"language":"default","tag":"Faturas","count":6},{"language":"default","tag":"Receitas","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/v2/virtual-phone-accounts/create","slug":"/api-reference/v2/virtual-phone-accounts/create","pageMetadata":{"title":"Criar número virtual","openapi":"api-reference/v2/openapi.json POST /api/v2/virtual-phone-accounts","description":"Cria um novo número virtual móvel.\n\n**Escopo necessário:** `phone-account:create-mobile-did`","href":"/api-reference/v2/virtual-phone-accounts/create"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Cria um novo número virtual móvel.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Escopo necessário:\"\n }), \" \", _jsx(_components.code, {\n children: \"phone-account:create-mobile-did\"\n })]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const v_0=`v2`;function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Tip,Warning}=_components;if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(Warning,{children:[`Para utilizar nossas APIs e Webhooks de linhas virtuais, é necessário aderir ao nosso `,_jsx(_components.a,{href:`/api-reference/`+v_0+`/branding`,children:`manual de branding`})]}),`\n`,_jsx(_components.p,{children:`Permite criar números de telefone virtuais para uso em serviços como a API Oficial META.`}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Recomendação:`}),` Antes de criar um número virtual, consulte a `,_jsx(_components.a,{href:`/api-reference/v2/virtual-phone-accounts/list-area-codes`,children:`lista de DDDs\ndisponíveis`}),`. A\ndisponibilidade pode variar ao longo do tempo.`]})}),`\n`,_jsxs(_components.p,{children:[`No `,_jsx(_components.a,{href:`/api-reference/v2/environments`,children:`sandbox`}),`, este endpoint aceita apenas o DDD 41 e sempre retorna o mesmo número de demonstração, `,_jsx(_components.code,{children:`+5541963475701`}),`. Outro DDD retorna `,_jsx(_components.code,{children:`409`}),` com o código `,_jsx(_components.code,{children:`did-area-code-out-of-stock`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{v_0,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Criar número virtual","openapi":"api-reference/v2/openapi.json POST /api/v2/virtual-phone-accounts","description":"Cria um novo número virtual móvel.\n\n**Escopo necessário:** `phone-account:create-mobile-did`","href":"/api-reference/v2/virtual-phone-accounts/create"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[571,602,""]]},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"publicCreateVirtualPhoneAccountV2","tags":["Public API"],"description":"Cria um novo número virtual móvel.\n\n**Escopo necessário:** `phone-account:create-mobile-did`","requestBody":"47b418b9-567d-4062-8d4d-047ec10556eb","responses":{"200":"2624898c-3371-454a-9633-0842dccacb0b","401":"6e688b05-b01c-4ef5-a2d0-e1311c32639c","403":"099014d8-5194-4873-93e6-71fa83db858c","404":"9373497b-aaf9-42c9-b1d1-3fa677dbd51e","409":"8243e92b-0716-447c-b79b-72dc12b5ce4f","413":"e4c5f07d-01bf-4191-9180-63cb1804925d","422":"0d370147-f023-4108-b781-76ddb2119b9a","429":"b9667cbd-5cc0-4726-bbfb-b5d9ae71029d","500":"12a2a46c-7de4-4f4c-8d6f-110b3512410a"},"deprecated":false,"parameters":[],"method":"post","type":"path","servers":["d3e0d010-8d9f-4b2c-a598-0fcc20699760"],"security":["d5b64862-a7f8-45a8-9443-7cc0a0422b27"],"path":"/api/v2/virtual-phone-accounts","baseUrlOptions":["https://api.salvy.com.br"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"areaCode":{"description":"Código de área (DDD) associado ao número virtual.","example":11,"type":"number","isRequired":true,"uniqueKey":"areaCode","typeLabel":"number"},"employeeId":{"description":"ID do colaborador associado ao número virtual.","example":"0140a8c6-3815-45b7-9e60-8e137cad845c","type":"string","uniqueKey":"employeeId","typeLabel":"string"},"name":{"oneOf":[{"default":null,"description":"Nome do número virtual. Utilize para facilitar a gestão dos números virtuais.","example":"Meu Número Virtual","type":"string","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"default":null,"description":"Nome do número virtual. Utilize para facilitar a gestão dos números virtuais.","example":"Meu Número Virtual","type":"null","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"costCenter":{"oneOf":[{"default":null,"description":"Centro de custo associado ao número virtual.","example":"marketing","type":"string","uniqueKey":"costCenter.oneOf.0","typeLabel":"string"},{"default":null,"description":"Centro de custo associado ao número virtual.","example":"marketing","type":"null","uniqueKey":"costCenter.oneOf.1","typeLabel":"null"}],"uniqueKey":"costCenter","typeLabel":"string | null"},"customFields":{"description":"Campos customizados associados ao número virtual. Os campos devem ser criados previamente no [dashboard da Salvy](https://app.salvy.com.br/settings/custom-fields); labels inexistentes serão ignorados.","example":[{"label":"Departamento","value":"Vendas"}],"type":"array","items":{"type":"object","properties":{"label":{"type":"string","isRequired":true,"uniqueKey":"customFields.items.[INDEX].label","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"customFields.items.[INDEX].value","typeLabel":"string"}},"required":["label","value"],"uniqueKey":"customFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customFields","typeLabel":"object[]"}},"required":["areaCode"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"areaCode":11,"employeeId":"0140a8c6-3815-45b7-9e60-8e137cad845c","name":"Meu Número Virtual","costCenter":"marketing","customFields":[{"label":"Departamento","value":"Vendas"}]}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"2624898c-3371-454a-9633-0842dccacb0b":{"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"],"isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"oneOf":[{"description":"Nome do número virtual. Utilize para facilitar a gestão dos números virtuais.","example":"Meu Número Virtual","type":"string","isRequired":true,"uniqueKey":"name.oneOf.0","typeLabel":"string"},{"description":"Nome do número virtual. Utilize para facilitar a gestão dos números virtuais.","example":"Meu Número Virtual","type":"null","isRequired":true,"uniqueKey":"name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"name","typeLabel":"string | null"},"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"],"isRequired":true,"uniqueKey":"phoneNumber","typeLabel":"string"},"status":{"type":"string","enum":["pending","active","blocked","canceled"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"canceledAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"canceledAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"canceledAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"canceledAt","typeLabel":"string\u003cdate-time> | null"},"cancelReason":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"cancelReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"cancelReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cancelReason","typeLabel":"string | null"},"costCenter":{"oneOf":[{"description":"Centro de custo associado ao número virtual.","example":"marketing","type":"string","isRequired":true,"uniqueKey":"costCenter.oneOf.0","typeLabel":"string"},{"description":"Centro de custo associado ao número virtual.","example":"marketing","type":"null","isRequired":true,"uniqueKey":"costCenter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"costCenter","typeLabel":"string | null"},"employeeId":{"oneOf":[{"type":"string","title":"UUID","description":"ID do colaborador associado ao número virtual.","example":"0140a8c6-3815-45b7-9e60-8e137cad845c","isRequired":true,"uniqueKey":"employeeId.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID do colaborador associado ao número virtual.","example":"0140a8c6-3815-45b7-9e60-8e137cad845c","isRequired":true,"uniqueKey":"employeeId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"employeeId","typeLabel":"string | null"},"customFields":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","isRequired":true,"uniqueKey":"customFields.items.[INDEX].label","typeLabel":"string"},"type":{"type":"string","enum":["text","select"],"isRequired":true,"uniqueKey":"customFields.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"customFields.items.[INDEX].value","typeLabel":"string"}},"required":["label","type","value"],"additionalProperties":false,"uniqueKey":"customFields.items.[INDEX]","typeLabel":"object"},"description":"Campos customizados associados ao número virtual.","isRequired":true,"uniqueKey":"customFields","typeLabel":"object[]"}},"required":["id","name","phoneNumber","status","createdAt","canceledAt","cancelReason","costCenter","employeeId","customFields"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"0140a8c6-3815-45b7-9e60-8e137cad845c","name":"Meu Número Virtual","phoneNumber":"+551151231234","status":"pending","createdAt":"2023-11-07T05:31:56Z","canceledAt":"2023-11-07T05:31:56Z","cancelReason":"\u003cstring>","costCenter":"marketing","employeeId":"0140a8c6-3815-45b7-9e60-8e137cad845c","customFields":[{"label":"\u003cstring>","type":"text","value":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"6e688b05-b01c-4ef5-a2d0-e1311c32639c":{"description":"","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"code":{"type":"string","enum":["unauthorized"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"publicDetails":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","uniqueKey":"publicDetails.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"publicDetails","typeLabel":"object"}},"required":["code","message","publicDetails"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"unauthorized","message":"\u003cstring>","publicDetails":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"099014d8-5194-4873-93e6-71fa83db858c":{"description":"","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"code":{"type":"string","enum":["forbidden","company-tier-limit-exceeded","insufficient-scope"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"publicDetails":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","uniqueKey":"publicDetails.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"publicDetails","typeLabel":"object"}},"required":["code","message","publicDetails"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"forbidden","message":"\u003cstring>","publicDetails":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"9373497b-aaf9-42c9-b1d1-3fa677dbd51e":{"description":"","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"code":{"type":"string","enum":["resource-not-found"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"publicDetails":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","uniqueKey":"publicDetails.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"publicDetails","typeLabel":"object"}},"required":["code","message","publicDetails"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"resource-not-found","message":"\u003cstring>","publicDetails":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"8243e92b-0716-447c-b79b-72dc12b5ce4f":{"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"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"publicDetails":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","uniqueKey":"publicDetails.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"publicDetails","typeLabel":"object"}},"required":["code","message","publicDetails"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"did-area-code-out-of-stock","message":"\u003cstring>","publicDetails":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"e4c5f07d-01bf-4191-9180-63cb1804925d":{"description":"","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"code":{"type":"string","enum":["payload-too-large"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"publicDetails":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","uniqueKey":"publicDetails.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"publicDetails","typeLabel":"object"}},"required":["code","message","publicDetails"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"payload-too-large","message":"\u003cstring>","publicDetails":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"0d370147-f023-4108-b781-76ddb2119b9a":{"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"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"publicDetails":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","uniqueKey":"publicDetails.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"publicDetails","typeLabel":"object"}},"required":["code","message","publicDetails"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"input-validation-error","message":"\u003cstring>","publicDetails":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"b9667cbd-5cc0-4726-bbfb-b5d9ae71029d":{"description":"","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"code":{"type":"string","enum":["too-many-attempts"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"publicDetails":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","uniqueKey":"publicDetails.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"publicDetails","typeLabel":"object"}},"required":["code","message","publicDetails"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"too-many-attempts","message":"\u003cstring>","publicDetails":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"12a2a46c-7de4-4f4c-8d6f-110b3512410a":{"description":"","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"code":{"type":"string","enum":["unknown"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"publicDetails":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","uniqueKey":"publicDetails.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"publicDetails","typeLabel":"object"}},"required":["code","message","publicDetails"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"unknown","message":"\u003cstring>","publicDetails":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"d5b64862-a7f8-45a8-9443-7cc0a0422b27":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"key","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"d3e0d010-8d9f-4b2c-a598-0fcc20699760":{"url":"https://api.salvy.com.br","description":"Salvy API URL"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"key","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/v2/openapi.json"},"subdomain":"salvy-88fe5c1a","siteName":"Salvy API","title":"Criar número virtual - Salvy API","navMaps":{"firstHrefInVersion":{"v3":{"href":"/api-reference/v3/introduction","matchLevel":3},"v2":{"href":"/api-reference/v2/virtual-phone-accounts/create","matchLevel":0},"v1":{"href":"/api-reference/v1/virtual-phone-accounts/create","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2026-10-15T14:03:54.253Z","originalFileLocation":"api-reference/v2/virtual-phone-accounts/create.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Cria um novo número virtual móvel. Escopo necessário: phone-account:create-mobile-did\">\u003cmeta data-mint-head name=\"application-name\" content=\"Salvy API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Criar número virtual - Salvy API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Cria um novo número virtual móvel. Escopo necessário: phone-account:create-mobile-did\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Salvy API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.salvy.com.br/api-reference/v2/virtual-phone-accounts/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://salvy-88fe5c1a.mintlify.site/_mintlify/api/og/v2?division=N%C3%BAmeros+virtuais\u0026amp;title=Criar+n%C3%BAmero+virtual\u0026amp;description=Cria+um+novo+n%C3%BAmero+virtual+m%C3%B3vel.%0A%0A**Escopo+necess%C3%A1rio%3A**+%60phone-account%3Acreate-mobile-did%60\u0026amp;theme=9e9623747e20268e9ce176d1\u0026amp;signature=232a5e5bd8c5568d0fa4c0b3416a7c0a042d9d591494172036f9d4d0cfd66a77\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Criar número virtual - Salvy API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Cria um novo número virtual móvel. Escopo necessário: phone-account:create-mobile-did\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://salvy-88fe5c1a.mintlify.site/_mintlify/api/og/v2?division=N%C3%BAmeros+virtuais\u0026amp;title=Criar+n%C3%BAmero+virtual\u0026amp;description=Cria+um+novo+n%C3%BAmero+virtual+m%C3%B3vel.%0A%0A**Escopo+necess%C3%A1rio%3A**+%60phone-account%3Acreate-mobile-did%60\u0026amp;theme=9e9623747e20268e9ce176d1\u0026amp;signature=232a5e5bd8c5568d0fa4c0b3416a7c0a042d9d591494172036f9d4d0cfd66a77\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/salvy-88fe5c1a/st-II8O05-SFEuJc/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Salvy API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#141414\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.salvy.com.br/api-reference/v2/virtual-phone-accounts/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v2/virtual-phone-accounts/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.salvy.com.br/#organization\",\"name\":\"Salvy API\",\"url\":\"https://docs.salvy.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/salvy-88fe5c1a/aD8_RTPjR92WjoTu/logo/light.svg?fit=max\u0026auto=format\u0026n=aD8_RTPjR92WjoTu\u0026q=85\u0026s=7178c70a1bd802f95c5ee9f7b1db46eb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.salvy.com.br#website\",\"name\":\"Salvy API\",\"url\":\"https://docs.salvy.com.br\",\"publisher\":{\"@id\":\"https://docs.salvy.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.salvy.com.br/api-reference/v2/virtual-phone-accounts/create#webpage\",\"url\":\"https://docs.salvy.com.br/api-reference/v2/virtual-phone-accounts/create\",\"name\":\"Criar número virtual\",\"description\":\"Cria um novo número virtual móvel. Escopo necessário: phone-account:create-mobile-did\",\"dateModified\":\"2026-10-15T14:03:54.253Z\",\"isPartOf\":{\"@id\":\"https://docs.salvy.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://docs.salvy.com.br/api-reference/v2/virtual-phone-accounts/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.salvy.com.br/api-reference/v2/virtual-phone-accounts/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Números virtuais\",\"item\":\"https://docs.salvy.com.br/api-reference/v2/virtual-phone-accounts/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Criar número virtual\",\"item\":\"https://docs.salvy.com.br/api-reference/v2/virtual-phone-accounts/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.salvy.com.br/api-reference/v2/virtual-phone-accounts/create#apireference\",\"headline\":\"Criar número virtual\",\"name\":\"Criar número virtual\",\"description\":\"Cria um novo número virtual móvel. Escopo necessário: phone-account:create-mobile-did\",\"url\":\"https://docs.salvy.com.br/api-reference/v2/virtual-phone-accounts/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.salvy.com.br/api-reference/v2/virtual-phone-accounts/create#webpage\"},\"dateModified\":\"2026-10-15T14:03:54.253Z\",\"publisher\":{\"@id\":\"https://docs.salvy.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.salvy.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Salvy API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Salvy API","nav":{"global":null,"tabs":[{"tab":"Referência API","versions":[{"version":"v3","default":true,"pages":[{"title":"v3","href":"/api-reference/v3/introduction"}]},{"version":"v2","groups":[{"group":"Documentação","pages":[{"title":"Introdução","href":"/api-reference/v2/introduction"},{"title":"Ambientes","href":"/api-reference/v2/environments"},{"title":"Chaves de API","href":"/api-reference/v2/api-keys"},{"title":"Branding para integrações","href":"/api-reference/v2/branding"},{"title":"Deprecação","href":"/api-reference/v2/deprecation"},{"title":"Limites de requisição","href":"/api-reference/v2/rate-limits"}]},{"group":"Números virtuais","pages":[{"title":"Introdução a números virtuais","description":null,"href":"/api-reference/v2/virtual-phone-accounts/introduction"},{"title":"Criar número virtual","openapi":"api-reference/v2/openapi.json POST /api/v2/virtual-phone-accounts","href":"/api-reference/v2/virtual-phone-accounts/create"},{"title":"Buscar número virtual por ID","openapi":"api-reference/v2/openapi.json GET /api/v2/virtual-phone-accounts/{id}","description":"Busca uma linha virtual por ID\n\n**Escopo necessário:** `phone-account:read`","href":"/api-reference/v2/virtual-phone-accounts/get"},{"title":"Atualizar número virtual","openapi":"api-reference/v2/openapi.json PATCH /api/v2/virtual-phone-accounts/{id}","href":"/api-reference/v2/virtual-phone-accounts/update"},{"title":"Listar números virtuais","openapi":"api-reference/v2/openapi.json GET /api/v2/virtual-phone-accounts","href":"/api-reference/v2/virtual-phone-accounts/list"},{"title":"Cancelar número virtual","openapi":"api-reference/v2/openapi.json DELETE /api/v2/virtual-phone-accounts/{id}","href":"/api-reference/v2/virtual-phone-accounts/cancel"},{"title":"Listar disponibilidade de DDDs","openapi":"api-reference/v2/openapi.json GET /api/v2/virtual-phone-accounts/area-codes","href":"/api-reference/v2/virtual-phone-accounts/list-area-codes"},{"title":"Listar mensagens SMS recebidas","openapi":"api-reference/v2/openapi.json GET /api/v2/virtual-phone-accounts/{id}/sms-messages","href":"/api-reference/v2/virtual-phone-accounts/list-sms-messages"},{"title":"Simular recebimento de SMS","openapi":"api-reference/v2/openapi.json POST /api/v2/virtual-phone-accounts/{id}/sms","href":"/api-reference/v2/virtual-phone-accounts/simulate-sms"}]},{"group":"Colaboradores","pages":[{"title":"Introdução à API de colaboradores","sidebarTitle":"Introdução a colaboradores","href":"/api-reference/v2/employees/introduction"},{"title":"Sincronizar colaboradores","openapi":"api-reference/v2/openapi.json POST /api/v2/employees/sync","href":"/api-reference/v2/employees/sync"}]},{"group":"Equipamentos","pages":[{"title":"Listar equipamentos","openapi":"api-reference/v2/openapi.json GET /api/v2/assets","href":"/api-reference/v2/assets/list"},{"title":"Buscar equipamento por ID","openapi":"api-reference/v2/openapi.json GET /api/v2/assets/{id}","href":"/api-reference/v2/assets/get"},{"title":"Criar equipamento","openapi":"api-reference/v2/openapi.json POST /api/v2/assets","href":"/api-reference/v2/assets/create"},{"title":"Atualizar equipamento","openapi":"api-reference/v2/openapi.json POST /api/v2/assets/{id}","href":"/api-reference/v2/assets/update"},{"title":"Arquivar equipamento","openapi":"api-reference/v2/openapi.json POST /api/v2/assets/{id}/archive","href":"/api-reference/v2/assets/archive"},{"title":"Registrar anotação na linha do tempo","openapi":"api-reference/v2/openapi.json POST /api/v2/assets/{id}/timeline-notes","href":"/api-reference/v2/assets/create-timeline-note"}]},{"group":"Webhooks","pages":[{"title":"Introdução a Webhooks","href":"/api-reference/v2/webhooks/introduction"},{"title":"Verificando Webhooks","href":"/api-reference/v2/webhooks/verifying-payloads"},{"title":"SMS recebido","openapi":"api-reference/v2/openapi.json webhook sms.received","href":"/api-reference/v2/webhooks/sms-received"}]}]},{"version":"v1","pages":[{"title":"v1","href":"/api-reference/v1/virtual-phone-accounts/create"}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp-guide/overview"}]}]},"basePath":"","title":"Criar número virtual - Salvy API","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}