Create inbox
curl --request POST \
--url https://api.withallo.com/v2/api/inboxes \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Sales",
"emoji": "💼",
"sources": [
{
"allo_number": "+33612345678",
"conditions": [
{
"type": "MENU_BRANCH",
"branches": [
[
{
"node_id": "node-1",
"digit": "1"
},
{
"node_id": "node-3",
"digit": "2"
}
]
],
"include_no_choice": false
}
]
}
],
"filters": {
"types": [
"INBOUND_CALL"
],
"user_ids": [],
"contact_ids": [],
"contact_list_ids": []
},
"notifications_muted": false
}
'import requests
url = "https://api.withallo.com/v2/api/inboxes"
payload = {
"name": "Sales",
"emoji": "💼",
"sources": [
{
"allo_number": "+33612345678",
"conditions": [
{
"type": "MENU_BRANCH",
"branches": [[
{
"node_id": "node-1",
"digit": "1"
},
{
"node_id": "node-3",
"digit": "2"
}
]],
"include_no_choice": False
}
]
}
],
"filters": {
"types": ["INBOUND_CALL"],
"user_ids": [],
"contact_ids": [],
"contact_list_ids": []
},
"notifications_muted": False
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Sales',
emoji: '💼',
sources: [
{
allo_number: '+33612345678',
conditions: [
{
type: 'MENU_BRANCH',
branches: [[{node_id: 'node-1', digit: '1'}, {node_id: 'node-3', digit: '2'}]],
include_no_choice: false
}
]
}
],
filters: {types: ['INBOUND_CALL'], user_ids: [], contact_ids: [], contact_list_ids: []},
notifications_muted: false
})
};
fetch('https://api.withallo.com/v2/api/inboxes', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Sales',
'emoji' => '💼',
'sources' => [
[
'allo_number' => '+33612345678',
'conditions' => [
[
'type' => 'MENU_BRANCH',
'branches' => [
[
[
'node_id' => 'node-1',
'digit' => '1'
],
[
'node_id' => 'node-3',
'digit' => '2'
]
]
],
'include_no_choice' => false
]
]
]
],
'filters' => [
'types' => [
'INBOUND_CALL'
],
'user_ids' => [
],
'contact_ids' => [
],
'contact_list_ids' => [
]
],
'notifications_muted' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.withallo.com/v2/api/inboxes"
payload := strings.NewReader("{\n \"name\": \"Sales\",\n \"emoji\": \"💼\",\n \"sources\": [\n {\n \"allo_number\": \"+33612345678\",\n \"conditions\": [\n {\n \"type\": \"MENU_BRANCH\",\n \"branches\": [\n [\n {\n \"node_id\": \"node-1\",\n \"digit\": \"1\"\n },\n {\n \"node_id\": \"node-3\",\n \"digit\": \"2\"\n }\n ]\n ],\n \"include_no_choice\": false\n }\n ]\n }\n ],\n \"filters\": {\n \"types\": [\n \"INBOUND_CALL\"\n ],\n \"user_ids\": [],\n \"contact_ids\": [],\n \"contact_list_ids\": []\n },\n \"notifications_muted\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.post("https://api.withallo.com/v2/api/inboxes")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Sales\",\n \"emoji\": \"💼\",\n \"sources\": [\n {\n \"allo_number\": \"+33612345678\",\n \"conditions\": [\n {\n \"type\": \"MENU_BRANCH\",\n \"branches\": [\n [\n {\n \"node_id\": \"node-1\",\n \"digit\": \"1\"\n },\n {\n \"node_id\": \"node-3\",\n \"digit\": \"2\"\n }\n ]\n ],\n \"include_no_choice\": false\n }\n ]\n }\n ],\n \"filters\": {\n \"types\": [\n \"INBOUND_CALL\"\n ],\n \"user_ids\": [],\n \"contact_ids\": [],\n \"contact_list_ids\": []\n },\n \"notifications_muted\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/inboxes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Sales\",\n \"emoji\": \"💼\",\n \"sources\": [\n {\n \"allo_number\": \"+33612345678\",\n \"conditions\": [\n {\n \"type\": \"MENU_BRANCH\",\n \"branches\": [\n [\n {\n \"node_id\": \"node-1\",\n \"digit\": \"1\"\n },\n {\n \"node_id\": \"node-3\",\n \"digit\": \"2\"\n }\n ]\n ],\n \"include_no_choice\": false\n }\n ]\n }\n ],\n \"filters\": {\n \"types\": [\n \"INBOUND_CALL\"\n ],\n \"user_ids\": [],\n \"contact_ids\": [],\n \"contact_list_ids\": []\n },\n \"notifications_muted\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "inb-abc123",
"name": "Sales",
"emoji": "💼",
"sources": [
{
"allo_number": "+33612345678",
"conditions": [
{
"type": "MENU_BRANCH",
"branches": [
[
{
"node_id": "node-1",
"digit": "1"
},
{
"node_id": "node-3",
"digit": "2"
}
]
],
"include_no_choice": false
}
]
}
],
"filters": {
"types": [
"INBOUND_CALL"
],
"user_ids": [],
"contact_ids": [],
"contact_list_ids": []
},
"notifications_muted": false
}
}{
"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
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Boîtes de réception
Créer une boîte de réception
Creates an inbox for the caller, or for a teammate with user_id in the body. Every source line must be accessible to the inbox owner. Up to 50 inboxes per user. Size limits (name over 80 characters, emoji over 16, more than 100 sources or 10 conditions per source) return 400 INVALID_REQUEST_BODY with field_errors. A menu path not listed by the line’s menu_options, or a null source, condition or digit, returns 400 INVALID_INBOX_SOURCE. Menu conditions are only accepted on a line whose menu_options list is not empty, with paths from that list; on other lines use a whole-line source (empty conditions). For a teammate, the inbox must hold at least one line of the caller’s workspace.
POST
/
v2
/
api
/
inboxes
Create inbox
curl --request POST \
--url https://api.withallo.com/v2/api/inboxes \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Sales",
"emoji": "💼",
"sources": [
{
"allo_number": "+33612345678",
"conditions": [
{
"type": "MENU_BRANCH",
"branches": [
[
{
"node_id": "node-1",
"digit": "1"
},
{
"node_id": "node-3",
"digit": "2"
}
]
],
"include_no_choice": false
}
]
}
],
"filters": {
"types": [
"INBOUND_CALL"
],
"user_ids": [],
"contact_ids": [],
"contact_list_ids": []
},
"notifications_muted": false
}
'import requests
url = "https://api.withallo.com/v2/api/inboxes"
payload = {
"name": "Sales",
"emoji": "💼",
"sources": [
{
"allo_number": "+33612345678",
"conditions": [
{
"type": "MENU_BRANCH",
"branches": [[
{
"node_id": "node-1",
"digit": "1"
},
{
"node_id": "node-3",
"digit": "2"
}
]],
"include_no_choice": False
}
]
}
],
"filters": {
"types": ["INBOUND_CALL"],
"user_ids": [],
"contact_ids": [],
"contact_list_ids": []
},
"notifications_muted": False
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Sales',
emoji: '💼',
sources: [
{
allo_number: '+33612345678',
conditions: [
{
type: 'MENU_BRANCH',
branches: [[{node_id: 'node-1', digit: '1'}, {node_id: 'node-3', digit: '2'}]],
include_no_choice: false
}
]
}
],
filters: {types: ['INBOUND_CALL'], user_ids: [], contact_ids: [], contact_list_ids: []},
notifications_muted: false
})
};
fetch('https://api.withallo.com/v2/api/inboxes', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Sales',
'emoji' => '💼',
'sources' => [
[
'allo_number' => '+33612345678',
'conditions' => [
[
'type' => 'MENU_BRANCH',
'branches' => [
[
[
'node_id' => 'node-1',
'digit' => '1'
],
[
'node_id' => 'node-3',
'digit' => '2'
]
]
],
'include_no_choice' => false
]
]
]
],
'filters' => [
'types' => [
'INBOUND_CALL'
],
'user_ids' => [
],
'contact_ids' => [
],
'contact_list_ids' => [
]
],
'notifications_muted' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.withallo.com/v2/api/inboxes"
payload := strings.NewReader("{\n \"name\": \"Sales\",\n \"emoji\": \"💼\",\n \"sources\": [\n {\n \"allo_number\": \"+33612345678\",\n \"conditions\": [\n {\n \"type\": \"MENU_BRANCH\",\n \"branches\": [\n [\n {\n \"node_id\": \"node-1\",\n \"digit\": \"1\"\n },\n {\n \"node_id\": \"node-3\",\n \"digit\": \"2\"\n }\n ]\n ],\n \"include_no_choice\": false\n }\n ]\n }\n ],\n \"filters\": {\n \"types\": [\n \"INBOUND_CALL\"\n ],\n \"user_ids\": [],\n \"contact_ids\": [],\n \"contact_list_ids\": []\n },\n \"notifications_muted\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.post("https://api.withallo.com/v2/api/inboxes")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Sales\",\n \"emoji\": \"💼\",\n \"sources\": [\n {\n \"allo_number\": \"+33612345678\",\n \"conditions\": [\n {\n \"type\": \"MENU_BRANCH\",\n \"branches\": [\n [\n {\n \"node_id\": \"node-1\",\n \"digit\": \"1\"\n },\n {\n \"node_id\": \"node-3\",\n \"digit\": \"2\"\n }\n ]\n ],\n \"include_no_choice\": false\n }\n ]\n }\n ],\n \"filters\": {\n \"types\": [\n \"INBOUND_CALL\"\n ],\n \"user_ids\": [],\n \"contact_ids\": [],\n \"contact_list_ids\": []\n },\n \"notifications_muted\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/inboxes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Sales\",\n \"emoji\": \"💼\",\n \"sources\": [\n {\n \"allo_number\": \"+33612345678\",\n \"conditions\": [\n {\n \"type\": \"MENU_BRANCH\",\n \"branches\": [\n [\n {\n \"node_id\": \"node-1\",\n \"digit\": \"1\"\n },\n {\n \"node_id\": \"node-3\",\n \"digit\": \"2\"\n }\n ]\n ],\n \"include_no_choice\": false\n }\n ]\n }\n ],\n \"filters\": {\n \"types\": [\n \"INBOUND_CALL\"\n ],\n \"user_ids\": [],\n \"contact_ids\": [],\n \"contact_list_ids\": []\n },\n \"notifications_muted\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "inb-abc123",
"name": "Sales",
"emoji": "💼",
"sources": [
{
"allo_number": "+33612345678",
"conditions": [
{
"type": "MENU_BRANCH",
"branches": [
[
{
"node_id": "node-1",
"digit": "1"
},
{
"node_id": "node-3",
"digit": "2"
}
]
],
"include_no_choice": false
}
]
}
],
"filters": {
"types": [
"INBOUND_CALL"
],
"user_ids": [],
"contact_ids": [],
"contact_list_ids": []
},
"notifications_muted": false
}
}{
"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
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Scope requis :
INBOXES_WRITEComportement
Crée une boîte de réception appartenant à l’appelant et la retourne avec un201. Envoyez user_id dans le corps JSON pour la créer pour un coéquipier : la boîte appartient alors au coéquipier et apparaît dans son sélecteur de boîtes. Seuls les admins et managers de l’espace de travail du coéquipier peuvent le faire.
Chaque ligne source doit être accessible au propriétaire de la boîte, avec les mêmes règles d’accès aux lignes que dans l’app. Une source avec une liste conditions vide couvre toute la ligne. Construisez les sources à partir de la source des suggestions de boîtes, ou de la condition des options de menu.
Les conditions de menu ne sont acceptées que sur une ligne dont la liste d’options de menu n’est pas vide. Sur toute autre ligne, utilisez une source sur toute la ligne.
Chaque ligne apparaît une seule fois dans sources. Pour couvrir plusieurs options de menu d’une ligne, mettez tous leurs chemins dans les branches d’une seule condition MENU_BRANCH.
Erreurs
| Statut | Code | Quand |
|---|---|---|
400 | INBOX_NAME_REQUIRED | name est manquant ou vide |
400 | INVALID_INBOX_SOURCE | Une source, une condition ou une touche est nulle ou invalide, un chemin de menu n’est pas dans les options de menu de cette ligne, deux sources ont le même allo_number, ou une boîte de coéquipier n’aurait plus aucune ligne dans l’espace de travail de l’appelant |
400 | INVALID_REQUEST_BODY | name dépasse 80 caractères, emoji dépasse 16, plus de 100 sources, ou plus de 10 conditions dans une source. field_errors nomme chaque champ |
400 | INVALID_INBOX_FILTERS | filters contient une clé inconnue ou une valeur invalide |
400 | INBOX_LIMIT_REACHED | Le propriétaire de la boîte a déjà 50 boîtes |
403 | FORBIDDEN | user_id est renseigné et l’appelant n’est ni admin ni manager de l’espace de travail de ce coéquipier |
403 | ALLO_NUMBER_FORBIDDEN | Une ligne source n’est pas accessible au propriétaire de la boîte, ou, avec user_id, n’est pas dans un espace de travail que l’appelant gère |
Autorisations
Corps
application/json
Required and non-blank.
Maximum string length:
80Exemple:
"Sales"
Maximum array length:
100Show child attributes
Show child attributes
Maximum string length:
16Exemple:
"💼"
Saved filters, with the same meaning as the conversation list filters in the app. "Unread only" is not saved on an inbox: use the unread query parameter of List conversations.
Show child attributes
Show child attributes
Exemple:
false
Create the inbox for this teammate (usr-*). The caller must be an admin or manager of that teammate's workspace.
Exemple:
"usr-abc123"
Réponse
Inbox created
Show child attributes
Show child attributes
Cette page vous a-t-elle été utile ?