Api Clientes - Envio de mensagem Whatsapp

Regras de negócio

Enviar mensagens por Whatsapp informando um telefone não cadastrado;
Enviar mensagens por Whatsapp para um contato já cadastrado.

Envio de Whatsapp Público existe a necessidade de informando o authorization no header.

End-Point

Endpoint	Método	Header Content-Type	Descrição

Endpoint	Método	Header Content-Type	Descrição
https://api.mosiaomnichannel.com.br/clientes/mensageria/whatsapp/envioAvulso	POST	application/json	Envio de mensagens por Whatsapp informando o telefone, não há necessidade de estar cadastrado.
https://api.mosiaomnichannel.com.br/clientes/mensageria/whatsapp/envioPorContato	POST	application/json	Envio de mensagens por Whatsapp informando a chave unica e recuperando o contato.

Headers

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro

Obrigatório

Tipo

Descrição

Authorization

M

token do cliente

Token de autenticação do cliente.

Clique aqui para ler a documentação sobre como obter o token de autenticação

Parâmetros de Body

Parâmetro	Endpoint	Obrigatório	Tipo	Descrição

Parâmetro	Endpoint	Obrigatório	Tipo	Descrição
identificadorMsg	Ambos	C	String	ID do registro usado para garantir envio único da mensagem.
idConfigWhatsapp	Ambos	M	String	ID do registro da configuração do Whatsapp
template	Ambos	M	JSON	Conjunto de informação para identificar template e montar macros
id	Ambos	M	String	ID do template de Whatsapp
vars	Ambos	M	JSON	Identificar as posições das macros para cada segmento da mensagem
dataHoraEnvio	Ambos	C	Date	Data para mensagem agendada. Formato `aaaa-mm-dd HH:mm:ss`
chaveUnica	/whatsapp/envioPorContato	M	String	Chave para localização do contato
protocolo	/whatsapp/envioPorContato	O	String	Protocolo do atendimento
Contato	/whatsapp/envioAvulso	C	JSON	Caso receber criar contato (Não implementado)
celularDestinatario	/whatsapp/envioPorContato	C	JSON	Caso receba considerar esse telefone
celularDestinatario	/whatsapp/envioAvulso	M	JSON	Envio sem a necessidade de um contato.

JSON Body

/whatsapp/envioAvulso

{
    "identificadorMsg" : "1",
    "idConfigWhatsapp": "63a45bfa127abfa74c1ac6b2",
    "template": {
        "id": "sdfsdfsdfew432434",
        "vars": {
            "header": [
                {
                    "Wanderson"
                }
            ],
            "body": [
                {
                    "200000215454545445"
                }
            ]
        }
    },
    "celularDestinatario": {
        "celular": "27992480823"
    },
    "agendamento":{
        "dataHoraEnvio": "2022-12-29 17:25:40"
    }
}

/whatsapp/envioPorContato

{
    "identificadorMsg" : "1",
    "idConfigWhatsapp": "63a45bfa127abfa74c1ac6b2",
    "template": {
        "id": "sdfsdfdsfe435345fgdsfsd",
        "vars": {
            "header": [
                {
                    "Wanderson"
                }
            ],
            "body": [
                {
                    "200000215454545445"
                }
            ]
        }
    },
    "celularDestinatario": {
        "celular": "27992480823"
    },
    "contatoDestinatario": {
        "chaveUnica": "everson@mobilesaude.com.br"
    },
      "ocorrencia": {
        "protocolo": "2000000000015452004"
    },
    "Contato" : {
		"nome" : "Geraldo",
		"chaveUnica" : "01911165615"
		"celular" : "278282828",
	},
    "agendamento":{
        "dataHoraEnvio": "2022-12-29 17:25:40"
    }
}

Agendamento de Mensagens

IMPORTANTE

Para envios agendados basta enviar usando o parâmetro dataHoraEnvio uma data e hora no formato descrito no Parâmetros de Body.

Objetos e atributos de retorno

Está indicado abaixo a estrutura de retorno do método de envio /whatsapp/envioAvulso e /whatsapp/envioPorContato por meio de Whatsapp.

Exemplo de retorno API (Sucesso)

{
    "status": true,
    "data": {},
    "message": "Envio realizado com sucesso.",
    "critical": [],
    "statusCode": 200,
    "timestamp": 1652450587322
}

Mosia Omnichannel