Atualizar número de telefone
curl --request PUT \
--url https://suasofia.online/api/user/phone-numbers/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"nickname": "<string>"
}
'import requests
url = "https://suasofia.online/api/user/phone-numbers/{id}"
payload = { "nickname": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({nickname: '<string>'})
};
fetch('https://suasofia.online/api/user/phone-numbers/{id}', 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://suasofia.online/api/user/phone-numbers/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'nickname' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://suasofia.online/api/user/phone-numbers/{id}"
payload := strings.NewReader("{\n \"nickname\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://suasofia.online/api/user/phone-numbers/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"nickname\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://suasofia.online/api/user/phone-numbers/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"nickname\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Número de telefone atualizado com sucesso.",
"data": {
"id": 1,
"phone_number": "+14155551234",
"nickname": "Linha de Vendas",
"country_code": "US",
"type": "normal"
}
}
{
"error": "Número de telefone não encontrado."
}
{
"message": "O apelido não deve exceder 50 caracteres.",
"errors": {
"nickname": ["O apelido não deve exceder 50 caracteres."]
}
}
Números de Telefone
Atualizar número de telefone
Atualizar o apelido de um número de telefone
PUT
/
user
/
phone-numbers
/
{id}
Atualizar número de telefone
curl --request PUT \
--url https://suasofia.online/api/user/phone-numbers/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"nickname": "<string>"
}
'import requests
url = "https://suasofia.online/api/user/phone-numbers/{id}"
payload = { "nickname": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({nickname: '<string>'})
};
fetch('https://suasofia.online/api/user/phone-numbers/{id}', 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://suasofia.online/api/user/phone-numbers/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'nickname' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://suasofia.online/api/user/phone-numbers/{id}"
payload := strings.NewReader("{\n \"nickname\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://suasofia.online/api/user/phone-numbers/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"nickname\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://suasofia.online/api/user/phone-numbers/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"nickname\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Número de telefone atualizado com sucesso.",
"data": {
"id": 1,
"phone_number": "+14155551234",
"nickname": "Linha de Vendas",
"country_code": "US",
"type": "normal"
}
}
{
"error": "Número de telefone não encontrado."
}
{
"message": "O apelido não deve exceder 50 caracteres.",
"errors": {
"nickname": ["O apelido não deve exceder 50 caracteres."]
}
}
Este endpoint atualiza os atributos editáveis de um número de telefone que você possui. Atualmente, este é o apelido — um rótulo curto e amigável (por exemplo, “Linha de Vendas”, “Suporte — EUA”) exibido ao lado do número no painel.
Somente o proprietário do número pode atualizá-lo. Números compartilhados com você (concedidos) exibem o apelido, mas não podem ser alterados por você.
Parâmetros de Caminho
integer
required
O identificador único do número de telefone a ser atualizado
Parâmetros do Corpo
string
Um rótulo curto para o número de telefone. Máximo de 50 caracteres. Envie
null ou uma string vazia para removê-lo.Resposta
string
Mensagem de sucesso
object
O número de telefone atualizado
{
"message": "Número de telefone atualizado com sucesso.",
"data": {
"id": 1,
"phone_number": "+14155551234",
"nickname": "Linha de Vendas",
"country_code": "US",
"type": "normal"
}
}
{
"error": "Número de telefone não encontrado."
}
{
"message": "O apelido não deve exceder 50 caracteres.",
"errors": {
"nickname": ["O apelido não deve exceder 50 caracteres."]
}
}
O apelido é o mesmo rótulo que você pode definir no painel. Ele é retornado pelos endpoints de listagem de números de telefone (
GET /user/phone-numbers/all, GET /user/phone-numbers/sip-trunks), então outros recursos que referenciam um número pelo phone_number_id podem resolver seu apelido a partir daí.
