API de plan de push

Última actualización：hace alrededor de 2 años

Las API de este módulo se centran principalmente en las operaciones de creación, modificación y consulta del propio ID del plan de push.

Verificación de llamada

Para más detalles, consulte la descripción del [método de autenticación](/zh_CN/docs/app-push/rest-api/rest-api-overview#Authentication Method) en la visión general de la API REST.

Crear y actualizar plan de push

Esta interfaz se utiliza para crear o actualizar un plan de push. Al proporcionar el plan_id y el plan_description, el sistema realizará una operación de creación o actualización en función de si existe el plan_id.

Dirección de llamada

POST v4/push_plan

              
              POST v4/push_plan

Este bloque de código se muestra en una ventana flotante

Parámetros de la solicitud

Nombre del parámetro	Tipo	Obligatorio	Descripción
plan_id	string	Sí	Identificador único del plan de push Reglas de formato: combinación de letras (distingue entre mayúsculas y minúsculas), números y guiones bajos. Se prohíbe comenzar con un guion bajo. Límite de longitud: máximo de 50 caracteres. Restricción de unicidad: no se puede modificar una vez establecido. Estrategia de actualización: cuando el plan_id ya existe, se actualiza plan_description. Cuando no existe, se crea un nuevo plan.
plan_description	string	Sí	Información descriptiva del plan de push Requisitos de contenido: es necesario incluir información clave del negocio, como el escenario de push, los usuarios objetivo y el contenido del push. Especificación de formato: admite chino, inglés, números y signos de puntuación comunes. Sugerencia de longitud: no más de 128 caracteres.

Ejemplo de solicitud

{ "plan_id": "push_20231001_001", "plan_description": "Push plan for the Double 11 promotion event, covering all users" }

              
              {
  "plan_id": "push_20231001_001",
  "plan_description": "Push plan for the Double 11 promotion event, covering all users"
}

Este bloque de código se muestra en una ventana flotante

Descripción de parámetros de retorno

Respuesta correcta

{ "plan_id": "push_20231001_001" }

              
              {
  "plan_id": "push_20231001_001"
}

Este bloque de código se muestra en una ventana flotante

Respuesta fallida

{ "error": { "code": 27303, "message": "Empty plan id" } }

              
              {
  "error": {
    "code": 27303,
    "message": "Empty plan id"
  }
}

Este bloque de código se muestra en una ventana flotante

Consultar plan de push

Esta interfaz se utiliza para consultar la lista de planes de push paginada y admite el filtrado por origen de envío y la búsqueda difusa de la descripción o del ID del plan.

Dirección de llamada

GET v4/push_plan/list?page_index=x&page_size=xx&send_source=x&search_description=xxx

              
              GET v4/push_plan/list?page_index=x&page_size=xx&send_source=x&search_description=xxx

Este bloque de código se muestra en una ventana flotante

Parámetros de la solicitud

Nombre del parámetro	Tipo	Obligatorio	Descripción
page_index	int	Sí	El número de página para la paginación (el recuento comienza desde `1`)
page_size	int	Sí	El número de entradas de datos por página, con un máximo admitido de `100` entradas
send_source	int	No	Identificador del origen de envío: `0`-API, `1`-Web Console
search_description	string	No	Coincidencia difusa de la descripción del plan o del ID del plan (admite chino, inglés, números y guiones bajos)

Ejemplo de solicitud

GET /v4/push_plan/list?page_index=1&page_size=20&send_source=1&search_description=Double 11

              
              GET /v4/push_plan/list?page_index=1&page_size=20&send_source=1&search_description=Double 11

Este bloque de código se muestra en una ventana flotante

Descripción de parámetros de retorno

Respuesta correcta

{ "push_plan_info": [ { "plan_id": "push_20231111", "plan_description": "Double 11全站Push Plan", "count": 15, "create_time": "2023-11-01T10:00:00Z", "last_used_time": "2023-11-11T20:30:00Z" } ], "total": 1 }

              
              {
  "push_plan_info": [
    {
      "plan_id": "push_20231111",
      "plan_description": "Double 11全站Push Plan",
      "count": 15,
      "create_time": "2023-11-01T10:00:00Z",
      "last_used_time": "2023-11-11T20:30:00Z"
    }
  ],
  "total": 1
}

Este bloque de código se muestra en una ventana flotante

Respuesta fallida

{ "error": { "code": 1003, "message": "Parameter value is invalid" } }

              
              {
  "error": {
    "code": 1003,
    "message": "Parameter value is invalid"
  }
}

Este bloque de código se muestra en una ventana flotante

Consultar Msgid en función del plan de push

Esta interfaz se utiliza para obtener los ID de mensajes asociados del plan de push especificado dentro del último mes y admite la consulta por lotes de los datos de mensajes asociados de varios planes.

Dirección de llamada

GET /v4/status/plan/msg/?plan_ids=xxxxxx,xxxxxx&start_date=yyyy-MM-dd&end_date=yyyy-MM-dd

              
              GET /v4/status/plan/msg/?plan_ids=xxxxxx,xxxxxx&start_date=yyyy-MM-dd&end_date=yyyy-MM-dd

Este bloque de código se muestra en una ventana flotante

Parámetros de la solicitud

Nombre del parámetro	Tipo	Obligatorio	Descripción
plan_ids	string	Sí	Lista de ID de planes de push; para varios ID, separados por comas (ASCII), con un máximo admitido de 1000 ID
start_date	string	Sí	Fecha de inicio (formato: `yyyy-MM-dd`), que debe cumplir: 1. Dentro de los 30 días anteriores a la fecha actual 2. La fecha de fin ≥ la fecha de inicio
end_date	string	Sí	Fecha de fin (formato: `yyyy-MM-dd`), que debe cumplir: 1. El intervalo entre la fecha de inicio y la fecha de fin ≤ 31 días 2. No anterior a la fecha de inicio

Ejemplo de solicitud

GET /v4/status/plan/msg/?plan_ids=push_20231101,push_20231102&start_date=2023-11-01&end_date=2023-11-15

              
              GET /v4/status/plan/msg/?plan_ids=push_20231101,push_20231102&start_date=2023-11-01&end_date=2023-11-15

Este bloque de código se muestra en una ventana flotante

Descripción de parámetros de retorno

Respuesta correcta

{ "push_20231101": { "msg_ids": ["msg_001", "msg_002"] }, "push_20231102": { "msg_ids": ["msg_003"] } }

              
              {
  "push_20231101": {
    "msg_ids": ["msg_001", "msg_002"]
  },
  "push_20231102": {
    "msg_ids": ["msg_003"]
  }
}

Este bloque de código se muestra en una ventana flotante

Respuesta fallida

{ "error": { "code": 21044, "message": "The time interval exceeds one month." } }

              
              {
  "error": {
    "code": 21044,
    "message": "The time interval exceeds one month."
  }
}

Este bloque de código se muestra en una ventana flotante

Eliminar plan de push

Esta API se utiliza para eliminar un plan de push. Al proporcionar el plan_id, el sistema realizará la operación de eliminación en función de si existe el plan_id.

Dirección de llamada

POST v4/push_plan/{plan_id}

              
              POST v4/push_plan/{plan_id}

Este bloque de código se muestra en una ventana flotante

Parámetros de la solicitud

Nombre del parámetro	Tipo	Obligatorio	Descripción
plan_id	string	Sí	Identificador único del plan de push

Ejemplo de solicitud

curl -X DELETE http://127.0.0.1/v4/push_plan/push_20231001_001 -u "appKey:appSecret"

              
              curl -X DELETE http://127.0.0.1/v4/push_plan/push_20231001_001 -u "appKey:appSecret"

Este bloque de código se muestra en una ventana flotante

Descripción de parámetros de respuesta

Respuesta correcta

{ "plan_id": "push_20231001_001" }

              
              {
  "plan_id": "push_20231001_001"
}

Este bloque de código se muestra en una ventana flotante

Respuesta fallida

{ "error": { "code": 27305, "message": "Plan id does not exist" } }

              
              {
  "error": {
    "code": 27305,
    "message": "Plan id does not exist"
  }
}

Este bloque de código se muestra en una ventana flotante

Descripción de códigos de error

Código de error	Descripción	Método de gestión sugerido
21015	Los parámetros de solicitud para crear un plan de push son incorrectos	Comprobar si los tipos del `plan_id` o del `plan_description` son correctos
27300	El identificador del plan de push no es válido	Comprobar el `plan_id` para que cumpla las reglas de nomenclatura
27301	La descripción del plan de push no es válida	Comprobar el `plan_description` para que cumpla las reglas
27303	El identificador del plan de push está vacío	Proporcionar un identificador de plan de push válido al crear un plan de push
27304	La longitud del identificador del plan de push supera el límite	Hacer que la longitud del identificador del plan de push sea inferior a 50
21004	Fallo en la verificación de permisos para crear un plan de push	Confirmar si el llamante tiene permiso de acceso a la interfaz
27000	Error interno del servidor	Contactar con el soporte técnico o reintentar
1003	Los parámetros para consultar el plan de push no son válidos	Comprobar si `page_index/page_size` es mayor que 0
21004	Fallo en la verificación de permisos para consultar el plan de push	Confirmar si el llamante tiene permiso de acceso a la interfaz
27302	Se ha superado el límite máximo de uso del plan de push	Contactar con el soporte técnico para aumentar el límite
21009	Error interno del sistema, no se puede reintentar	Contactar con el soporte técnico
23001	Fallo en la verificación de permisos para consultar Msgid en función del plan de push	Confirmar si el llamante tiene permiso de acceso a la interfaz
3010	El volumen de llamadas a la API de la interfaz de consulta supera el límite	Contactar con el soporte técnico
23002	El parámetro plan_ids válido proporcionado para consultar Msgid en función del plan de push es incorrecto	Comprobar la validez de `plan_ids` o si se han proporcionado los parámetros de fecha
21003	La fecha proporcionada no es válida	Comprobar la validez de la fecha
21044	El intervalo entre las fechas de inicio y fin supera un mes	Hacer que el intervalo entre las fechas de inicio y fin sea inferior a un mes