webhooks (POST)
Last updated
Last updated
Cria um novo web hook para eventos variados.
Importante! Reenviamos sem sucesso um evento webhook 3 vezes: em 10 secondos, em 5 minutos e em 2 horas. Para evitar sobrecarga, o webhook será desativado após 5 horas sem resposta de sucesso de recepção de dados. Você pode usar métodos Webhook (GET) e olha um seção de “erros” para mais detalhes.
Request:
Body do Request:
Parâmetros:
• name–nome do webhook criado. Até 5 webhooks são permitidos.
• url – URL no seu servidor de onde os requests virão. Qualquer URL é permitida mas recomendamos https. Se o valor vazio (null) é definido, então o webhook é excluído
• eventos – lista de eventos para os quais o webhook será engatilhado.
o inbox – mensagens recebidas do cliente.
Example of data: Array ([message_id] => 106773169 [type] => from_client [text] => Text [transport]=>telegram[client_id]=>100[operator_id]=> [dialog_id] => [channel_id] => 17 [photo] => [coordinates] => [audio] => [pdf]=> [client]=> Array ([id] => 17340089 [phone] => [tg] 807892 [client_phone] => [name] => Peter [assigned_name] => [external_id]=>)[hook_type]=>inbox[request_id]=>8725057 [attachments] => Array ( ) [is_new_request] => 1 [is_new_client] =>[extra_data] => Array ( ) [event_time] => 2019-07-28T23:01:40Z)
o outbox –mensagens sendo enviadas pelo sistema para um cliente.
Example of data: Array ([message_id] => 106773577 [type] => to_client [text] => Bc[ [transport]=>telegram[client_id]=>17[operator_id]=>41164 [dialog_id] => 4324035 [channel_id] => 17404 [photo] => [coordinates]=>[audio]=>[pdf]=>[client]=>Array ([id]=> 17340089 [phone] => [tg] 807892 [client_phone] => [name] => Peter [assigned_name] => [external_id] => ) [hook_type] => outbox [request_id] => 8725095 [attachments] => Array ()[is_new_request] => [is_new_client] => [event_time] => 2019-07-28T23:01:40Z)
o outbox_status – envia erros, recebidos pela chat2desk pela API de mensageiros.
Example of event: MessagefromoperatorwasprocessedbyChat2Deskand senttoWhatsappBusinessAPI,butWABAresponded with error – «timeout error». Example of data: Array ([id] => 106773577 [external_id] => 41164 [dialog_id] => 4324035 [client_id] => 17 [channel_id] => 17404 [created] => 2019- 07-28T23:01:40Z [gateway_status] => failed [error] => timeout error)
o new_client –primeira mensagem recebida de um cliente.
Example of data: Array ([id] => 18360561 [phone] => [tg] 1938691 [name] => Peter [avatar] => https://storage.chat2desk.com/clients/avatars/2018- 05/03-client2242811-5aeb3098bf2ec.jpg [assigned_name] => [comment] => [extra_comment_1] => [client_phone] => [extra_comment_2] => [extra_comment_3] => [channels] => Array ([id] => 17404 [transports] => Array ([0] => telegram ) ) [region_id] => [country_id] => [custom_fields] => [hook_type] => new_client [event_time] => 2019-07-28T23:01:40Z)
o add_tag_to_client – uma tag é atribuída a um cliente.
Example of data: Array ([id] => 4835 [name] => TestTag [description] => This is test tag [group_id] => 1190 [group_name] => Tag test group [client_id] => 17340089 => [all_client_channels] => 21288 => [hook_type] => add_tag_to_client [event_time] => 2019-07-28T23:01:40Z)
o add_tag_to_request – uma tag é atribuída a um pedido.
Example of data: Array ([id] => 4835 [name] => TestTag [description] => This is test tag [group_id] => 1190 [group_name] => Tag test group [client_id] => 17340089 [hook_type] => add_tag_to_request [event_time] => 2019-07-28T23:01:40Z)
o delete_tag_from_client – uma tag é excluída de um cliente.
Example of data: Array ([id] => 4835 [name] => TestTag [description] => This is test tag [group_id] => 1190 [group_name] => Tag test group [client_id] => 17340089 [hook_type] => delete_tag_to_client [event_time] => 2019-07-28T23:01:40Z)
o delete_tag_from_request Novo –uma tag é excluída de um pedido.
Example of data: Array ([id] => 4835 [name] => TestTag [description] => This is test tag [group_id] => 1190 [group_name] => Tag test group [client_id] => 17340089 [hook_type] => delete_tag_from_request [event_time] => 2019-07-28T23:01:40Z)
o client_updated -informações do cadastro do cliente são modificadas.
Example of data: Array ([id] => 18360561 [phone] => [tg] 1938691 [name] => Peter [avatar] => https://storage.chat2desk.com/clients/avatars/ava.jpg [assigned_name] => [comment] => [extra_comment_1] => [client_phone] => [extra_comment_2] => [extra_comment_3] => [channels]=>Array([id]=>17404[transports]=>Array([0]=> telegram))[region_id]=>[country_id]=>[custom_fields]=> [hook_type] => client_updated [event_time] => 2019-07- 28T23:01:40Z)
o close_dialog – uma conversa é fechada.
Example of data: Array ([dialog_id] => 4324035 [request_id] => 8725057 [created] => 1540282584 [updated] => 1540464524 [client_id] => 1000 [channel_id] => 17404 [operator_id] => 41164 [transport] => telegram [hook_type] => close_dialog [event_time] => 2019-07- 28T23:01:40Z)
o close_request – um pedido é fechado.
Example of data: Array ([dialog_id] => 3951761 [request_id] => 8086095 [created] => 1550671015 [updated] => 1550671015 [channel_id] => 126 [client_id] => 27129636 [operator_id] => 39538 [transport] => telegram [hook_type] => close_request [event_time] => 2019-07- 28T23:01:40Z)
o dialog_transferred–uma conversa é atribuída a um operador ou o operador responsável é alterado
Example of data: Array ([dialog_id] => 3951761 [request_id] => 8086095 [created] => 1550671015 [updated] => 1550671015 [channel_id] => 126 [client_id] => 27129636 [operator_id] => 39538 [current_operator_id] => 39538 [transport] => telegram [last_operator_id] => 8236 [scenario_id]=>124[hook_type]=>dialog_transferred [event_time] => 2019-07-28T23:01:40Z)
o new_qr_code – novo QR code para restaurar conexão com Whatsapp apareceu no site em Configurações/Contas. Significa que sua conexão com WhatsApp foi rompida e precisa ser reestabelecida.
Example of data: Array ([qrcode_data] => 1@OxrhCyoevcoool+z5GK+sBFL14vtAPH72jAl9eKQKO8VrSMSW3bsW zhx,Cf25AuQqLZmicHDNH9x3Og6gDMyXR9uVF16888S74g8=,BDVBT bHLr9gYB3LW52dNQQ== [qrcode_image] => data:image/png;base64,iVBORw0KG…= [phone] => 339002538473 [device_owner] => service [hook_type] => new_qr_code [event_time] => 2019-07-28T23:01:40Z)
ai_hints_requested–este webhooké para provedores de IA(Inteligência artificial) e é usado de 2 formas:
Um operador ou sistema requisitou dicas de IA (sugestôes) no modo prompter. Dicas (sugestões) do provedor IA são esperadas em retorno. Para entender o context o provedor deve manter todas as mensagens usando eventos webhooks inbox e outbox (recomendado) ou messages (GET).
Example of data: {"client_id":11910, "operator_id":1, "dialog_id":331, "request_id": 2343, "channel_id": 1, "message_id": 8205 [event_time] => 2019- 07-28T23:01:40Z}
Em retorno, Provedor IA deve enviar dicas (sugestões) no seguinte formato:
"message_id": 8205, "hints": [{"id": 1, "text": "answer 1", "url": "", "relevance": 90, "link": ""},{"id": 2, "text": "answer 2", "url": "", "relevance": 97, "link": ""}]
2. Um operador escolheu uma dica IA da lista acuma. Usou-a para ensinar o mecanismo de IA as respostas corretas.
Example of data: {"client_id": 11910, "message_id": 8205, "hint_id": 2, "hook_type": "ai_hints_requested" [event_time] => 2019-07- 28T23:01:40Z}
Para modificar webhooks existentes, use webhooks(PUT). Veja webhooks(GET)para seus webhooks atuais.
