Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-contact
Enviar contato
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-contact \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "contactName": "<string>",
  "contactPhone": "<string>"
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Neste método você poderá compartilhar informações de um contato sem a necessidade que o destinatário o possua em seus contatos. Basta preencher os atributos do método com os dados do contato e enviar.

​
Exemplo no WhatsApp

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Obrigatórios

​
phone
string
obrigatório
Telefone (ou ID do grupo para casos de envio para grupos) do destinatário no formato DDI DDD NÚMERO. Ex: 551199999999
​
contactName
string
obrigatório
Nome do contato
​
contactPhone
string
obrigatório
Número do telefone a ser compartilhado

​
Opcionais

​
contactBusinessDescription
string
Breve descrição do contato (não é exibida no WhatsApp Web)
​
messageId
string
Atributo utilizado para responder uma mensagem do chat, basta adicionar o messageId da mensagem que queira responder neste atributo
​
delayMessage
number
Delay adicionado na mensagem. Você pode decidir entre um range de 1 a 15 sec, significa quantos segundos ele vai esperar para enviar a próxima mensagem. (Ex.: “delayMessage”: 5). O delay default caso não seja informado é de 1 a 3 sec

​
Request Body

{
  "phone": "5511999999999",
  "contactName": "Z-API Contato",
  "contactPhone": "554498398733"
}

​
Response

​
200

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.