Ir para o site

Base de Conhecimento

Como podemos te ajudar?

Obter Contato

API: WhatsApp - Obter Assinante

API: WhatsApp - Obter Assinante

Recupere as informações de um assinante usando o ID de chat (número de telefone).

Ponto Final da API: Obter Assinante (POST)

URL: https://app.wizebot.com.br/api/v1/whatsapp/subscriber/get

Parâmetros Requeridos

  • apiToken: Sua chave de API (String | Obrigatório)
  • phone_number_id: ID do número da conta do WhatsApp (String | Obrigatório)
  • phone_number: Número de telefone do assinante (String | Obrigatório)

Exemplo de Solicitação GET

https://app.wizebot.com.br/api/v1/whatsapp/subscriber/get?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER

Exemplo de Solicitação POST

curl -X POST \ 
'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/get' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER'

Exemplo de Resposta

{
"status":"1",
"message":[{"subscriber_id":144,"chat_id":"8801521455XXX","first_name":"Md Ronok","last_name":"Ronok","email":"test@gmail.com","gender":"Male","label_names":"Label1,Label2"}]
}
API: WhatsApp - Lista de Assinantes

API: WhatsApp - Lista de Assinantes

Obtenha uma lista de assinantes do seu número de WhatsApp.

Ponto Final da API: Lista de Assinantes (GET/POST)

URL: https://app.wizebot.com.br/api/v1/whatsapp/subscriber/list

Parâmetros Requeridos

  • apiToken: Sua chave de API (String | Obrigatório)
  • phone_number_id: Seu número de telefone do WhatsApp (String | Obrigatório)
  • limit: Número de assinantes a ser buscado (Number | Obrigatório)
  • offset: Deslocamento de paginação (Number | Opcional)

Exemplo de Solicitação GET

https://app.wizebot.com.br/api/v1/whatsapp/subscriber/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&limit=10&offset=1

Exemplo de Solicitação POST

curl -X POST \ 
'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/list' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'limit=10' \
-d 'offset=1'

Exemplo de Resposta

{
"status":"1",
"message":[
    {"subscriber_id":144,"chat_id":"880152145XXX","first_name":"Mamuduzzaman","last_name":"Ronok","email":"test@gmail.com","gender":"male","label_names":"One ,two"},
    {"subscriber_id":157,"chat_id":"8801518951XXX","first_name":"Rahim","last_name":"Karim","email":"null","gender":"Male","label_names":"ChatTest,remove tag,One"}
]}
API: WhatsApp - Criar Assinante

API: WhatsApp - Criar Assinante

Crie um novo assinante ou contato no seu WhatsApp.

Ponto Final da API: Criar Assinante (POST)

URL: https://app.wizebot.com.br/api/v1/whatsapp/subscriber/create

Parâmetros Requeridos

  • apiToken: Sua chave de API (String | Obrigatório)
  • phoneNumberID: ID do número da conta do WhatsApp (String | Obrigatório)
  • name: Nome do seu assinante (String | Obrigatório)
  • phoneNumber: Número de telefone do assinante com código do país (sem sinal +) (String | Obrigatório)

Exemplo de Solicitação GET

https://app.wizebot.com.br/api/v1/whatsapp/subscriber/create?apiToken=API-KEY&phoneNumberID=PHONE-NUMBER-ID&name=NAME&phoneNumber=MOBILE

Exemplo de Solicitação POST

curl -X POST \ 
'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/create' \
-d 'apiToken=API-KEY' \
-d 'phoneNumberID=PHONE-NUMBER-ID' \
-d 'name=NAME' \
-d 'phoneNumber=MOBILE'

Exemplo de Resposta

{
"status":"1",
"message":"Assinante do WhatsApp criado com sucesso."
}
{
"status":"0",
"message":"Conta do WhatsApp não encontrada."
}
{
"status":"0",
"message":"O limite de assinantes foi excedido. Você não pode ter mais assinantes."
}
{
"status":"0",
"message":"Algo deu errado ou o assinante já existe."
}
API: WhatsApp - Atualizar Assinante

API: WhatsApp - Atualizar Assinante

Atualize as informações de um assinante existente na sua conta do WhatsApp.

Ponto Final da API: Atualizar Assinante (POST)

URL: https://app.wizebot.com.br/api/v1/whatsapp/subscriber/update

Parâmetros Requeridos

  • apiToken: Sua chave de API (String | Obrigatório)
  • phone_number_id: ID do número da conta do WhatsApp (String | Obrigatório)
  • phone_number: Número de telefone do assinante (String | Obrigatório)

Parâmetros Opcionais

  • first_name: Primeiro nome do seu assinante (String | Opcional)
  • last_name: Sobrenome do seu contato (String | Opcional)
  • gender: Sexo do seu assinante (String | Opcional)
  • label_ids: IDs de rótulo separados por vírgula, como (1,4,5) (String | Opcional)

Exemplo de Solicitação GET

https://app.wizebot.com.br/api/v1/whatsapp/subscriber/update?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&first_name=FIRST-NAME&last_name=LAST-NAME&gender=GENDER&label_ids=LABEL-IDS

Exemplo de Solicitação POST

curl -X POST \ 
'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/update' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'first_name=FIRST-NAME' \
-d 'last_name=LAST-NAME' \
-d 'gender=GENDER' \
-d 'label_ids=LABEL-IDS'

Exemplo de Resposta

{
"status":"1",
"message":"Assinante atualizado com sucesso."
}
API: WhatsApp - Atribuir Chat a Membro da Equipe

API: WhatsApp - Atribuir Chat a Membro da Equipe

Atribua o chat de um assinante a um membro da equipe na sua conta do WhatsApp.

Ponto Final da API: Atribuir Chat a Membro da Equipe (POST)

URL: https://app.wizebot.com.br/api/v1/whatsapp/subscriber/chat/assign-to-team-member

Parâmetros Requeridos

  • apiToken: Sua chave de API (String | Obrigatório)
  • phone_number_id: Seu número de telefone do WhatsApp (String | Obrigatório)
  • phone_number: Número de telefone do assinante (String | Obrigatório)
  • team_member_id: ID do membro da equipe (Integer | Obrigatório)

Exemplo de Solicitação GET

https://app.wizebot.com.br/api/v1/whatsapp/subscriber/chat/assign-to-team-member?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&team_member_id=TEAM-MEMBER-ID

Exemplo de Solicitação POST

curl -X POST \ 
'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/chat/assign-to-team-member' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'team_member_id=TEAM-MEMBER-ID'

Exemplo de Resposta

{
"status":"1",
"message":"Agente atribuído à conversa com sucesso."
}
API: WhatsApp - Atribuir Campos Personalizados ao Assinante

API: WhatsApp - Atribuir Campos Personalizados ao Assinante

Atribua campos personalizados a um assinante na sua conta do WhatsApp.

Ponto Final da API: Atribuir Campos Personalizados ao Assinante (POST)

URL: https://app.wizebot.com.br/api/v1/whatsapp/subscriber/chat/assign-custom-fields

Parâmetros Requeridos

  • apiToken: Sua chave de API (String | Obrigatório)
  • phone_number_id: Seu número de telefone do WhatsApp (String | Obrigatório)
  • phone_number: Número de telefone do assinante (String | Obrigatório)
  • custom_fields: Nome e valor dos campos personalizados em formato JSON (JSON | Obrigatório)

Exemplo de Solicitação POST

curl -X POST \ 
'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/chat/assign-custom-fields' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'custom_fields={"custom_field_name1": "custom_field_value1","custom_field_name2": "custom_field_value2"}'

Exemplo de Resposta

{
"status":"1",
"message":"As alterações do assinante foram salvas com sucesso."
}

Dúvidas?

Chame a gente no WhatsApp!

Dúvidas?

Chame a gente no E-mail.

Acreditamos que serviços de qualidade não precisam ser inacessíveis. Na WizeBot, estamos empenhados em levar o melhor atendimento e soluções inovadoras aos nossos clientes a um custo razoável.
Facebook-f Instagram Linkedin-in Youtube
Soluções
Apoio
Institucional
Copyright© 2024 Wizebot, Todos os direitos reservados.
plugins premium WordPress