Vamos desativar o Google Business Messages em 31 de julho de 2024.
Clique aqui para mais informações.
Definir seu webhook
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Um webhook é um callback HTTPS criado pelo parceiro que especifica como seu agente
precisa responder a mensagens e eventos. A menos que você use um modelo
do Google, como o Dialogflow,
você precisa configurar um webhook personalizado para definir o comportamento do seu agente.
Webhooks no nível do parceiro e do agente
É possível definir seu webhook no nível do parceiro ou do agente.
Os webhooks no nível do parceiro se aplicam a todos os agentes que você mantém. Já no nível do agente,
cada um deles se aplica a um agente individual.
Se você opera vários agentes com comportamento distinto, defina um
webhook diferente para cada agente usando a configuração no nível do agente. No outro
caso seus agentes tenham um comportamento semelhante ou caso haja apenas um agente,
podem usar o webhook no nível do parceiro.
Se você tiver configurado um webhook no nível do parceiro e outro no nível do agente,
o webhook no nível do agente tem precedência sobre seu agente específico, enquanto o
O webhook no nível do parceiro se aplica a agentes que não têm um nível de agente
ou webhook.
Definir o webhook no nível do parceiro
Para definir o webhook no nível do parceiro, siga estas etapas:
- Abra o Console para desenvolvedores do Business Communications.
e faça login com sua Conta do Google no Business Messages.
- Abra as Configurações da conta.
- Verifique se a conta do parceiro correta está selecionada.
- Em URL do webhook do Business Messages, clique em Configurar.
- Em URL do endpoint do webhook, insira o URL do aplicativo + "/callback/".
Por exemplo, pode ser algo como "https://PROJECT_ID.appspot.com/callback/".
- Anote o valor de
clientToken
. Você precisa dela para confirmar se as mensagens que recebe são provenientes do Google.
Configure seu webhook para aceitar uma solicitação POST com o tipo
o parâmetro clientToken
e enviar uma resposta 200 OK
com o texto simples
do parâmetro secreto como o corpo da resposta. Por exemplo, suponha
O webhook recebe uma solicitação POST com o seguinte conteúdo do corpo:
{
"clientToken":"SJENCPGJESMGUFPY",
"secret":"0123456789"
}
Nesse caso, o webhook precisa confirmar o valor clientToken
e, se
clientToken
está correta, retorne uma resposta 200 OK
com 0123456789
como o
corpo da resposta.
No console, clique em Verificar. Quando o recurso Business Messages verifica seu webhook,
a caixa de diálogo é fechada.
Definir um webhook no nível do agente
Você recebe mensagens enviadas ao agente no webhook no nível do parceiro. Se você
quiser que as mensagens de um agente específico cheguem em um webhook diferente,
pode definir um webhook no nível do agente.
- Abra o Console para desenvolvedores do Business Communications.
e faça login com sua Conta do Google no Business Messages.
- Clique no seu agente.
- Clique em Integrations.
- Em Webhook, clique em Configurar.
- Em URL do endpoint do webhook, insira o URL do webhook, que começa com
"https://".
- Anote o valor de
clientToken
. Ela é necessária para verificar se as mensagens enviadas
que recebem vêm do Google.
Configure seu webhook para aceitar uma solicitação POST com o tipo
clientToken
e envie uma resposta 200 OK com o valor do
parâmetro secreto. Por exemplo, suponha que o webhook receba uma solicitação POST
pelo seguinte conteúdo de corpo:
{
"clientToken":"SJENCPGJESMGUFPY",
"secret":"0123456789"
}
Nesse caso, o webhook precisa confirmar o valor clientToken
e, se
clientToken
está correta, retorne uma resposta 200 OK
com o URL secreto
definido como 0123456789
.
No console, clique em Verificar. Quando o recurso Business Messages verifica seu webhook,
a caixa de diálogo é fechada.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2024-10-14 UTC.
[null,null,["Última atualização 2024-10-14 UTC."],[[["\u003cp\u003eA webhook defines how your agent responds to messages and events, and should be set at either the partner or agent level, depending on your needs.\u003c/p\u003e\n"],["\u003cp\u003ePartner-level webhooks apply to all agents under your account, whereas agent-level webhooks are specific to individual agents and take precedence.\u003c/p\u003e\n"],["\u003cp\u003eTo set a webhook, you provide an endpoint URL, obtain a clientToken for verification, and configure your webhook to handle verification requests from Google.\u003c/p\u003e\n"],["\u003cp\u003eThe verification process involves receiving a POST request with a clientToken and secret, validating the clientToken, and responding with a 200 OK and the secret value.\u003c/p\u003e\n"],["\u003cp\u003eYou can set up your webhook using either the Business Communications Developer Console or the API.\u003c/p\u003e\n"]]],[],null,["# Set your webhook\n\n| Choose whether to set your webhook with the Business Communications [Developer\n| Console](https://business-communications.cloud.google.com?utm_source=/business-communications/business-messages/guides/how-to/agents/set-webhook&utm_medium=devsite&utm_campaign=business-messages) or [API](/business-communications/business-messages/reference/business-communications/rest). \n| Developer Console API\n\nA webhook is a partner-created HTTPS callback that specifies how your agent\nshould respond to messages and events. Unless you're using a pre-built automated\nsolution like [Dialogflow](/business-communications/business-messages/guides/how-to/integrate/dialogflow#dialogflow_integration),\nyou need to set a custom webhook to define the behavior for your agent.\n\nPartner-level and agent-level webhooks\n--------------------------------------\n\nYou can set your webhook either at the partner level or at the agent level.\nPartner-level webhooks apply to every agent you maintain, while agent-level\nwebhooks each apply to one individual agent.\n\nIf you operate multiple agents with distinct behavior, you may wish to set a\ndifferent webhook for each agent using the agent-level setting. On the other\nhand, if your agents have similar behavior, or if you only have one agent, you\ncan use the partner-level webhook.\n\nIf you have both a partner-level webhook and an agent-level webhook configured,\nthe agent-level webhook takes precedence on its specific agent, while the\npartner-level webhook applies to agents that don't have an agent-level\nwebhook.\n\nSet your partner-level webhook\n------------------------------\n\nTo set your partner-level webhook, follow these steps:\n\n1. Open the [Business Communications Developer Console](https://business-communications.cloud.google.com?utm_source=/business-communications/business-messages/guides/how-to/agents/set-webhook&utm_medium=devsite&utm_campaign=business-messages) and sign in with your Business Messages Google account.\n2. Open the [Account settings](https://business-communications.cloud.google.com/console/partner/settings?utm_source=/business-communications/business-messages/guides/how-to/set-webhook&utm_medium=devsite&utm_campaign=business-messages).\n3. Make sure the correct partner account is selected.\n4. For **Business Messages webhook URL** , click **Configure**.\n5. For **Webhook endpoint URL**, enter your application's URL + \"/callback/\". For example, it might be something like \"https://PROJECT_ID.appspot.com/callback/\".\n6. Note your `clientToken` value. You need it to [verify that messages you receive are coming from Google](/business-communications/business-messages/guides/how-to/message/receive#verify).\n7. Configure your webhook to accept a POST request with the specified\n `clientToken` parameter and send a `200 OK` response with the plain text\n value of the secret parameter as the response body. For example, suppose your\n webhook receives a POST request with the following body content:\n\n {\n \"clientToken\":\"SJENCPGJESMGUFPY\",\n \"secret\":\"0123456789\"\n }\n\n In that case, your webhook should confirm the `clientToken` value and, if\n `clientToken` is correct, return a `200 OK` response with `0123456789` as the\n response body.\n8. In the console, click **Verify**. When Business Messages verifies your webhook,\n the dialog closes.\n\nSet an agent-level webhook\n--------------------------\n\nYou receive messages sent to your agent at your partner-level webhook. If you\nwant messages for a specific agent to arrive at a different webhook instead, you\ncan set an agent-level webhook.\n\n1. Open the [Business Communications Developer Console](https://business-communications.cloud.google.com?utm_source=/business-communications/business-messages/guides/how-to/agents/set-webhook&utm_medium=devsite&utm_campaign=business-messages) and sign in with your Business Messages Google account.\n2. Click your agent.\n3. Click **Integrations**.\n4. For **Webhook** , click **Configure**.\n5. For **Webhook endpoint URL**, enter your webhook's URL, beginning with \"https://\".\n6. Note your `clientToken` value. You need it to [verify that messages you\n receive are coming from Google](/business-communications/business-messages/guides/how-to/message/receive#verify).\n7. Configure your webhook to accept a POST request with the specified\n `clientToken` parameter and send a 200 OK response with the value of the\n secret parameter. For example, suppose your webhook receives a POST request\n with the following body content:\n\n {\n \"clientToken\":\"SJENCPGJESMGUFPY\",\n \"secret\":\"0123456789\"\n }\n\n In that case, your webhook should confirm the `clientToken` value and, if\n `clientToken` is correct, return a `200 OK` response with the secret URL\n parameter set to `0123456789`.\n8. In the console, click **Verify**. When Business Messages verifies your webhook,\n the dialog closes."]]