Servicio de correo electrónico de la aplicación

Artículo
05/17/2024

Nota:

Este servicio está disponible actualmente para un conjunto limitado de clientes y empleados de Microsoft.

El servicio de correo electrónico de la aplicación es un servicio de solo administrador que administra las notificaciones automáticas de correo electrónico enviadas a los usuarios administradores cuando se instalan, modifican o eliminan aplicaciones. Este es también el servicio que se usa para cambiar el contenido de las notificaciones por correo electrónico en la instalación, modificación o eliminación de la aplicación.

API de REST

Http (método)	Endpoint	Description
`POST`	`https://api.appnexus.com/app-email` (`new_email` JSON)	Agregar un correo electrónico de aplicación
`PUT`	`https://api.appnexus.com/app-email?id=ID` (`update_email` JSON)	Modificación de un correo electrónico de aplicación existente
`GET`	`https://api.appnexus.com/app-email`	Ver todos los correos electrónicos de la aplicación
`GET`	`https://api.appnexus.com/app-email?id=ID`	Visualización de un correo electrónico de aplicación específico
`DELETE`	`https://api.appnexus.com/app-email?id=ID`	Eliminación de un correo electrónico de aplicación

Campos JSON

Campo	Tipo	Description
`id`	Entero	Solo lectura. Identificador generado automáticamente del correo electrónico que se envía a través del `app_email` servicio. Obligatorio activado: `PUT`, `DELETE`
`recipient`	string	Nombre de la persona, las personas, el equipo o los equipos que reciben el correo electrónico. Los nombres pueden contener hasta 225 caracteres. Obligatorio activado: `POST (JSON)`
`type`	string	El campo de tipo se usa para asignar una categoría al correo electrónico, por ejemplo `"data team"` , o `"services bugs"`. Puede contener hasta 225 caracteres. Valor predeterminado: `null`
`action`	enumeración	Evento que desencadena el correo electrónico de notificación. Los valores posibles son: - `"put"` - `"post"` - `"delete"`. Valor predeterminado: `POST` Obligatorio activado: `POST (JSON)`
`recipient_emails`	string	Las direcciones de correo electrónico de las personas que deben recibir la notificación. Puede contener direcciones de correo electrónico específicas separadas por comas o una variable que extrae correos electrónicos específicos de la base de datos para rellenar el campo. Ejemplos: - `name1@appnexus.com` - `name1@appnexus.com,name2@appnexus.com` - `%developer_email%,name1@appnexus.com` - `%developer_email%,%installer_email%` Obligatorio activado: `POST (JSON)`
`subject`	string	Texto que aparecerá en el campo asunto del correo electrónico. Obligatorio activado: `POST (JSON)`
`body`	string	Cuerpo del correo electrónico. No tiene un límite de caracteres. Obligatorio activado: `POST (JSON)`
`bcc`	string	Las direcciones de correo electrónico de las personas que deben recibir la notificación como destinatarios de cco. Puede contener direcciones de correo electrónico específicas separadas por comas o una variable que extrae correos electrónicos específicos de la base de datos para rellenar el campo. Ejemplos: - `name1@appnexus.com` - `name1@appnexus.com,name2@appnexus.com` - `%developer_email%,name1@appnexus.com` - `%developer_email%,%installer_email%` Valor predeterminado: `null`

Ejemplos

Agregar un nuevo correo electrónico de aplicación

$ cat new_email.json
                      {
                      "app-email": {
                      "recipient": "Jane User",
                      "action": "put",
                      "recipient_emails": "juser@email.com",
                      "subject": "App Added",
                      "body": "Hello world!"
                      }
                      }
                      $ curl -b cookies -c cookies -X POST -d @new_email.json 'https://api.appnexus.com/app-email'
                      {
                      "response": {
                      "status": "OK"
                      "count": 1
                      "id": 54
                      "start_element": 0
                      "num_elements": 100
                      "app-email": {
                      "id": 54
                      "recipient": "Jane User"
                      "type": null
                      "action": "put"
                      "recipient_emails": "juser@email.com"
                      "subject": "App Added"
                      "body": "Hello world!"
                      "bcc": null
                      }
                      }
                      }

Actualización de un correo electrónico de aplicación existente

$ cat update_email.json
                      {
                      "app-email":
                      {
                      "body": "Goodbye world!"
                      }
                      }
                      $ curl -b cookies -c cookies -X PUT -d @update_email 'https://api.appnexus.com/app-email?id=30'
                      {
                      "response": {
                      "status": "OK"
                      "count": 1
                      "id": "30"
                      "start_element": 0
                      "num_elements": 100
                      "app-email": {
                      "id": 30
                      "recipient": "DataTeam"
                      "type": "LogLevelData"
                      "action": "delete"
                      "recipient_emails": "psung@appnexus.com"
                      "subject": "Log Level Data consuming app %app_name% (%app_id%) has been uninstalled"
                      "body": "Goodbye world!"
                      "bcc": null
                      }
                      }
                      }

Ver todos los correos electrónicos de la aplicación

$ curl -b cookies -c cookies 'https://api.appnexus.com/app-email'
                      
                      {
                      "response": {
                      "status": "OK"
                      "count": 3
                      "start_element": 0
                      "num_elements": 100
                      "app-emails": [
                      {
                      "id": 29
                      "recipient": "SalesOps"
                      "type": "LogLevelData"
                      "action": "post"
                      "recipient_emails": "psung@appnexus.com"
                      "subject": "Log Level Data consuming app %app_name% (%app_id%) has been installed"
                      "body": "<p>Hi SalesOps, </p> <p>%subscriber_entity_name% (%subscriber_entity_id%) has installed %app_name% (%app_id%) on %installed_on%. Since %app_name% consumes LLD, please make the appropriate updates in SFDC. </p> <p>Thanks, <br /> The Apps Team</p>"
                      "bcc": null
                      },
                      {
                      "id": 32
                      "recipient" "AppDeveloper"
                      "type": null
                      "action": "delete"
                      "recipient_emails": "%developer_email%"
                      "subject": "%subscriber_entity_name% has uninstalled %app_name%"
                      "body": "<p>Hi %app_name%, </p> <p>%subscriber_entity_name% (%subscriber_entity_id%) has uninstalled your app on AppNexus. They uninstalled on %uninstalled_on%. This email is for your records.</p> <p>Thanks, <br /> The Apps Team<br /> </p>"
                      "bcc": "auser@appnexus.com"
                      },
                      {
                      "id": 34
                      "recipient": "AppSubscriber"
                      "type": null
                      "action": "delete"
                      "recipient_emails": "%installer_email%"
                      "subject": "You have uninstalled %app_name%"
                      "body": "<p>Hi %subscriber_entity_name%,</p> <p>You have uninstalled %app_name% (%app_id%) at %uninstalled_on%. This                           email is for your records. </p> <p>Thanks, <br /> The Apps Team</p>"
                      "bcc": null
                      }
                      ]
                      }
                      }

Visualización de un correo electrónico de aplicación específico

$ curl -b cookies -c cookies 'https://api.appnexus.com/app-email?id=54'
                      
                      {
                      "response": {
                      "status": "OK"
                      "count": 1
                      "start_element": 0
                      "num_elements": 100
                      "app-email": {
                      "id": 54
                      "recipient": "Jane User"
                      "type": null
                      "action": "put"
                      "recipient_emails": "juser@email.com"
                      "subject": "App Added"
                      "body": "Hello world!"
                      "bcc": null
                      }
                      }
                      }

Eliminación de un correo electrónico de aplicación

$ curl -b cookies -c cookies -X DELETE 'https://api.appnexus.com/app-email?id=54
                      {
                      "response": {
                      "status": "OK"
                      }
                      }

Compartir a través de