Get inbox suggestions
curl --request GET \
--url https://api.withallo.com/v2/api/inboxes/suggestions \
--header 'Authorization: <api-key>'import requests
url = "https://api.withallo.com/v2/api/inboxes/suggestions"
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/inboxes/suggestions', 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/inboxes/suggestions",
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/inboxes/suggestions"
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/inboxes/suggestions")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/inboxes/suggestions")
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": [
{
"allo_number": "+33612345678",
"name": "Sales",
"description": "Website FR, option 2",
"branch": [
{
"node_id": "node-1",
"digit": "1"
},
{
"node_id": "node-3",
"digit": "2"
}
],
"answered": 42,
"rung": 57,
"texted": 3,
"score": 91,
"source": {
"allo_number": "+33612345678",
"conditions": [
{
"type": "MENU_BRANCH",
"branches": [
[
{
"node_id": "node-1",
"digit": "1"
},
{
"node_id": "node-3",
"digit": "2"
}
]
],
"include_no_choice": false
}
]
}
},
{
"allo_number": "+14155550100",
"name": null,
"description": null,
"branch": null,
"answered": 12,
"rung": 20,
"texted": 8,
"score": 40,
"source": {
"allo_number": "+14155550100",
"conditions": []
}
}
]
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Boîtes de réception
Obtenir les suggestions de boîtes
Ready-made inbox sources ranked from the caller’s recent calls and texts, including phone-menu branches. Each suggestion carries a source to put in sources as is. Suggestions are for the caller only.
GET
/
v2
/
api
/
inboxes
/
suggestions
Get inbox suggestions
curl --request GET \
--url https://api.withallo.com/v2/api/inboxes/suggestions \
--header 'Authorization: <api-key>'import requests
url = "https://api.withallo.com/v2/api/inboxes/suggestions"
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/inboxes/suggestions', 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/inboxes/suggestions",
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/inboxes/suggestions"
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/inboxes/suggestions")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/inboxes/suggestions")
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": [
{
"allo_number": "+33612345678",
"name": "Sales",
"description": "Website FR, option 2",
"branch": [
{
"node_id": "node-1",
"digit": "1"
},
{
"node_id": "node-3",
"digit": "2"
}
],
"answered": 42,
"rung": 57,
"texted": 3,
"score": 91,
"source": {
"allo_number": "+33612345678",
"conditions": [
{
"type": "MENU_BRANCH",
"branches": [
[
{
"node_id": "node-1",
"digit": "1"
},
{
"node_id": "node-3",
"digit": "2"
}
]
],
"include_no_choice": false
}
]
}
},
{
"allo_number": "+14155550100",
"name": null,
"description": null,
"branch": null,
"answered": 12,
"rung": 20,
"texted": 8,
"score": 40,
"source": {
"allo_number": "+14155550100",
"conditions": []
}
}
]
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Scope requis :
INBOXES_READComportement
Retourne des sources de boîte de réception prêtes à l’emploi pour l’appelant, les meilleures en premier, classées d’après ses appels et SMS récents. Cet endpoint ne prend pas deuser_id : les suggestions sont toujours celles de l’appelant.
Chaque suggestion contient une source. Mettez-la telle quelle dans les sources de Créer une boîte de réception :
- Une suggestion avec
branch: nullcouvre toute la ligne, et sasourcea desconditionsvides. - Une suggestion avec une
branchcouvre un chemin du menu téléphonique, et sasourcecontient une conditionMENU_BRANCHpour ce chemin.
branches de leurs conditions MENU_BRANCH.
name et description sont des libellés suggérés pour les branches de menu. Une suggestion sur toute la ligne (branch: null) a toujours name et description à null, et ils peuvent aussi valoir null pour une branche quand aucun libellé n’a pu être généré.Cette page vous a-t-elle été utile ?