Listar números
curl --request GET \
--url https://api.ararahq.com/v1/organizations/me/numbers \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ararahq.com/v1/organizations/me/numbers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.ararahq.com/v1/organizations/me/numbers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ararahq.com/v1/organizations/me/numbers",
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: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"numbers": [
{
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"type": "SHARED",
"isDefault": true,
"status": "ACTIVE",
"qualityScore": "HIGH",
"messagingTier": "TIER_50",
"provider": "<string>",
"alias": "<string>",
"description": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z",
"lastHealthCheckAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"messagesLast7d": 123,
"messagesLast30d": 123,
"deliveredLast30d": 123,
"provisionedByArara": true,
"wabaId": "<string>",
"isCoexistence": true
}
],
"slot": {
"used": 123,
"max": 123,
"planLabel": "<string>",
"atCap": true,
"noEntitlement": true,
"monthlyPriceCents": 123,
"monthlyTotalCents": 123
}
}Números
Listar números
Números ativos da organização, com qualidade, limite diário (tier) e uso do plano. Permissão: READ.
GET
/
v1
/
organizations
/
me
/
numbers
Listar números
curl --request GET \
--url https://api.ararahq.com/v1/organizations/me/numbers \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ararahq.com/v1/organizations/me/numbers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.ararahq.com/v1/organizations/me/numbers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ararahq.com/v1/organizations/me/numbers",
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: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"numbers": [
{
"id": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"type": "SHARED",
"isDefault": true,
"status": "ACTIVE",
"qualityScore": "HIGH",
"messagingTier": "TIER_50",
"provider": "<string>",
"alias": "<string>",
"description": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z",
"lastHealthCheckAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"messagesLast7d": 123,
"messagesLast30d": 123,
"deliveredLast30d": 123,
"provisionedByArara": true,
"wabaId": "<string>",
"isCoexistence": true
}
],
"slot": {
"used": 123,
"max": 123,
"planLabel": "<string>",
"atCap": true,
"noEntitlement": true,
"monthlyPriceCents": 123,
"monthlyTotalCents": 123
}
}Authorizations
Chave de API da Arara (ara_live_...), enviada no header Authorization: Bearer ara_live_.... Crie e gerencie as chaves no painel: https://app.ararahq.com/dashboard/apikeys. O valor completo aparece uma única vez, na criação.