integração api integração api, Manuais, Projetos, Pesquisas de Matérias técnicas

Baixe integração api integração api e outras Manuais, Projetos, Pesquisas em PDF para Matérias técnicas, somente na Docsity!

API DE INTEGRAÇÃO

v1.

Solicitações

Quando o contato selecionar o menu de Integração, será realizada uma solicitação POST para o endpoint configurado. Após isso, você terá o controle sobre todas as mensagens e seus respectivos comportamentos, podendo construir menus dinâmicos ou retornar informações contidas em seus sistemas.

Na solicitação HTTP, será incluído o header mz-integration , contendo a informação configurada no menu.

O corpo da solicitação HTTP é enviado no formato JSON e atende o padrão abaixo. Os atributos com asterisco, são obrigatórios.

● *id : código da solicitação. ● *text : texto que o contato digitou. ● *contact : informações do contato em nosso sistema. ○ *uid : código do contato. ○ *type : origem do contato, podendo ter as opções: WHATSAPP, FACEBOOK e BOTSITE. ○ *key: número do telefone ou código do canal do cliente ○ *name : nome do contato. ○ *fields : campos de segmentação. ● data: o conteúdo desse atributo será dinâmico, pois você irá informar na resposta de uma solicitação.

Veja um exemplo do corpo da solicitação que será enviada no início da integração:

" id ": 215123 , " text ": "Hello world!", " contact ": { " uid ": " 15295 ", " type ": "WHATSAPP", " key ": " 5513999999999 ", " name ": "Robson", " fields ": { " cpf ": "111.111.111-11", " celular ": "(11) 11111-1111" } }, " data ": {} }

}],

" items ": [{ " number ": 1 , " text ": "Menu 1", " callback ": { " endpoint ": "https://yourdomain.com/api/menu_1", " data ": { " example ": "Additional information" } } }, { " number ": 2 , " text ": "Menu 2", " callback ": { " endpoint ": "https://yourdomain.com/api/menu_2", " data ": {} } }] }

PERGUNTA

Será enviada uma mensagem de texto para o contato, podendo conter anexos, esperando apenas uma mensagem de texto do contato.

O corpo da solicitação HTTP é enviado no formato JSON e atende o padrão abaixo. Os atributos com asterisco, são obrigatórios.

*● type: QUESTION. *● text: texto que será enviado para o contato. ● attachments: lista de anexos que serão enviados. *○ position: a posição do anexo, referente ao texto, podendo ser: BEFORE (antes) ou AFTER (depois). *○ type: tipo do anexo, podendo ser: IMAGE (imagem) ou DOCUMENT (documento). *○ name: o nome do anexo. ○ url: o caminho público onde está o anexo. *● callback: o caminho que será solicitado quando o contato escolher essa opção. *○ endpoint: o caminho público que será solicitado. ○ data: estrutura em JSON, contendo informações adicionais que serão enviadas na solicitação.

Veja um exemplo do corpo da resposta:

" type ": "QUESTION", " text ": "Enter your document number.", " attachments ": [{ " position ": "BEFORE", " type ": "IMAGE", " name ": "image.png", " url ": "https://yourdomain.com/cdn/logo.png" }], " callback ": { " endpoint ": "https://yourdomain.com/api/question", " data ": { " example ": "Additional information" } } }

INFORMAÇÃO

Será enviada uma mensagem de texto para o contato, podendo conter anexos.

O corpo da solicitação HTTP é enviado no formato JSON e atende o padrão abaixo. Os atributos com asterisco, são obrigatórios.

*● type: INFORMATION. *● text: texto que será enviado para o contato. ● attachments: lista de anexos que serão enviados. *○ position: a posição do anexo, referente ao texto, podendo ser: BEFORE (antes) ou AFTER (depois). *○ type: tipo do anexo, podendo ser: IMAGE (imagem) ou DOCUMENT (documento). *○ name: o nome do anexo. *○ url: o caminho público onde está o anexo.

Veja um exemplo do corpo da resposta:

" type ": "INFORMATION", " text ": "Your invoice.", " attachments ": [{ " position ": "BEFORE",

" type ": "CREATE_CUSTOMER_SERVICE", " departmentUUID ": "88a4fbb2-7df3-4fd1-85ea-68956400cf88" }

Veja um exemplo do corpo da resposta para criar para o departamento e atendente:

" type ": "CREATE_CUSTOMER_SERVICE", " departmentUUID ": "88a4fbb2-7df3-4fd1-85ea-68956400cf88", " userUUID ": "88a4fbb2-7df3-4fd1-85ea-68956400cf88" }