Skip to content

Listar el estado del grupo de suscripción del usuario

get

/subscription/status/get

Utilice este punto final para obtener el estado de suscripción de un usuario en un grupo de suscripción.

Estos grupos estarán disponibles en la página Grupo de suscripción. La respuesta de este punto final incluirá el ID externo y la categoría de suscrito, dado de baja o desconocido para el grupo de suscripción específico solicitado en la llamada a la API. Esto se puede utilizar para actualizar el estado del grupo de suscripción en posteriores llamadas a la API o para mostrarlo en una página web alojada.

Si desea ver ejemplos o probar este punto final para Grupos de suscripción por correo electrónico:

See me in Postman

Si quieres ver ejemplos o probar este punto final para Grupos de Suscripción SMS:

See me in Postman

Si quieres ver ejemplos o probar este punto final para Grupos de WhatsApp:

See me in Postman

Requisitos previos

Para utilizar este punto final, necesitarás una clave de API con el permiso subscription.status.get.

Límite de velocidad

Aplicamos el límite de velocidad predeterminado de Braze de 250 000 solicitudes por hora a este punto final, como se documenta en Límites de velocidad de la API.

Parámetros de la solicitud

Parámetro Obligatoria Tipo de datos Descripción
subscription_group_id Obligatoria Cadena La dirección id de su grupo de suscripción.
external_id Requerido* Cadena La dirección external_id del usuario (debe incluir como mínimo uno y como máximo 50 external_ids).

Cuando se envían tanto un external_id como un email/phone, solo se aplicarán a la consulta de resultados los external_id proporcionados.
email Requerido* Cadena La dirección de correo electrónico del usuario. Se puede pasar como una matriz de cadenas con un máximo de 50.

Si envías una dirección de correo electrónico y un número de teléfono (sin external_id), se producirá un error.
phone Requerido* Cadena en E.164 formato El número de teléfono del usuario. Si no se incluye el correo electrónico, deberá incluir al menos un número de teléfono (con un máximo de 50).

Si envías una dirección de correo electrónico y un número de teléfono (sin external_id), se producirá un error.
  • Para los grupos de suscripción de SMS y WhatsApp, se requiere external_id o phone. Cuando se envían ambos, sólo se utiliza el external_id para la consulta y el número de teléfono se aplica a ese usuario.
  • Para los grupos de suscripción por correo electrónico, se requiere external_id o email. Cuando se envían ambos, sólo se utiliza el external_id para la consulta y la dirección de correo electrónico se aplica a ese usuario.

Ejemplo de solicitud

1

https://rest.iad-03.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&external_id[]=1&external_id[]=2

1
2

curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&phone=+11112223333' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

1
2

curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&[email protected]' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Respuesta

Todas las respuestas correctas devolverán Subscribed, Unsubscribed, o Unknown dependiendo del estado y del historial del usuario con el grupo de suscripción.

1
2
3
4
5
6
7
8
9

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "status": {
    "1": "Unsubscribed",
    "2": "Subscribed"
  },
  "message": "success"
}
Github   Editar esta página en GitHub
¿QUÉ TAN ÚTIL FUE ESTA PÁGINA?
New Stuff!