Pin conversation
curl --request PUT \
--url https://api.withallo.com/v2/api/conversations/{contact_number}/pin \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"allo_number": "+14155550100"
}
'import requests
url = "https://api.withallo.com/v2/api/conversations/{contact_number}/pin"
payload = { "allo_number": "+14155550100" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({allo_number: '+14155550100'})
};
fetch('https://api.withallo.com/v2/api/conversations/{contact_number}/pin', 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/conversations/{contact_number}/pin",
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([
'allo_number' => '+14155550100'
]),
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/conversations/{contact_number}/pin"
payload := strings.NewReader("{\n \"allo_number\": \"+14155550100\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.withallo.com/v2/api/conversations/{contact_number}/pin")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"allo_number\": \"+14155550100\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/conversations/{contact_number}/pin")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"allo_number\": \"+14155550100\"\n}"
response = http.request(request)
puts response.read_body{
"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
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Conversations
Épingler une conversation
Pins a conversation for the caller. Up to 10 conversations can be pinned. Pinning a conversation that is already pinned returns 204 and changes nothing. A missing or blank allo_number returns 400 INVALID_REQUEST_BODY.
PUT
/
v2
/
api
/
conversations
/
{contact_number}
/
pin
Pin conversation
curl --request PUT \
--url https://api.withallo.com/v2/api/conversations/{contact_number}/pin \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"allo_number": "+14155550100"
}
'import requests
url = "https://api.withallo.com/v2/api/conversations/{contact_number}/pin"
payload = { "allo_number": "+14155550100" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({allo_number: '+14155550100'})
};
fetch('https://api.withallo.com/v2/api/conversations/{contact_number}/pin', 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/conversations/{contact_number}/pin",
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([
'allo_number' => '+14155550100'
]),
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/conversations/{contact_number}/pin"
payload := strings.NewReader("{\n \"allo_number\": \"+14155550100\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.withallo.com/v2/api/conversations/{contact_number}/pin")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"allo_number\": \"+14155550100\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/conversations/{contact_number}/pin")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"allo_number\": \"+14155550100\"\n}"
response = http.request(request)
puts response.read_body{
"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
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Scope requis :
CONVERSATIONS_WRITEComportement
Épingle la conversation aveccontact_number sur la ligne Allo allo_number, pour l’appelant uniquement. Retourne un 204 sans corps, y compris quand la conversation est déjà épinglée.
Chaque utilisateur peut épingler jusqu’à 10 conversations. Filtrez les conversations épinglées avec pinned=true sur Lister les conversations.
Erreurs
| Statut | Code | Quand |
|---|---|---|
400 | INVALID_REQUEST_BODY | allo_number est manquant ou vide |
403 | ALLO_NUMBER_FORBIDDEN | L’appelant n’a pas accès à cette ligne |
409 | PIN_LIMIT_REACHED | L’appelant a déjà 10 conversations épinglées. Désépinglez-en une d’abord |
Autorisations
Paramètres de chemin
The external phone number in E.164 format. URL-encode the + as %2B.
Exemple:
"+14155551234"
Corps
application/json
Allo line the conversation is on (E.164).
Exemple:
"+14155550100"
Réponse
Conversation pinned
Cette page vous a-t-elle été utile ?