API Status
Mensagens
Grupos
Fila de jobs
Configurações
Enviar contato
Envia uma mensagem de contato para um número de telefone ou grupo.
curl --request POST \
--url https://api.zapperapi.com/{instanceId}/messages/contact \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{
"jid": "<string>",
"vcard": {
"fn": "<string>",
"n": {
"lastName": "<string>",
"firstName": "<string>",
"additionalNames": [
"<string>"
],
"prefixes": [
"<string>"
],
"suffixes": [
"<string>"
]
},
"nickname": "<string>",
"photo": "<string>",
"bday": "<string>",
"adr": [
{
"postOfficeBox": "<string>",
"extendedAddress": "<string>",
"streetAddress": "<string>",
"locality": "<string>",
"region": "<string>",
"postalCode": "<string>",
"countryName": "<string>",
"type": [
"<string>"
]
}
],
"tel": [
{
"value": "<string>",
"type": [
"<string>"
]
}
],
"email": [
{
"value": "jsmith@example.com",
"type": [
"<string>"
]
}
],
"url": "<string>",
"org": [
"<string>"
],
"title": "<string>",
"role": "<string>",
"logo": "<string>",
"note": "<string>",
"categories": [
"<string>"
]
}
}'
Authorizations
Chave privada da API
Body
Número de telefone ou id do grupo. Em caso de número
de telefone, o mesmo deve ser enviado no formato completo, com código do
país, e o prefixo +
não é obrigatório. Números de telefone podem ser
ou não pós-fixados com @s.whatsapp.net
. Em caso de grupo, o id deve
ser enviado acrescido de @g.us
.
Exemplos de uso correto:
+5511912345678
5511912345678
5511912345678@s.whatsapp.net
12345678-987654321@g.us
1
Nome completo do contato
Os componentes estruturados no nome do contato
Apelido
URL da foto ou imagem em formato base64
Data de nascimento do contato
Dados estruturados do endereço
Caixa postal
Detalhes adicionais do endereço
Nome da rua
Cidade ou localização
Estado ou província
Código postal (CEP/zipcode)
Nome do país
Tipo de endereço (ex: 'home', 'work').
Url do website do contato
Dados da organização do contato
Título do contato em sua organização
Papel ou ocupação do contato em sua organização
URL do logo
Notas adicionais
Tags/categorias associadas ao contato
Response
Default Response
curl --request POST \
--url https://api.zapperapi.com/{instanceId}/messages/contact \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{
"jid": "<string>",
"vcard": {
"fn": "<string>",
"n": {
"lastName": "<string>",
"firstName": "<string>",
"additionalNames": [
"<string>"
],
"prefixes": [
"<string>"
],
"suffixes": [
"<string>"
]
},
"nickname": "<string>",
"photo": "<string>",
"bday": "<string>",
"adr": [
{
"postOfficeBox": "<string>",
"extendedAddress": "<string>",
"streetAddress": "<string>",
"locality": "<string>",
"region": "<string>",
"postalCode": "<string>",
"countryName": "<string>",
"type": [
"<string>"
]
}
],
"tel": [
{
"value": "<string>",
"type": [
"<string>"
]
}
],
"email": [
{
"value": "jsmith@example.com",
"type": [
"<string>"
]
}
],
"url": "<string>",
"org": [
"<string>"
],
"title": "<string>",
"role": "<string>",
"logo": "<string>",
"note": "<string>",
"categories": [
"<string>"
]
}
}'