--- title: "Etapa 5: Enviar, receber ou importar mensagens" method: POST path: "/{scope_id}" --- # Etapa 5: Enviar, receber ou importar mensagens `POST /{scope_id}` ## Path parameters - `scope_id` string, required ## Headers - `Date` string, required - `Content-type` string - `Content-MD5` string - `X-Signature` string ## Request body - object - `RAW_BODY` object - `event_type` 'new_message' | 'edit_message' — Tipo de evento: atualmente, apenas `new_message` e `edit_message` são suportados. - `payload` object — Uma matriz contém os elementos da mensagem. - `timestamp` integer — Timestamp da mensagem no formato Unix Timestamp. - `msec_timestamp` string — Timestamp da mensagem em milissegundos. - `msgid` string — ID da mensagem do chat no lado da integração. - `conversation_id` string — ID do chat no lado da integração. - `conversation_ref_id` string — ID do chat no lado do Kommo. Deve ser enviado se o cliente responder a uma mensagem enviada com a função “Escrever primeiro”, para que o chat do seu lado seja associado ao chat no sistema. - `source` object — Fonte da mensagem. - `external_id` string — Identificador da fonte do chat no lado da integração. O comprimento do campo é de 40 caracteres, você pode usar qualquer caractere ASCII imprimível e um espaço. - `sender` object — Remetente da mensagem. - `id` string — ID do participante do chat no lado da integração. - `ref_id` string — ID do participante do chat no lado da API de Chats. - `name` string — Nome do participante do chat. - `avatar` string — Link para o avatar do participante do chat. O link deve estar disponível para recursos de terceiros e fornecer uma imagem para download. - `profile_link` string — Link para o perfil do participante do chat em um sistema de chat de terceiros. - `profile` object — Perfil do participante do chat. - `phone` string — Número de telefone. Ao criar um lead de entrada, o número de telefone será adicionado aos dados de contato - `email` string — Endereço de e-mail. Ao criar um lead de entrada, o endereço de e-mail será adicionado aos dados de contato - `receiver` object — Destinatário da mensagem. - `id` string — ID do participante do chat no lado da integração. - `ref_id` string — ID do participante do chat no lado da API de Chats. - `name` string — Nome do participante do chat. - `avatar` string — Link para o avatar do participante do chat. O link deve estar disponível para recursos de terceiros e fornecer uma imagem para download. - `profile_link` string — Link para o perfil do participante do chat em um sistema de chat de terceiros. - `profile` object — Perfil do participante do chat. - `phone` string — Número de telefone. Ao criar um lead de entrada, o número de telefone será adicionado aos dados de contato - `email` string — Endereço de e-mail. Ao criar um lead de entrada, o endereço de e-mail será adicionado aos dados de contato - `message` object — Um array contendo os componentes da mensagem. - `type` 'text' | 'contact' | 'file' | 'video' | 'picture' | 'voice' | 'audio' | 'sticker' | 'location', required — Tipo de mensagem, um dos seguintes: `text`, `contact`, `file`, `video`, `picture`, `voice`, `audio`, `sticker`, `location` - `text` string — O campo é obrigatório para o tipo `text` e pode estar vazio para outros tipos. - `media` string — URL do `file`, `video`, `picture`, `voice`, `audio` ou `sticker`. O link deve estar disponível para download. Campo opcional caso o arquivo não seja alterado ao editar a mensagem. - `file_size` integer — Opcional. O tamanho do arquivo do campo “media” - `file_name` string — Opcional. Nome do arquivo do campo `media`. Ignorado para o tipo `voice`. Campo opcional caso o arquivo não seja alterado ao editar a mensagem. - `contact` object — Campos obrigatórios para mensagens do tipo contato (informações de contato) - `name` string — Nome do contato. - `phone` string — Telefone do contato. - `location` object — Campos obrigatórios para mensagens do tipo `location` (geoposição) - `lon` number, float — Longitude - `lat` number, float — Latitude - `post` object — Campo opcional. Deve ser informado para comentários - `id` string, required — ID exclusivo do post no lado da integração - `url` string, required — Link para o post na fonte - `preview_url` string — Link para visualizar se os links TTL são limitados - `preview_permalink` string — Link para visualizar se o link é permanente - `username` string — O usuário que publicou o post - `caption` string — Descrição do post - `delivery_status` object — Opcional. Objeto de status de entrega da mensagem, pode ser passado tanto para os tipos `edit_message` quanto `new_message` - `status_code` -1 | 0 | 1 | 2 — Status da entrega. Os status disponíveis estão descritos aqui: https://pt-developers.kommo.com/reference/atualizar-status-de-entrega-da-mensagem - `error_сode` integer — Tipo de erro. Os tipos de erro disponíveis estão descritos aqui: https://pt-developers.kommo.com/reference/atualizar-status-de-entrega-da-mensagem - `error` string — Texto de erro que será exibido ao usuário - `shared_post` object — Opcional. Publicação compartilhada pelo usuário - `url` string — Link para a publicação - `preview_link` string — Opcional. Link temporário para a imagem de pré-visualização. Utilizado quando o link de pré-visualização é temporário e é necessário baixar a imagem no Kommo - `preview_permalink` string — Opcional. Link permanente para a imagem de pré-visualização. Utilizado quando o link de pré-visualização é permanente e não é necessário carregar a imagem para o Kommo - `type` 'post' — Tipo de postagem. Atualmente, apenas o valor `post` é suportado - `site_name` string — Opcional. Legenda da publicação - `sticker_id` string — Opcional. Um identificador comum para o adesivo enviado em todas as contas - `callback_data` string — Opcional. Deve ser passado para as mensagens da lista do WhatsApp para que o bot seja iniciado corretamente - `silent` boolean — Define se a mensagem aciona uma notificação na conta da Kommo. - `reply_to` object — O objeto da mensagem incorporada. A mensagem de uma citação com resposta só pode pertencer ao mesmo chat da mensagem enviada. - `id` string — O ID da mensagem citada na API de Chats. Se passado, os demais campos não precisam ser preenchidos, pois serão determinados automaticamente. Caso o ID seja passado, a rolagem para a mensagem também funcionará se o chat estiver no mesmo cartão. - `msgid` string — O ID da mensagem citada no lado da integração. Se passado, os demais campos não precisam ser preenchidos, pois serão determinados automaticamente. Caso o ID seja passado, a rolagem para a mensagem também funcionará se o chat estiver no mesmo cartão. - `type` string — Obrigatório se nenhum ID for passado. O tipo de mensagem pode ser um dos seguintes: texto, contato, arquivo, vídeo, imagem, áudio, voz, adesivo, localização. - `text` string — Obrigatório para o tipo “texto” se nenhum ID for passado. Para outros tipos de mensagem, pode estar vazio. - `file_name` string — Opcional. Nome do arquivo. - `file_size` string — Opcional. Tamanho do arquivo em bytes. - `media_duration` integer — Opcional. Duração para mensagens de vídeo/áudio/voz. - `location` object — Obrigatório para mensagens do tipo localização se nenhum ID for passado. - `lon` number, float — Longitude. - `lat` number, float — Latitude. - `sender` object — Obrigatório se não for fornecida identificação, remetente da mensagem (versão resumida) - `id` string — ID do remetente no lado da integração, se passado, os demais campos não precisam ser preenchidos, pois serão determinados automaticamente. - `ref_id` string — ID do remetente na API de Chats, se passado, os demais campos não precisam ser preenchidos, pois serão determinados automaticamente. - `name` string — Obrigatório se nenhum ID for passado. Nome do remetente. - `forwards` object — Opcional. O objeto da cotação encaminhada - `messages` object[] — Obrigatório. Um array de objetos de mensagem incorporados. Atualmente, só é possível encaminhar uma mensagem. As mensagens de uma cotação encaminhada podem pertencer a qualquer chat externo dentro da integração - `id` string — O ID da mensagem citada na API de Chats. Se fornecido, os demais campos não precisam ser preenchidos, pois serão determinados automaticamente. Caso o ID seja fornecido, a rolagem até a mensagem também funcionará se o chat estiver no mesmo cartão. - `msgid` string — O ID da mensagem citada no lado da integração. Se fornecido, os campos restantes não precisam ser preenchidos, pois serão determinados automaticamente. Caso o ID seja fornecido, a rolagem até a mensagem também funcionará se o chat estiver no mesmo cartão. - `type` 'text' | 'contact' | 'file' | 'video' | 'image' | 'voice' | 'audio' | 'sticker' | 'location' — Obrigatório caso nenhum ID de mensagem seja fornecido. O tipo de mensagem pode ser um dos seguintes: `text`, `contact`, `file`, `video`, `image`, `voice`, `audio`, `sticker`, `location` - `text` string — Obrigatório para o tipo `text` se nenhum ID for fornecido. Para outros tipos de mensagem, este campo pode estar vazio. - `file_name` string — Opcional. Nome do arquivo do campo `media`. Ignorado para o tipo `voice` - `file_size` integer — Opcional. O tamanho do arquivo do campo `media` - `media_duration` string — Opcional. Duração das mensagens de `video`/`audio`/`voice` - `location` object — Obrigatório para mensagens de localização (`location`) se um identificador não for fornecido - `lon` string — Longtitude - `lat` string — Latitude - `contact` object — Obrigatório para mensagens de contato se o ID não for fornecido - `name` string — Obrigatório. Nome do contato - `phone` string — Obrigatório. Número de telefone para contato - `sender` object — Obrigatório se não for fornecida identificação, remetente da mensagem (versão resumida) - `id` string — ID do remetente no lado da integração. Se aprovado, os campos restantes são opcionais e serão definidos automaticamente - `ref_id` string — ID do remetente no lado da API de chats. Se aprovado, os campos restantes são opcionais e serão definidos automaticamente - `name` string — Obrigatório se nenhum ID for passado, nome do remetente - `timestamp` integer — Obrigatório se nenhum ID for fornecido, hora da mensagem, Unix timestamp - `msec_timestamp` integer — Obrigatório se nenhum ID for fornecido, tempo da mensagem em milissegundos - `conversation_ref_id` string — Opcional. ID do chat no lado da API de chats. O chat deve pertencer à integração - `conversation_id` string — Opcional. ID do chat no lado da integração ## Response `200` 200 - object - `new_message` object - `msgid` string - `ref_id` string ## Other responses - `400` — 400 - `403` — 403 --- [API](https://skmtc.net/kommo/apis/referencias-de-api-da-kommo.md) · [All operations](https://skmtc.net/kommo/apis/referencias-de-api-da-kommo/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kommo/referencias-de-api-da-kommo/versions/98fdf05c2f5b/schema)