Comunidade + AcademyAPI

[POST] Envio de textos, áudios e imagens externas

Esse endpoint permite realizar o envio de mensagens com texto, áudio e imagem externas diretamente via API para os diversos canais disponíveis. Com essa nova funcionalidade, você pode:

  • Enviar conteúdo personalizado contendo texto, áudio ou imagem pela API sem depender de canal específico.

🚨Importante: Os parâmetros necessários para a execução da requisição variam de acordo com o channel do chat.

Listas de channels disponíveis:

api instagram whatsapp_business whatsapp widget

  • Se o channel do chat for do whatsapp ou whatsapp_business, é necessário enviar o whatsAppPhoneNumber ou o externalGenerativeChatId do chat.

  • Se for o Instagram precisa do externalRecipientIdou o externalGenerativeChatId existente.

  • Se for o widget o parâmetro externalGenerativeChatId é necessário.

  • Se for API precisa do externalGenerativeChatId ou externalGenerativeChatExternalId

Como funciona?

  • Para enviar textos, você deve enviar o texto que será entregue ao usuário como uma string no parâmetro "message".

  • Para enviar imagem, você deve enviar o URL da imagem que será entregue ao usuário como uma string no parâmetro "imageUrl". (Extensões de imagem aceitas: 'image/png', 'image/jpeg')

  • Para enviar áudio, você deve enviar o URL da áudio que será entregue ao usuário como uma string no parâmetro "audioUrl". (Extensões de áudio aceitas: 'audio/mpeg', 'audio/mp3', 'audio/ogg', 'audio/wav', 'audio/webm')

Requisição

curl --location 'https://core-service.zaia.app/v1.1/api/message-cross-channel/create' \
--header 'Authorization: Bearer <your api key>' \
--header 'Content-Type: application/json' \
--data '{
    "agentId": 1234,
    "message": "Hello!",
    "imageUrl": "https://storage.googleapis.com/msgsndr/I8hThu7JoFs3bxcL60Y2/media/66bd4b47b42c9b3e70971f01.png",
    "audioUrl": "https://storage.googleapis.com/msgsndr/I8hThu7JoFs3bxcL60Y2/media/66bd4b47b42c9b3e70971f01.mp3",
    "whatsAppPhoneNumber": "55119999999",
    "externalGenerativeChatId": 123456,
    "externalGenerativeChatExternalId": "<external_id_gerado_via_api>",
    "externalRecipientId": "<id_do_instagram>",
    "channel": "whatsapp"
}'

Headers (Cabeçalhos)

Chave
Tipo
Exemplo
Obrigatório

Authorization

String

Bearer <sua chave aqui>

✓

Content-type

String

application/json

Respostas:

{
    "chat": {
        "channel": "widget",
        "externalId": null,
        "externalRecipientId": null,
        "extractedData": {
            "data.stripe_id": "0",
            "data.sub_status": "0",
            "data.necessidade_tipo": "0",
            "data.necessidade_categoria": "0",
            "data.solucao": "FALSE",
            "data.query_otimizada": "Enviar imagens",
            "data.last_user_message": "teste@zaia.app",
            "data.agent_id": "0",
            "data.necessidade": "O usuário deseja enviar emails.",
            "data.email": "teste@zaia.app",
            "data.last_stage": "Identificar usuário",
            "action.googleCalendar.email": "teste@zaia.app"
        },
        "id": 2858854,
        "phoneNumber": null
    }
}

AnteriorMensagem entre canaisPróximoAgente

Atualizado