GetFlow - Chat App Message Service - Centro de documentación de Alibaba Cloud

Obtiene los detalles de un flujo.

Descripción de la operación

Antes de llamar a esta operación, asegúrese de haber creado correctamente un flujo de WhatsApp.
Si no tiene un flujo de WhatsApp creado correctamente, llame a la operación CreateFlow para crear uno.

Límite de QPS

El límite de QPS por usuario para esta operación es de 5 llamadas por segundo. Si se supera este límite, las llamadas a la API se limitarán, lo que puede afectar su negocio. Llame a esta operación según corresponda.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

cams:GetFlow

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
FlowId	string	Sí	El ID del flujo, que corresponde al FlowId devuelto por la operación CreateFlow cuando crea un flujo de WhatsApp.	333993838***
CustSpaceId	string	No	El ID de espacio del subcliente ISV o el ID de instancia del cliente directo. Puede ver el ID de espacio en la página de Gestión de canales.	cams-kei****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
AccessDeniedDetail	string	Los detalles sobre la denegación de acceso.	Ninguna
RequestId	string	El ID de la solicitud.	DAC72B08-3327-33EF-BEDC-8EC3E83A6575
Message	string	El mensaje de error.	Ninguna
Data	object	Los datos devueltos.
Status	string	El estado del flujo. Valores válidos: PUBLISHED: Publicado. DRAFT: Borrador. DEPRECATED: Obsoleto.	DRAFT
FlowId	string	El ID del flujo.	92675332812643****
PreviewUrl	string	La URL temporal de vista previa.	https://pre-url
EndpointUri	string	La URL del endpoint de flujo de WA.	http://abc.com
JSONVersion	string	La información de la versión de JSON.	2.1
Categories	array	La lista de categorías.
	string	La categoría.	SIGN_UP
FlowName	string	El nombre del flujo.	flow_001
DataApiVersion	string	La información de la versión de la API.	3.0
PreviewUrlExpires	integer	La hora de caducidad de la URL de vista previa.	1700617436633
Code	string	El código de error. Para obtener más información, consulte Códigos de error.	OK

Ejemplos

Respuesta exitosa

JSON Formato

{
  "AccessDeniedDetail": "None",
  "RequestId": "DAC72B08-3327-33EF-BEDC-8EC3E83A6575\n",
  "Message": "None",
  "Data": {
    "Status": "DRAFT",
    "FlowId": "92675332812643****",
    "PreviewUrl": "https://pre-url",
    "EndpointUri": "http://abc.com",
    "JSONVersion": "2.1",
    "Categories": [
      "SIGN_UP"
    ],
    "FlowName": "flow_001",
    "DataApiVersion": "3.0",
    "PreviewUrlExpires": 1700617436633
  },
  "Code": "OK"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Product.Unsubscript	You have not subscribed to the specified product.	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.	The system is under flow control.
400	Unknown.ResourceOwnerId	The resource does not belong to the current user.	The resource does not belong to the current user.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.