Suspend account
curl --request POST \
--url https://api.withallo.com/v2/api/partner/accounts/{id}/suspend \
--header 'Authorization: <api-key>'import requests
url = "https://api.withallo.com/v2/api/partner/accounts/{id}/suspend"
headers = {"Authorization": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: '<api-key>'}};
fetch('https://api.withallo.com/v2/api/partner/accounts/{id}/suspend', 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://api.withallo.com/v2/api/partner/accounts/{id}/suspend",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$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://api.withallo.com/v2/api/partner/accounts/{id}/suspend"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.withallo.com/v2/api/partner/accounts/{id}/suspend")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/partner/accounts/{id}/suspend")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "usr-575966AF3661061265263C58882BC409D2A427B8",
"phone_numbers": [
"+33712345678"
],
"status": "SUSPENDED",
"activated": true,
"partner_client_ref": "crm-12345"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {}
}{
"error": {}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Comptes
Suspendre un compte
Suspends an account you provisioned, right away. Inbound and outbound calls, outgoing SMS and the AI receptionist stop for every member of the account: each member’s status becomes SUSPENDED, and their eSIM lines are suspended. The account keeps its numbers, its eSIMs and its history, and its billing does not change. Incoming SMS are stored without any notification. Idempotent: suspending an account that is already suspended changes nothing and sends no second webhook. Allo sends partner.account.suspended to your webhook endpoint. Requires the PARTNER scope.
POST
/
v2
/
api
/
partner
/
accounts
/
{id}
/
suspend
Suspend account
curl --request POST \
--url https://api.withallo.com/v2/api/partner/accounts/{id}/suspend \
--header 'Authorization: <api-key>'import requests
url = "https://api.withallo.com/v2/api/partner/accounts/{id}/suspend"
headers = {"Authorization": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: '<api-key>'}};
fetch('https://api.withallo.com/v2/api/partner/accounts/{id}/suspend', 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://api.withallo.com/v2/api/partner/accounts/{id}/suspend",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$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://api.withallo.com/v2/api/partner/accounts/{id}/suspend"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.withallo.com/v2/api/partner/accounts/{id}/suspend")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/partner/accounts/{id}/suspend")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "usr-575966AF3661061265263C58882BC409D2A427B8",
"phone_numbers": [
"+33712345678"
],
"status": "SUSPENDED",
"activated": true,
"partner_client_ref": "crm-12345"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {}
}{
"error": {}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Scope requis :
PARTNERstatus: SUSPENDED.
Ce qui s’arrête
La suspension s’applique à tous les membres et à tous les numéros du compte. Lestatus de chaque membre passe à SUSPENDED, et un membre que vous ajoutez pendant la suspension est SUSPENDED dès le départ.
- Les appels entrants sont refusés : ils ne sonnent ni sur les apps ni sur les eSIM.
- Les appels sortants passés depuis les apps Allo diffusent un court message à la place, qui indique que la ligne est suspendue et invite à contacter le fournisseur. Le message ne cite pas Allo.
- Les SMS sortants sont refusés avec
403 ACCOUNT_SUSPENDED. Sur/v2/sms, l’endpoint utilisé par les apps Allo, le code d’erreur estAllo.9. - La réceptionniste IA ne répond plus, car les appels entrants s’arrêtent avant de l’atteindre.
- Les lignes eSIM sont suspendues auprès du réseau mobile, puisque leur titulaire est
SUSPENDED. Cela prend en général quelques secondes. Si le réseau ne confirme pas tout de suite, Allo réessaie toutes les 5 minutes. D’ici là, les appels et SMS sur l’eSIM elle-même peuvent encore passer.
Ce qui reste
- Les numéros du compte, ses eSIM et son historique d’appels et de messages.
- Les SMS entrants sont enregistrés dans la conversation, sans notification ni réponse automatique.
- La connexion. Les membres peuvent toujours ouvrir les apps Allo et consulter leur historique. Ils ne peuvent ni appeler ni envoyer de SMS.
- La facturation ne change pas. L’abonnement que vous payez pour le compte continue et se renouvelle normalement. Pour arrêter la facturation, désactivez le compte.
Webhook et idempotence
Allo envoiepartner.account.suspended à votre propre endpoint webhook, pas à celui du compte. Sans endpoint webhook, lisez le statut avec Obtenir un compte.
La requête est idempotente. Suspendre un compte déjà suspendu ne change rien, et Allo n’envoie pas de second webhook.
{id} est l’identifiant du compte renvoyé par Créer un compte. Un compte que votre API key n’a pas créé, ou déjà désactivé, renvoie 404 PARTNER_ACCOUNT_NOT_FOUND.Cette page vous a-t-elle été utile ?