Get data on a WhatsApp business phone profile. Note that you cannot query this endpoint directly. Instead, use the GET /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/whatsapp_business_profile endpoint get business profile data.
GET v25.0/...?fields={fieldname_of_type_WhatsAppBusinessProfileSanitized} HTTP/1.1
Host: graph.facebook.com/* PHP SDK v5.0.0 */
/* make the API call */
try {
// Returns a `Facebook\FacebookResponse` object
$response = $fb->get(
'...?fields={fieldname_of_type_WhatsAppBusinessProfileSanitized}',
'{access-token}'
);
} catch(Facebook\Exceptions\FacebookResponseException $e) {
echo 'Graph returned an error: ' . $e->getMessage();
exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
echo 'Facebook SDK returned an error: ' . $e->getMessage();
exit;
}
$graphNode = $response->getGraphNode();
/* handle the result *//* make the API call */
FB.api(
"...?fields={fieldname_of_type_WhatsAppBusinessProfileSanitized}",
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);/* make the API call */
new GraphRequest(
AccessToken.getCurrentAccessToken(),
"...?fields={fieldname_of_type_WhatsAppBusinessProfileSanitized}",
null,
HttpMethod.GET,
new GraphRequest.Callback() {
public void onCompleted(GraphResponse response) {
/* handle the result */
}
}
).executeAsync();/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
initWithGraphPath:@"...?fields={fieldname_of_type_WhatsAppBusinessProfileSanitized}"
parameters:params
HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
id result,
NSError *error) {
// Handle the result
}];| Field | Description |
|---|---|
aboutstring | The business's About text. |
addressstring | Business address. Maximum 256 characters. |
descriptionstring | Business description. |
emailstring | Business email address. Must be in valid email format. Maximum 128 characters. |
messaging_productenum | Messaging product. |
profile_picture_urlstring | Profile picture URL. |
verticalenum | Business category. These values map to the following strings, which are displayed in the business profile in the WhatsApp client.
|
websiteslist<string> | URLs associated with the business, such as a website, Facebook Page, or Instagram profile. |
/{whats_app_business_phone_number_id}/whatsapp_business_profile.| Parameter | Description |
|---|---|
aboutstring | The business's About text.
Maximum 139 characters. |
addressstring | Business address. Maximum 256 characters. |
descriptionstring | Business description.
Maximum 512 characters. |
emailstring | Business email address. Must be in valid email format. Maximum 128 characters. |
messaging_productenum {WHATSAPP} | Set to Required |
profile_picture_handlestring | Profile picture media asset handle, generated via the Resumable Upload API. |
verticalenum {OTHER, AUTO, BEAUTY, APPAREL, EDU, ENTERTAIN, EVENT_PLAN, FINANCE, GROCERY, GOVT, HOTEL, HEALTH, NONPROFIT, PROF_SERVICES, RETAIL, TRAVEL, RESTAURANT, ALCOHOL, ONLINE_GAMBLING, PHYSICAL_GAMBLING, OTC_DRUGS, MATRIMONY_SERVICE} | Business category. These values map to the following strings, which are displayed in the business profile in the WhatsApp client.
|
websitesarray<URI> | URLs associated with the business, such as a website, Facebook Page, or Instagram profile. Strings must be prefixed with
|
success: bool, | Error | Description |
|---|---|
| 100 | Invalid parameter |
| 200 | Permissions error |
| 131000 | Something went wrong |
| 131009 | Parameter value is not valid |
| 131031 | Business Account locked |
| 105 | The number of parameters exceeded the maximum for this operation |