Enviar Contato

Metodo

POST https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/contact

Conceituacao

Envia um cartao de contato (vCard) para um numero de telefone atraves de um canal conectado. O destinatario recebera o contato formatado como um cartao que pode ser salvo diretamente na agenda do celular.

Atributos

Header

Atributo	Tipo	Obrigatorio	Descricao
Authorization	string	Sim	Bearer {API_KEY} - Chave de autenticacao da API
Content-Type	string	Sim	application/json

Path Parameters

Atributo	Tipo	Obrigatorio	Descricao
channelId	string	Sim	ID do canal pelo qual a mensagem sera enviada.

Body

Atributo	Tipo	Obrigatorio	Descricao
to	string	Sim	Numero do destinatario no formato DDI+DDD+NUM.
name	string	Sim	Nome completo do contato.
phone	string	Sim	Numero de telefone do contato no formato DDI+DDD+NUM.
email	string	Nao	Email do contato.
organization	string	Nao	Organizacao do contato.

Request

cURL

curl -X POST "https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/contact" \
  -H "Authorization: Bearer {API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "5511999998888",
    "name": "Maria Silva - Suporte",
    "phone": "5511988887777"
  }'

Node.js

const axios = require('axios');

const response = await axios.post(
  'https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/contact',
  {
    to: "5511999998888",
    name: "Maria Silva - Suporte",
    phone: "5511988887777"
  },
  {
    headers: {
      'Authorization': 'Bearer {API_KEY}',
      'Content-Type': 'application/json'
    }
  }
);

console.log(response.data);

Python

import requests

response = requests.post(
    'https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/contact',
    json={
        'to': '5511999998888',
        'name': 'Maria Silva - Suporte',
        'phone': '5511988887777'
    },
    headers={
        'Authorization': 'Bearer {API_KEY}',
        'Content-Type': 'application/json'
    }
)

print(response.json())

Response

202 - Aceito

{
  "success": true,
  "message": "Mensagem enfileirada para envio"
}

400 - Dados invalidos

{
  "message": "Dados de entrada invalidos.",
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "field": "name",
      "message": "O nome do contato e obrigatorio."
    }
  ]
}

401 - Nao autorizado

{
  "message": "Token de autenticacao invalido ou ausente.",
  "code": "UNAUTHORIZED"
}

429 - Rate limit excedido

{
  "message": "Limite de requisicoes excedido. Tente novamente em alguns segundos.",
  "code": "RATE_LIMIT_EXCEEDED"
}