Configurações do Número
curl --request GET \
--url https://apis.vectalk.com.br/api/phone-numbers/settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://apis.vectalk.com.br/api/phone-numbers/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apis.vectalk.com.br/api/phone-numbers/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apis.vectalk.com.br/api/phone-numbers/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apis.vectalk.com.br/api/phone-numbers/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apis.vectalk.com.br/api/phone-numbers/settings")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apis.vectalk.com.br/api/phone-numbers/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyNúmeros de Telefone
Configurações do Número
Obtém ou atualiza as configurações de um número de telefone Business, incluindo chamadas (calling), criptografia de payload e armazenamento de dados.
GET
/
phone-numbers
/
settings
Configurações do Número
curl --request GET \
--url https://apis.vectalk.com.br/api/phone-numbers/settings \
--header 'Authorization: Bearer <token>'import requests
url = "https://apis.vectalk.com.br/api/phone-numbers/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apis.vectalk.com.br/api/phone-numbers/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apis.vectalk.com.br/api/phone-numbers/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apis.vectalk.com.br/api/phone-numbers/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apis.vectalk.com.br/api/phone-numbers/settings")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apis.vectalk.com.br/api/phone-numbers/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyRequer token de instância associado ao número de telefone. O número é resolvido automaticamente pelo token — não é necessário informar o
phone-number-id.Obter Configurações
Parâmetros
Query
boolean
default:"false"
Quando
true, inclui as credenciais SIP (senha) na resposta. Requer permissões adicionais.Exemplo de Requisição
curl --request GET \
--url https://apis.vectalk.com.br/api/phone-numbers/settings \
--header 'Authorization: Bearer {seu_token}'
Resposta
{
"calling": {
"status": "NOT_SET",
"call_icon_visibility": "NOT_SET",
"callback_permission_status": "NOT_SET"
},
"storage_configuration": {
"status": "DEFAULT"
}
}
Campos da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
calling | object | Configurações de chamadas — veja Configurações de Chamadas para detalhes completos |
payload_encryption.status | string | enabled ou disabled |
payload_encryption.client_encryption_key_fingerprint | string | Fingerprint da chave (quando habilitado) |
payload_encryption.cloud_encryption_key | string | Chave de criptografia da cloud (quando habilitado) |
storage_configuration.status | string | DEFAULT ou IN_COUNTRY_STORAGE_ENABLED |
storage_configuration.data_localization_region | string | Região de armazenamento (quando in-country storage habilitado) |
O campo
password nos servidores SIP só é retornado quando include_sip_credentials=true.Atualizar Configurações
POST /phone-numbers/settings
Apenas uma seção de feature pode ser enviada por requisição.
Seções Disponíveis
| Seção | Descrição |
|---|---|
calling | Configurações de chamadas (status, SIP, vídeo, ícone, SRTP) — veja detalhes |
payload_encryption | Criptografia de payload |
storage_configuration | Configuração de armazenamento de dados |
user_identity_change | Notificações de mudança de identidade do usuário |
Exemplos
Habilitar Chamadas
curl --request POST \
--url https://apis.vectalk.com.br/api/phone-numbers/settings \
--header 'Authorization: Bearer {seu_token}' \
--header 'Content-Type: application/json' \
--data '{
"calling": {
"status": "enabled",
"call_icon_visibility": "DEFAULT"
}
}'
Habilitar SIP
curl --request POST \
--url https://apis.vectalk.com.br/api/phone-numbers/settings \
--header 'Authorization: Bearer {seu_token}' \
--header 'Content-Type: application/json' \
--data '{
"calling": {
"status": "enabled",
"sip": {
"status": "enabled"
},
"srtp_key_exchange_protocol": "DTLS"
}
}'
Habilitar Criptografia de Payload
curl --request POST \
--url https://apis.vectalk.com.br/api/phone-numbers/settings \
--header 'Authorization: Bearer {seu_token}' \
--header 'Content-Type: application/json' \
--data '{
"payload_encryption": {
"status": "enabled",
"client_encryption_key": "BASE64_ENCODED_PUBLIC_KEY"
}
}'
Resposta
{
"success": true
}
⌘I