CreateChatappTemplate - Chat App Message Service: Central de Documentação do Alibaba Cloud

Cria um modelo de mensagem. Após a aprovação do modelo, você pode usá-lo para enviar mensagens.

Descrição da operação

Limite de QPS

O limite de QPS por usuário único para esta operação é de 50 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 conforme necessário.

Alterações de status

Você pode monitorar o status do modelo e as alterações de qualidade por meio do 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:CreateChatappTemplate

create

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Category	string	Sim	Categoria do modelo do WhatsApp. Valores válidos: UTILITY: relacionado a transações. MARKETING: marketing. AUTHENTICATION: verificação de identidade. Categoria do modelo do Viber. Valores válidos: UTILITY: relacionado a transações. MARKETING: marketing. AUTHENTICATION: verificação de identidade.	UTILITY
Components	array<object>	Sim	A lista de componentes do modelo de mensagem. Nota Quando Category=AUTHENTICATION, Components não pode conter nós com Type=HEADER. Quando Type=BODY ou FOOTER, o conteúdo de Text deve estar vazio.
	array<object>	Não	A lista de componentes.
HasExpiration	boolean	Não	Especifica se o código de cupom possui um tempo de expiração. Este parâmetro é usado quando type = LIMITED_TIME_OFFER.	true
ThumbUrl	string	Não	A miniatura para mensagens de vídeo do Viber.	https://cdn.multiplymall.mobiapp.cloud/yunmall/B-LM-LMALL202207130001/20220730/d712a057-a6af-4513-bbe6-7ee57ea60983.png?x-oss-process=image/resize,w_100
FileName	string	Não	O nome do arquivo.	Vídeo de entrega expressa
Text	string	Não	O texto da mensagem a ser enviada. Nota Para o tipo WHATSAPP, este valor de propriedade está vazio quando Category=AUTHENTICATION.	olá whatsapp
Duration	integer	Não	A duração (em segundos) das mensagens de vídeo do Viber. Valores válidos: 0 a 600.	120
Url	string	Não	O caminho do recurso de mídia. Nota Para o tipo Viber, o tamanho de imagem recomendado é 800 px × 800 px.	https://image.developer.aliyundoc.com
Caption	string	Não	A descrição do arquivo.	Este é um vídeo
AddSecretRecommendation	boolean	Não	Válido para modelos do WhatsApp quando Category é AUTHENTICATION e Component Type é Body. Exibe um aviso acima do Body aconselhando a não compartilhar o código de verificação com outras pessoas.	true
Type	string	Sim	O tipo de componente. Valores válidos: BODY HEADER FOOTER BUTTONS CAROUSEL LIMITED_TIME_OFFER Nota Para modelos do WhatsApp, o componente BODY não pode exceder 1024 caracteres. Os componentes HEADER e FOOTER não podem exceder 60 caracteres. Para modelos do Viber, os tipos FOOTER, CAROUSEL e LIMITED_TIME_OFFER são inválidos. Para modelos do Viber, imagens, vídeos e arquivos são colocados no HEADER (o dispositivo exibe imagens abaixo do texto). O texto é colocado no BODY.	BODY
Format	string	Não	O tipo de recurso de mídia. TEXT: texto IMAGE: imagem DOCUMENT: documento VIDEO: vídeo	TEXT
CodeExpirationMinutes	integer	Não	O período de validade (em minutos) do código de verificação para modelos AUTHENTICATION do WhatsApp. Válido apenas para mensagens do WhatsApp quando Category é AUTHENTICATION e Component Type é Footer (exibido na posição do Footer).	5
FileType	string	Não	O tipo de arquivo para mensagens de arquivo do Viber.	docx
Buttons	array<object>	Não	A lista de botões. Aplicável apenas a componentes BUTTONS. Nota Regras de quantidade de botões do WhatsApp: Para modelos do WhatsApp com Category MARKETING/UTILITY, são permitidos no máximo 10 botões. Apenas 1 botão PHONE_NUMBER é permitido. São permitidos no máximo 2 botões URL. Botões QUICK_REPLY não podem aparecer em ordem mista com botões PHONE_NUMBER/URL. Nota Regras de quantidade de botões do Viber: Apenas o tipo URL é suportado, e apenas um botão é permitido. Quando o HEADER contém um VIDEO, o tipo de botão é URL, mas você não pode definir um endereço URL.
	array<object>	Não	A definição do botão.
AutofillText	string	Não	Obrigatório para modelos do WhatsApp quando Category é AUTHENTICATION e Button Type é ONE_TAP/ZERO_TAP. O texto do botão para a operação de Preenchimento Automático do WhatsApp.	Preenchimento automático
PackageName `deprecated`	string	Não	Use as propriedades em SupportedApps em vez disso.	com.demo
Text	string	Não	O nome de exibição do botão.	Me ligue
Url	string	Não	A URL a ser visitada quando o botão de link for clicado.	https://example.com
FlowId	string	Não	O ID do fluxo.	479884093605****
Type	string	Sim	O tipo de botão. PHONE_NUMBER: botão de discagem telefônica URL: botão web QUICK_REPLY: botão de resposta rápida COPY_CODE: copiar código de verificação ou código de cupom ONE_TAP: botão de preenchimento automático para modelos AUTHENTICATION ZERO_TAP: botão de preenchimento automático para modelos AUTHENTICATION MPM: catálogo de múltiplos produtos CATALOG: catálogo FLOW: abrir fluxo do WhatsApp Nota Para modelos do WhatsApp com Category AUTHENTICATION, apenas um botão é permitido, e o tipo só pode ser COPY_CODE/ONE_TAP. Quando COPY_CODE é selecionado, Text é obrigatório. Quando ONE_TAP é selecionado, Text (exibido quando o aplicativo alvo não está instalado no dispositivo, representando o nome do botão de copiar código de verificação), SignatureHash, PackageName e AutofillText são obrigatórios. Modelos do Viber permitem apenas um botão, e ele deve ser do tipo URL.	PHONE_NUMBER
CouponCode	string	Não	O valor do código de cupom. Apenas letras e números são suportados. Você pode passar uma variável como $(couponCode) e fornecer o código de cupom real durante o envio.	120293
IsOptOut	boolean	Não	Válido para modelos do WhatsApp quando Category é Marketing e Button type é QUICK_REPLY. Indica que o botão é um botão de cancelamento de marketing. Se o cliente clicar neste botão e o controle de envio estiver configurado no ChatApp, mensagens de Marketing subsequentes não serão enviadas ao cliente.	false
FlowAction	string	Não	O tipo de evento de dados do Fluxo. Valores válidos: DATA_EXCHANGE: troca de dados. NAVIGATE: navegação.	NAVIGATE
SignatureHash `deprecated`	string	Não	Use as propriedades em SupportedApps em vez disso.	wi299382
NavigateScreen	string	Não	A tela de navegação. Obrigatório quando FlowAction=NAVIGATE.	DETAILS
PhoneNumber	string	Não	O número de telefone. Válido apenas quando o tipo de botão é PHONE_NUMBER.	+861368897****
SupportedApps	array<object>	Não	A lista de aplicativos suportados.
	object	Não
SignatureHash	string	Não	Obrigatório para modelos do WhatsApp quando Category é AUTHENTICATION e Button Type é ONE_TAP/ZERO_TAP. O valor de hash de assinatura para o aplicativo invocado pelo WhatsApp.	ieid83kdiek
PackageName	string	Não	Obrigatório para modelos do WhatsApp quando Category é AUTHENTICATION e Button Type é ONE_TAP/ZERO_TAP. O nome do pacote do aplicativo invocado pelo WhatsApp.	com.kuaidian.waimaistaff
UrlType	string	Não	O tipo de URL. static: estático dynamic: dinâmico	static
Cards	array<object>	Não	A lista de cartões do modelo de Carrossel.
	array<object>	Não	O objeto de cartão do modelo de Carrossel.
CardComponents	array<object>	Não	A lista de componentes no cartão do Carrossel.
	array<object>	Não	O objeto de componente no modelo de Carrossel.
Type	string	Sim	O tipo de componente. Valores válidos: BODY HEADER BUTTONS	BODY
Format	string	Não	O tipo de recurso de mídia. Válido quando Type = HEADER. IMAGE: imagem VIDEO: vídeo	IMAGE
Text	string	Não	O conteúdo do BODY no cartão do Carrossel.	Quem é a equipe muito poderosa
Buttons	array<object>	Não	A lista de botões. Aplicável apenas a componentes BUTTONS. Cada cartão do Carrossel pode ter no máximo dois botões.
	object	Não	O objeto de botão.
Type	string	Sim	O tipo de botão. PHONE_NUMBER: botão de discagem telefônica URL: botão web QUICK_REPLY: botão de resposta rápida	PHONE_NUMBER
PhoneNumber	string	Não	O número de telefone.	+86138007****
Text	string	Não	O texto do botão.	Me ligue
UrlType	string	Não	O tipo de URL. static: Estático. dynamic: Dinâmico.	static
Url	string	Não	A URL acessada quando o botão é clicado.	https://alibaba.com/xx
Url	string	Não	O caminho do material.	https://alibaba.com/img.png
Name	string	Sim	O nome do modelo.	hello_whatsapp
Language	string	Sim	O idioma do modelo. Para obter detalhes sobre os códigos de idioma, consulte Códigos de idioma.	en
Example	object	Não	O exemplo para criação do modelo.	hello_whatsapp
	string	Não	O exemplo para criação do modelo.	StringConcat('a', 'b', 'c')
TemplateType	string	Sim	O tipo de modelo. Valores válidos: WHATSAPP VIBER	WHATSAPP
CustWabaId `deprecated`	string	Não	O WabaId do cliente ISV. Nota Parâmetro descontinuado. Use CustSpaceId em vez disso.	65921621816****
IsvCode `deprecated`	string	Não	O código de verificação ISV, usado para verificar se a subconta está autorizada pelo ISV.	skdi3kksloslikdkkdk
CustSpaceId	string	Não	O SpaceId da subconta do cliente ISV ou o ID da instância do cliente direto.	293483938849493
AllowCategoryChange `deprecated`	boolean	Não	Especifica se deve permitir que o Facebook altere automaticamente a categoria do modelo (para melhorar a taxa de aprovação do modelo). Esta propriedade é válida apenas quando TemplateType está definido como WHATSAPP. Importante Esta propriedade foi descontinuada. O WhatsApp não oferece mais suporte a esta propriedade.	true
MessageSendTtlSeconds	integer	Não	O tempo de vida (TTL) para mensagens de modelo no WhatsApp. AUTHENTICATION: valores válidos variam de 30 a 900. UTILITY: valores válidos variam de 30 a 43200.	120
CategoryChangePaused	boolean	Não	Especifica se deve pausar o envio de modelos quando um modelo Utility é alterado para o tipo Marketing. Esta propriedade é válida apenas para modelos do WhatsApp.	false
		Não	productSetId.	9928**

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	90E63D28-E31D-1EB2-8939-A94866411B2D
Code	string	O código de status da solicitação. OK indica que a solicitação foi bem-sucedida. Para outros códigos de erro, consulte Códigos de erro.	OK
Message	string	A mensagem de erro.	User not authorized to operate on the specified resource
Data	object	Os dados retornados.	{"templateCode": "****4b5c79c9432497a075bdfca36bf5"，"templateName": "hello_whatsapp"}
TemplateCode	string	O código do modelo.	SMS_232907****
TemplateName	string	O nome do modelo.	hello_whatsapp
AccessDeniedDetail	string	Os detalhes de acesso negado.	None
Success	boolean		true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2D",
  "Code": "OK",
  "Message": "User not authorized to operate on the specified resource.",
  "Data": {
    "TemplateCode": "SMS_232907****",
    "TemplateName": "hello_whatsapp"
  },
  "AccessDeniedDetail": "None",
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
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.