Graph API Version

WhatsApp Business Account To Number Current Status

Represents a specific phone number. Make the API call to the phone number ID.

To a phone number's ID, call to https://graph.facebook.com/v12.0/{whatsapp-business-account-ID}/phone_numbers. Replace {whatsapp-business-account-ID} with the ID of the WhatsApp Business Account the phone number belongs to. See Get all phone numbers for an example.

For more information on how to use the API, see WhatsApp Business Management API.

GET calls to /{whats-app-business-account-to-number-current-status-id} are now subject to Business Use Case Rate Limits.

Reading

Returns information about a specific phone number.

Example

Graph API Explorer
GET /v12.0/{whats-app-business-account-to-number-current-status-id} 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(
    '/{whats-app-business-account-to-number-current-status-id}',
    '{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(
    "/{whats-app-business-account-to-number-current-status-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{whats-app-business-account-to-number-current-status-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{whats-app-business-account-to-number-current-status-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
id
numeric string

ID

account_mode
enum

The account mode of the phone number

certificate
string

Certificate of the phone number

code_verification_status
enum

Phone code OTP (one-time password) verification status. Possible returned values are NOT_VERIFIED and VERIFIED. See Get Phone's OTP Status to learn how to use this field.

display_phone_number
string

International format representation of the phone number

name_status
enum

The status of the name review

new_certificate
string

Certificate of the new name that was requested

new_name_status
enum

The status of the review of the new name requested

quality_score

Quality score of the phone

status
enum {PENDING, DELETED, MIGRATED, BANNED, RESTRICTED, RATE_LIMITED, FLAGGED, CONNECTED, DISCONNECTED, UNKNOWN}

The operating status of the phone number (eg. connected, rate limited, warned)

Edges

EdgeDescription

QR and deep links to begin a conversation with the business on this phone number.

Error Codes

ErrorDescription
100Invalid parameter
200Permissions error

Creating

You can make a POST request to phone_numbers edge from the following paths:
When posting to this edge, a WhatsAppBusinessAccountToNumberCurrentStatus will be created.

Parameters

ParameterDescription
cc
string

Country dial code of the phone number (for example, "1")

migrate_phone_number
boolean

Set this field to true for migrating a registered phone number from another WhatsApp Business Account into this WhatsApp Business Account

phone_number
string

Phone number without the country code

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.
Struct {
id: numeric string,
}

Error Codes

ErrorDescription
100Invalid parameter
200Permissions error

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.