Comandos API de Listas de Anuncios

Generalidades

El módulo de API announcement_list te permite administrar Listas de Anuncios y suscriptores. Las siguientes opciones están disponibles.

Revisa el siguiente artículo para obtener instrucciones sobre cómo conectarte a la API de DreamHost. Usa las instrucciones de este artículo para construir tu llamada de API.

announcement_list-list_lists

El comando announcement_list-list_lists enumera las Listas de Anuncios que tienes en tu cuenta.

Correr el comando

El siguiente comando enumera todas las Listas de Anuncios en tu cuenta.

https://api.dreamhost.com/?key=1A2B3C4D5E6F7G8H&cmd=announcement_list-list_lists

announcement_list-list_subscribers

El comando announcement_list-list_subscribers enumera todos los suscriptores de una Lista de Anuncios.

Debes especificar los siguientes comandos cuando corras este comando.

  • listname: &listname= seguido de la Lista de Anuncios. Este sería el Nombre de la Lista que aparece en la página Listas de Anuncios en tu panel. Por ejemplo, si el Nombre de la Lista en tu panel muestra testlist@example.com, este sería testlist.
  • domain: &domain= seguido del dominio de la Lista de Anuncios. Por ejemplo, example.com.

Correr el comando

El siguiente comando enumera todas las Listas de Anuncios en tu cuenta.

https://api.dreamhost.com/?key=1A2B3C4D5E6F7G8H&cmd=announcement_list-list_subscribers&listname=testlist&domain=example.com

announcement_list-add_subscriber

El comando announcement_list-add_subscriber envía un correo de suscripción voluntaria a una dirección de correo para pedirles que se suscriban a la Lista de Anuncios.

Debes especificar los siguientes valores al correr este comando.

  • listname: &listname= seguido del nombre de la Lista de Anuncios. Esto sería el Nombre de la Lista que aparece en la página Lista de Anuncios en tu panel. Por ejemplo, si el Nombre de la Lista en tu panel muestra testlist@example.com, este sería testlist.
  • domain: &domain= seguido del dominio de la Lista de Anuncios. Por ejemplo, example.com.
  • email: &email= seguido del correo que quieres que se suscriba. Por ejemplo, newuser@example.com.
  • name : &name= seguido del nombre. Por ejemplo John Doe.

Correr el comando

El siguiente comando envía un correo de suscripción a una dirección de correo pidiéndoles que hagan clic en un enlace para suscribirse a tus Listas de Anuncios.

https://api.dreamhost.com/?key=1A2B3C4D5E6F7G8H&cmd=announcement_list-add_subscriber&listname=testlist&domain=example.com&email=newuser@example.com

announcement_list-remove_subscriber

El comando announcement_list-remove_subscriber elimina inmediatamente una dirección de correo de una Lista de Anuncios.

Debes especificar los siguientes valores al correr este comando.

  • listname: &listname= seguido del nombre de la Lista de Anuncios. Este sería el Nombre de la Lista que aparece en la página Listas de Anuncios en tu panel. Por ejemplo, si el Nombre de la Lista en tu panel muestra testlist@example.com, este sería testlist.
  • domain: &domain= seguido del dominio de la Lista de Anuncios. Por ejemplo, example.com.
  • email: &email= seguido del correo electrónico que quieres que se suscriba. Por ejemplo, newuser@example.com.

Correr el comando

El siguiente comando enumera todas las Listas de Anuncios de tu cuenta.

https://api.dreamhost.com/?key=1A2B3C4D5E6F7G8H&cmd=announcement_list-remove_subscriber&listname=testlist&domain=example.com&email=newuser@example.com

announcement_list-post_announcement

El comando announcement_list-post_announcement publica un anuncio a una Lista de Anuncios.

Debes especificar los siguientes valores cuando corras este comando.

  • listname: &listname= seguido del nombre de la Lista de Anuncios. Este sería el Nombre de la Lista que aparece en la página Lista de Anuncios en tu panel. Por ejemplo, si el Nombre de la Lista en tu panel muestra testlist@example.com, este sería testlist.
  • domain: &domain= seguido por el dominio de la Lista de Anuncios. Por ejemplo, example.com.
  • subject (opcional): &subject= seguido del asunto del mensaje.
  • message: &message= seguido del texto del mensaje a enviar. Si se ha configurado html como el tipo, puedes escribir el código HTML aquí directamente. <h1>Header</h1><p>Paragraph</p>.
  • name: &name= seguido del Nombre de la Lista para esta lista en la página "Editar" lista. Por ejemplo: "list name" <testlist@example.com>

    Este es el campo From Name que aparece en la página donde editas la Lista de Anuncio. Por ejemplo, navega a la página Listas de Anuncios, y luego da clic en el botón Edit a la derecha. El segundo campo es titulado From Name. Copia el nombre de la lista completo de este campo.

  • stamp (opcional): &stamp= seguido de la fecha y hora para enviar este mensaje. Por ejemplo: 2024-04-09 19:40:00.
  • charset (opcional): &charset= seguid del cáracter configurado en donde está codificado el mensaje. Por ejemplo utf-8.
  • type (opcional): &type= seguido del formato del mensaje. Las opciones son text o html.
  • duplicate_ok (opcional): &duplicate_ok= seguido de un 1 o un 0. Esto indica que si permites duplicar los mensajes que se envían.

Correr el comando

El siguiente comando enumera todas las Listas de Anuncios en tu cuenta.

https://api.dreamhost.com/?key=1A2B3C4D5E6F7G8H&cmd=announcement_list-post_announcement&listname=testlist&domain=example.com&subject=List Subject Here&message=<h1>Header</h1><p>Paragraph</p>&name="listname" <testlist@example.com>&stamp=2021-10-05 14:45:00&charset=utf-8&type=html&duplicate_ok=1

Ver también

¿Este artículo ha respondido sus preguntas?

Última actualización el PST.

¿Aún no encuentra lo que busca?