API de Marketing
Versão Graph API

Business Client Whatsapp Business Accounts

Leitura

Get a list of WhatsApp Business Accounts on a Business.

Example

Requirements

  • whatsapp_business_management permission

  • whatsapp_business_messaging permission

  • public_profile permission

  • BUSINESS ID (also referred to as BUSINESS MANAGER ID in Business Settings)

  • ADMIN SYSTEM USER ACCESS TOKEN for the business

Request

curl -i -X GET \
'https://graph.facebook.com/LATEST-VERSION/BUSINESS-ID/client_whatsapp_business_accounts' \
-H 'Authorization: Bearer USER-ACCESS-TOKEN'
GraphRequest request = GraphRequest.newGraphPathRequest(
  accessToken,
  "/BUSINESS-ID/client_whatsapp_business_accounts",
  new GraphRequest.Callback() {
    @Override
    public void onCompleted(GraphResponse response) {
      // Insert your code here
    }
});

request.executeAsync();
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
    initWithGraphPath:@"/BUSINESS-ID/client_whatsapp_business_accounts"
           parameters:nil
           HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection, id result, NSError *error) {
    // Insert your code here
}];

Response

{
  "data": [
  ]
}

Request with Filtering

curl -i -X GET \
"https://graph.facebook.com/LATEST-VERSION/BUSINESS-ID/client_whatsapp_business_accounts \
   ?fields=id,name,ownership_type \
   &filtering=[{'field':'ownership_type', 'operator': 'IN', 'value': ['SELF', 'CLIENT_OWNED']}]" \
-H 'Authorization: Bearer USER-ACCESS-TOKEN'

Parâmetros

Este ponto de extremidade não tem nenhum parâmetro.

Campos

A leitura desta borda retornará um resultado formatado em JSON:

{
    "data": [],
    "paging": {}
}

data

Uma lista de nós WhatsAppBusinessAccount.

Os seguintes campos serão adicionados a cada nó que for retornado:

CampoDescrição
permitted_tasks
list<string>

Tasks that are assignable to users on this asset

paging

Para saber mais detalhes sobre paginação, consulte o Guia da Graph API.

Error Codes

ErroDescrição
200Permissions error
368The action attempted has been deemed abusive or is otherwise disallowed
104Incorrect signature
190Invalid OAuth 2.0 Access Token
100Invalid parameter
200008WhatsApp Business Account has no linked phone numbers.

Criando

Não é possível executar esta operação neste ponto de extremidade.

Atualizando

Não é possível executar esta operação neste ponto de extremidade.

Excluindo

Não é possível executar esta operação neste ponto de extremidade.