Dokumentacja
Sign inGet started
Rozpocznij
Przewodniki
Referencja API
SDK
CLI
Baza wiedzy
Changelog

Get a WhatsApp number's business profile

GET
/v1/whatsapp/numbers/{number_id}/profile
const profile = await bird.whatsapp.numbers.profile.get("wan_01krdgeqcxet5s7t44vh8rt9mg");
console.log(profile.display_name, profile.description, profile.websites);
Odpowiedź200
{
  "display_name": "Lucky Shrub",
  "display_name_status": "approved",
  "new_display_name": "Lucky Shrub Garden Center",
  "new_display_name_status": "approved",
  "username": "goldcrest.support",
  "username_status": "approved",
  "about": "Open Monday to Friday, 9am to 6pm CET.",
  "address": "Trompenburgstraat 2C, 1079 TX Amsterdam",
  "description": "Bird is the platform for messaging with your customers.",
  "email": "hello@bird.com",
  "vertical": "retail",
  "websites": [
    "https://bird.com"
  ],
  "profile_picture_url": "https://pps.whatsapp.net/v/t61.24694-24/643148303_1005107588793925.jpg"
}
Returns the business profile WhatsApp shows to people this number messages, read from WhatsApp on each request rather than from a stored copy. Readable for a number your workspace connected itself and for one Bird operates on your behalf alike, since the profile is what everyone the number messages already sees; only the first can be changed. The response includes the display name WhatsApp shows for this number and the state of its review.
Parametry
number_id
string
ID of the WhatsApp number (wan_ prefix), as returned by the number list.
Treść odpowiedzi
display_name
string
The name WhatsApp verifies for this number. Once WhatsApp approves it, it appears at the top of a chat with this number; display_name_status is what says whether it has. Set when the number was connected, and changed from the dashboard or the CLI, as WhatsApp phone numbers explains. This field still returns the current name until a requested change completes.
display_name_status
string
Where WhatsApp's review of the display name stands. A name still under review is not yet shown at the top of a chat.
new_display_name
string
The display name whose change has been requested, whether or not WhatsApp is reviewing it. Absent when no change is pending.
new_display_name_status
string
Where the requested display name stands with WhatsApp, including whether it is being reviewed or was accepted for immediate use without a review. Absent when no change is pending. If WhatsApp accepts the name it becomes display_name. Every other outcome leaves the number on the name it already had: declined is WhatsApp refusing the name, and expired is a request that no longer stands and has to be made again.
username
string
The username WhatsApp users can find this number by, without an @. Absent when the number has no username. Once set it cannot be removed through this API.
username_status
string
Where the username stands with WhatsApp. Absent when the number has no username.
about
string
The short line shown under the business name in a chat.
address
string
The business address shown on the profile.
description
string
The longer description shown on the profile.
email
string
The contact email shown on the profile.
vertical
string
The industry WhatsApp shows on the profile.
websites
array of string
Up to two websites shown on the profile.
profile_picture_url
string
A link to the profile picture WhatsApp currently shows. WhatsApp signs this link and it expires within days, so load it when you display it and never store it. It is served with permissive cross-origin headers, so a browser can load it directly.

Powiązane zasoby

Kontynuuj z dokumentacją, przewodnikami i przykładami dotyczącymi tego tematu. Zasoby są w języku angielskim.

Zrozum koncepcjęShould I use a Bird SDK or call the API directly?Podążaj ścieżką naukiBuild your first integrationPrzewodnik wdrożeniowySend your first email
Uzyskaj brief wdrożeniowy