Todos os produtos
Search

Este produto

    Chat App Message Service:SendChatappMessage

    Central de documentação

    Chat App Message Service:SendChatappMessage

    Última atualização: Aug 27, 2026

    Envia uma mensagem do Chat App Message Service.

    Descrição da operação

    Limite de QPS

    O limite de QPS por usuário único para esta operação é de 250 chamadas por segundo. Se esse limite for excedido, as chamadas de API serão limitadas, o que pode afetar seus negócios. Chame esta operação adequadamente.

    Alterações de status

    Você pode monitorar o status de entrega da mensagem por meio de MNS ou HTTP. Para mais informações, consulte Mensagens de recibo.

    Experimente agora

    Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

    Testar

    Autorização RAM

    A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

    • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

    • API: A API que você pode chamar para executar a ação.

    • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

    • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

      • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

      • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

    • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

    • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

    Ação

    Nível de acesso

    Tipo de recurso

    Chave de condição

    Ação dependente

    cams:SendChatappMessage

    create

    *Todos os recursos.

    *

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    ChannelType

    string

    Sim

    O tipo de canal. Valores válidos:

    • whatsapp

    • messenger

    • instagram

    • telegram

    • line

    • telegram

    • viber

    whatsapp
    Type

    string

    Sim

    O tipo de mensagem. Valores válidos:

    • template: um modelo de mensagem que foi aprovado no console. Este tipo de mensagem pode ser enviado a qualquer momento.

    • message: uma mensagem em qualquer formato. Este tipo de mensagem só pode ser enviado dentro de 24 horas após o recebimento da última mensagem do usuário.

    Importante Quando Type estiver definido como template, você deve especificar TemplateCode. Quando Type estiver definido como message, você deve especificar MessageType.

    message
    MessageType

    string

    Não

    O tipo detalhado de mensagem quando Type está definido como message. Valores válidos:

    WHATSAPP

    • text: mensagem de texto.

    • image: mensagem de imagem.

    • video: mensagem de vídeo.

    • audio: mensagem de áudio.

    • document: mensagem de documento.

    • interactive: mensagem interativa.

    • location: mensagem de localização.

    • contacts: mensagem de contatos.

    • reaction: mensagem de reação.

    • sticker: mensagem de figurinha.

    • typing_indicator: mensagem de indicador de digitação.

    • pin: mensagem de fixar ou desafixar (apenas mensagens de grupo).

    • carousel: mensagem de carrossel.

    VIBER

    • text: mensagem de texto.

    • image: mensagem de imagem.

    • text_image_button: mensagem de texto + imagem + botão.

    • text_button: mensagem de texto + botão.

    • document: mensagem de documento.

    • video: mensagem de vídeo.

    • text_video: mensagem de texto + vídeo.

    • text_video_button: mensagem de texto + vídeo + botão.

    • text_image: mensagem de texto + imagem.

    MESSENGER / INSTAGRAM

    • text: mensagem de texto.

    • image: mensagem de imagem.

    • video: mensagem de vídeo.

    • document: mensagem de documento.

    • audio: mensagem de áudio.

    • interactive: mensagem interativa.

    • couponTemplate: mensagem de modelo de cupom.

    • regularTemplate: mensagem de modelo padrão.

    • quickReply: mensagem de resposta rápida.

    • buttonTemplate: mensagem de modelo de botão.

    TELEGRAM

    • text: mensagem de texto.

    • image: mensagem de imagem.

    • video: mensagem de vídeo.

    • audio: mensagem de áudio.

    • document: mensagem de documento.

    • location: mensagem de localização.

    • gif: mensagem de GIF animado.

    • sticker: mensagem de figurinha.

    • interactive: mensagem personalizada de passagem direta do Telegram.

    LINE

    • text: mensagem de texto.

    • image: mensagem de imagem.

    • video: mensagem de vídeo.

    • audio: mensagem de áudio.

    • buttons: mensagem de botão.

    • confirm: mensagem de confirmação.

    • carousel: mensagem de carrossel.

    • imageCarousel: mensagem de carrossel de imagens.

    • quickReply: mensagem de resposta rápida.

    • sticker: mensagem de figurinha.

    • location: mensagem de localização.

    • textV2: mensagem de texto (V2).

    • coupon: mensagem de cupom.

    • imagemap: mensagem de imagemap.

    • flex: mensagem flex.

    • interactive: mensagem personalizada de passagem direta do LINE.

    Nota

    Para mais informações, consulte os tipos de mensagem suportados pelo LINE

    text
    TemplateCode

    string

    Não

    O código do modelo. Você pode visualizar o código do modelo na página Gerenciamento de Canais > Gerenciamento > Design de Modelos.

    1119***************

    Language

    string

    Não

    O idioma. Para obter uma lista de códigos de idioma, consulte Códigos de idioma.

    en
    From

    string

    Sim

    O número do remetente.

    • Quando ChannelType é whatsapp, este é o número de telefone registrado e vinculado ao WhatsApp. Você pode visualizá-lo na página Gerenciamento de Canais > Gerenciamento > Gerenciamento de WABA > Gerenciamento de Números.

    • Quando ChannelType é messenger, este é o ID da Página. Você pode visualizá-lo na página Gerenciamento de Canais > Gerenciamento > Página Pública.

    • Quando ChannelType é instagram, este é o ID da conta profissional do Instagram (Account ID). Você pode visualizá-lo na página Gerenciamento de Canais > Gerenciamento > Conta Profissional.

    • Quando ChannelType é viber, este é o ID de Serviço do Viber. Você pode visualizá-lo na página Gerenciamento de Canais > Gerenciamento > Gerenciamento de ID de Serviço.

    • Quando ChannelType é telegram, este é o ID do bot do Telegram. Você pode visualizá-lo na página Gerenciamento de Canais > Gerenciamento > Gerenciamento de Bots.

    • Quando ChannelType é line, este é o ID do Canal LINE. Você pode visualizá-lo na página Gerenciamento de Canais > Gerenciamento > Conta Oficial LINE.

    861387777****
    To

    string

    Sim

    O número do destinatário.

    • Quando ChannelType é whatsapp, este é o número de telefone ou BSUID do destinatário da mensagem.

    • Quando ChannelType é messenger, este é o Page-Scoped User ID gerado quando o usuário interage com a página do Facebook.

    • Quando ChannelType é instagram, este é o Instagram User ID gerado quando o usuário interage com a conta comercial ou de criador do Instagram.

    • Quando ChannelType é viber, este é o número de telefone do destinatário da mensagem.

    • Quando ChannelType é telegram, este é o chatId do Telegram.

    • Quando ChannelType é line, este é o LINE User ID.

    861388988****
    TemplateParams

    object

    Não

    A coleção de parâmetros do modelo.

    string

    Não

    O parâmetro do modelo. Está no formato chave-valor, onde Key é o nome do parâmetro e Value é o valor do parâmetro.

    { "param1": "value1", "param2": "value2" }
    Content

    string

    Não

    O conteúdo da mensagem.

    Observações sobre mensagens do WhatsApp:

    • Quando messageType é text, o campo text é obrigatório e o campo Caption não deve ser especificado.

    • Quando messageType é image, o campo Link é obrigatório.

    • Quando messageType é video, o campo Link é obrigatório.

    • Quando messageType é audio, o campo Link é obrigatório e o campo Caption é inválido.

    • Quando messageType é document, os campos Link e FileName são obrigatórios e o campo Caption é inválido.

    • Quando messageType é interactive, os campos type e action são obrigatórios.

    • Quando messageType é contacts, o campo name é obrigatório.

    • Quando messageType é location, os campos longitude e latitude são obrigatórios.

    • Quando messageType é sticker, o campo Link é obrigatório e os campos Caption e FileName são inválidos.

    • Quando messageType é reaction, os campos messageId e emoji são obrigatórios.

    Observações sobre mensagens do Messenger:

    • Quando messageType é text, o campo text é obrigatório.

    • Quando messageType é image, video, audio ou document, o campo link é obrigatório.

    Observações sobre mensagens do Instagram:

    • Quando messageType é text, o campo text é obrigatório.

    • Quando messageType é image, video ou audio, o campo link é obrigatório.

    Observações sobre mensagens do Viber:

    • Quando messageType é text, o campo text é obrigatório.

    • Quando messageType é image, o campo link é obrigatório.

    • Quando messageType é video, os campos link, thumbnail, fileSize e duration são obrigatórios.

    • Quando messageType é document, os campos link, fileName e fileType são obrigatórios.

    • Quando messageType é text_button, os campos text, caption e action são obrigatórios.

    • Quando messageType é text_image_button, os campos text, link, caption e action são obrigatórios.

    • Quando messageType é text_video, os campos text, link, thumbnail, fileSize e duration são obrigatórios.

    • Quando messageType é text_video_button, os campos text, link, thumbnail, fileSize, duration e caption são obrigatórios, e o campo action não deve estar vazio.

    Observações sobre mensagens do Telegram:

    • Quando messageType é text, o campo text é obrigatório.

    • Quando messageType é image, video, audio, gif ou sticker, o campo link é obrigatório.

    • Quando messageType é location, os campos latitude e longitude são obrigatórios.

    • Quando messageType é interactive, o campo type é obrigatório. Você pode enviar vários tipos de mensagem do Telegram. Exemplo: {"type": "sendPhoto", "sendPhoto": {"photo":"http://img.png","caption":"21"}}. Isso pode ser usado para enviar uma mensagem do tipo Photo. Para mais informações sobre tipos de mensagem, consulte Corpo da mensagem do Telegram.

    Observações sobre mensagens do LINE:

    • Quando messageType é text ou textV2, o campo text é obrigatório.

    • Quando messageType é image ou video, os campos link e previewImageUrl são obrigatórios.

    • Quando messageType é audio, os campos link e duration são obrigatórios.

    • Quando messageType é buttons ou confirm, os campos text e actions são obrigatórios.

    • Quando messageType é carousel ou imageCarousel, o campo columns é obrigatório.

    • Quando messageType é quickReply, os campos text e items são obrigatórios.

    • Quando messageType é sticker, os campos packageId e stickerId são obrigatórios.

    • Quando messageType é location, os campos title, address, latitude e longitude são obrigatórios.

    • Quando messageType é coupon, o campo couponId é obrigatório.

    • Quando messageType é imagemap, os campos baseUrl e altText são obrigatórios.

    • Quando messageType é flex, os campos contents e altText são obrigatórios.

    • Quando messageType é interactive, você pode passar formatos de mensagem suportados pelo LINE:

      • Para enviar uma única mensagem, o campo type é obrigatório, e outros campos seguem o formato de corpo de mensagem do LINE. Exemplo: {"type": "text", "text": "test"}

      • Para enviar múltiplas mensagens (o LINE suporta até 5 mensagens por vez), o campo messages é obrigatório. Exemplo: {"messages": [{"type": "text", "text": "test"}, {"type": "image", "originalContentUrl": "http://img.png", "previewImageUrl": "http://img2.png"}]}

      • Para mais informações, consulte Corpo da mensagem do LINE.

    { "text": "hello,whatsapp", "link": "https://*******", "caption": "****", "fileName": "****" }
    Payload

    array

    Não

    A coleção de mensagens de acionamento de botão.

    Nota

    Este parâmetro é válido apenas para WHATSAPP.

    payloadtext1,payloadtext2,payloadtext3

    string

    Não

    A mensagem de acionamento de um botão no modelo.

    payloadtext
    CustWabaId deprecated

    string

    Não

    O ID do WABA do cliente ISV.

    Nota

    Este parâmetro está obsoleto. Use CustSpaceId em seu lugar.

    cams-8c8*********
    FallBackId

    string

    Não

    O ID da política de fallback. Este parâmetro destina-se ao site internacional da China. Usuários do site da China podem ignorar este parâmetro. Você pode visualizar o ID da política na página Estratégia de Fallback.

    S0****
    FallBackContent

    string

    Não

    O conteúdo de fallback personalizado. Este parâmetro destina-se ao site internacional da China. Usuários do site da China podem ignorar este parâmetro.

    Fallback SMS
    IsvCode deprecated

    string

    Não

    O código de verificação do ISV.

    Nota

    Este parâmetro está obsoleto. Você pode ignorá-lo.

    123123******
    CustSpaceId

    string

    Não

    O SpaceId do subcliente ISV ou o ID da instância de um cliente direto. Você pode visualizá-lo na página Gerenciamento de Canais.

    cams-8c8*********
    ContextMessageId

    string

    Não

    O ID da mensagem a ser respondida. Este é o ID de uma mensagem enviada ou recebida anteriormente.

    61851ccb2f1365b16aee****
    TrackingData

    string

    Não

    Os dados de rastreamento personalizados passados para tipos de mensagem Viber. Este parâmetro destina-se ao site internacional da China. Usuários do site da China podem ignorar este parâmetro.

    Nota

    Válido apenas para VIBER.

    Tracking Data
    Label

    string

    Não

    O tipo de mensagem Viber. Este parâmetro destina-se ao site internacional da China. Usuários do site da China podem ignorar este parâmetro. Valores válidos:

    • pormotion: mensagens de marketing ou promocionais.

    • transaction: mensagens de notificação.

    Nota

    Válido apenas para VIBER.

    promotion
    Ttl

    integer

    Não

    O período de tempo limite de envio da mensagem Viber. Este parâmetro destina-se ao site internacional da China. Usuários do site da China podem ignorar este parâmetro. Unidade: segundos. Valores válidos: 30 a 1209600.

    Nota

    Válido apenas para VIBER.

    50
    Tag

    string

    Não

    As informações de tag. Informações de tag personalizadas ao enviar mensagens Viber.

    Nota

    Válido apenas para VIBER.

    tag
    TaskId

    string

    Não

    O ID da tarefa personalizada.

    10000****
    FallBackDuration

    integer

    Não

    O tempo de acionamento do fallback. Este parâmetro destina-se ao site internacional da China. Usuários do site da China podem ignorar este parâmetro. Se a mensagem não retornar um recibo de entrega dentro do tempo especificado, o fallback será acionado. Se este parâmetro não for especificado, o fallback será acionado apenas quando a mensagem falhar ao ser enviada ou quando um relatório de status de falha for recebido. Unidade: segundos. Valor mínimo: 60. Valor máximo: 43200.

    120
    ProductAction

    object

    Não

    As informações do produto. Este parâmetro é válido apenas para tipos de canal WhatsApp. Refere-se às informações do produto que você carregou no Meta.

    Nota

    Válido apenas para WHATSAPP.

    ThumbnailProductRetailerId

    string

    Não

    O ID do catálogo de produtos. Você pode obtê-lo chamando a operação ListProductCatalog.

    skkks99****
    Sections

    array<object>

    Não

    A lista de categorias de produtos (até 10 categorias e 30 produtos).

    array<object>

    Não

    A categoria do produto.

    Title

    string

    Não

    O nome da categoria. Você pode visualizá-lo na página Gerenciamento de Canais > Gerenciamento > Gerenciamento de Catálogos > Gerenciamento de Produtos, ou obtê-lo chamando a operação ListProduct.

    abcd
    ProductItems

    array<object>

    Não

    A lista de itens de produto.

    object

    Não

    As informações do item de produto.

    ProductRetailerId

    string

    Não

    O ID do produto. Você pode visualizá-lo na página Gerenciamento de Canais > Gerenciamento > Gerenciamento de Catálogos > Gerenciamento de Produtos, ou obtê-lo chamando a operação ListProduct.

    ksi3****
    FallBackRule

    string

    Não

    A regra de fallback. Este parâmetro destina-se ao site internacional da China. Usuários do site da China podem ignorar este parâmetro. Valores válidos:

    • undelivered: o fallback é acionado quando a mensagem não pode ser entregue ao endpoint (a validação de modelo e parâmetro deve passar durante o estado de envio; modelos ou números bloqueados não são validados). Esta regra é usada por padrão quando o valor do parâmetro está vazio.

    • sentFailed: o fallback também é acionado quando a validação do modelo ou da variável do modelo falha. Apenas os parâmetros channelType, type, messageType, to e from (verificação de existência) são estritamente validados.

    undelivered
    FlowAction

    object

    Não

    O objeto de mensagem Flow.

    Nota

    Válido apenas para WHATSAPP.

    FlowActionData

    object

    Não

    A coleção de parâmetros padrão do Flow.

    any

    Não

    O parâmetro padrão do Flow. Está no formato chave-valor, onde Key é o nome do parâmetro e Value é o valor do parâmetro.

    { "name": "name" }
    FlowToken

    string

    Não

    As informações personalizadas do token Flow.

    kde****
    TemplateName

    string

    Não

    O nome do modelo. Você pode visualizar o nome do modelo na página Gerenciamento de Canais > Gerenciamento > Design de Modelos.

    test_name
    RecipientType

    string

    Não

    O tipo de destinatário. Valores válidos:

    • individual: um indivíduo.

    • group: um grupo.

    • userId: WhatsApp BSUID. Válido apenas para WHATSAPP.

    individual
    MessageCampaignId

    string

    Não

    O ID da mensagem da campanha.

    Nota

    Este parâmetro é um parâmetro de teste que não está totalmente disponível. Ignore este parâmetro.

    123123********

    AdAccountId

    string

    Não

    O ID da conta de anúncios do Meta.

    Nota

    Este parâmetro é um parâmetro de teste que não está totalmente disponível. Ignore este parâmetro.

    123123********
    TokenType

    string

    Não

    O tipo de token.

    Nota

    Este parâmetro é um parâmetro de teste que não está totalmente disponível. Ignore este parâmetro.

    bearer
    Category

    string

    Não

    O tipo de mensagem (para envio direto do WhatsApp).

    Aviso Não especifique este parâmetro se você não for um cliente convidado pela Meta. Caso contrário, o envio da mensagem falhará.

    UTILITY

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Os parâmetros de resposta.

    AccessDeniedDetail

    string

    Os detalhes de acesso negado.

    None
    RequestId

    string

    O ID da solicitação.

    90E63D28-E31D-1EB2-8939-A94866******
    Message

    string

    A mensagem de erro.

    User not authorized to operate on the specified resource
    Code

    string

    O código de resposta.

    • OK indica que a solicitação foi bem-sucedida.

    • Para outros códigos de erro, consulte Códigos de erro.

    OK
    MessageId

    string

    O ID da mensagem.

    61851ccb2f1365b16aee****

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "AccessDeniedDetail": "None.",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866******",
  "Message": "User not authorized to operate on the specified resource.",
  "Code": "OK",
  "MessageId": "61851ccb2f1365b16aee****"
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    400 Product.Unsubscript You have not subscribed to the specified product.
    400 Ram.PermissionDeny You are not authorized to perform the operation.
    400 System.LimitControl The system is under flow control.
    400 Unknown.ResourceOwnerId The resource does not belong to the current user.

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.