Get sender ID
curl --request GET \
--url https://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids/{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://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids/{id}",
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: <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/{account_id}/sender_ids/{id}"
req, _ := http.NewRequest("GET", 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.get("https://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "vsi-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61",
"account_id": "usr-575966AF3661061265263C58882BC409D2A427B8",
"partner_client_ref": "crm-12345",
"sender_id": "PLOMBMARTIN",
"status": "VALIDATED",
"example_content": "Bonjour, votre intervention est confirmée demain à 9h. Plomberie Martin",
"created_at": "2026-11-16T10:05:00"
}
}{
"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
}
}Sender IDs
Get sender ID
Returns a sender ID declared on one of your accounts, with its review status. Use it to poll the status if you do not receive webhooks, and to see whether Allo disabled it. Requires the PARTNER scope.
GET
/
v2
/
api
/
partner
/
accounts
/
{account_id}
/
sender_ids
/
{id}
Get sender ID
curl --request GET \
--url https://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids/{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://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids/{id}",
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: <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/{account_id}/sender_ids/{id}"
req, _ := http.NewRequest("GET", 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.get("https://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/partner/accounts/{account_id}/sender_ids/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "vsi-2F6A1C9D4B7E8A0F3D5C6B9A1E2F4D7C8B0A3E61",
"account_id": "usr-575966AF3661061265263C58882BC409D2A427B8",
"partner_client_ref": "crm-12345",
"sender_id": "PLOMBMARTIN",
"status": "VALIDATED",
"example_content": "Bonjour, votre intervention est confirmée demain à 9h. Plomberie Martin",
"created_at": "2026-11-16T10:05:00"
}
}{
"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
}
}Required scope:
PARTNERpartner.sender_id.validated and partner.sender_id.failed webhooks tell you when the review ends. Without a webhook endpoint, poll this endpoint instead, within the rate limit of 20 read requests per second per key.
status | What it means |
|---|---|
PENDING | The sender ID is waiting for Allo’s review, usually 1 to 5 business days. |
VALIDATED | Allo approved the sender ID. The account can send SMS with it. |
FAILED | Allo rejected the sender ID. Declare another name with Declare sender ID. |
DISABLED | Allo deactivated the sender ID after validating it. Sending SMS with it is refused. |
DISABLED. Read this endpoint to check that a validated sender ID is still usable.
An id that is not a sender ID of this account fails with 404 PARTNER_SENDER_ID_NOT_FOUND. An account your API key did not create returns 404 PARTNER_ACCOUNT_NOT_FOUND.Path Parameters
Was this page helpful?