Service de messagerie d’application

Remarque

Ce service est actuellement disponible pour un ensemble limité de clients et d’employés Microsoft uniquement.

Le service de messagerie d’application est un service administrateur uniquement qui gère les Notifications par e-mail automatiques envoyées aux utilisateurs administrateurs lorsque les applications sont installées, modifiées ou supprimées. Il s’agit également du service utilisé pour modifier le contenu de Notifications par e-mail lors de l’installation, de la modification ou de la suppression de l’application.

API REST

HTTP, méthode	Endpoint	Description
`POST`	`https://api.appnexus.com/app-email` (`new_email` JSON)	Ajouter un e-mail d’application
`PUT`	`https://api.appnexus.com/app-email?id=ID` (`update_email` JSON)	Modifier un e-mail d’application existant
`GET`	`https://api.appnexus.com/app-email`	Afficher tous les e-mails d’application
`GET`	`https://api.appnexus.com/app-email?id=ID`	Afficher un e-mail d’application spécifique
`DELETE`	`https://api.appnexus.com/app-email?id=ID`	Supprimer un e-mail d’application

Champs JSON

Champ	Type	Description
`id`	int	En lecture seule. ID généré automatiquement de l’e-mail envoyé via le `app_email` service. Obligatoire le : `PUT`, `DELETE`
`recipient`	string	Nom de la personne, des personnes, de l’équipe ou des équipes qui reçoivent l’e-mail. Le ou les noms peuvent contenir jusqu’à 225 caractères. Obligatoire sur : `POST (JSON)`
`type`	string	Le champ type est utilisé pour affecter une catégorie à l’e-mail, par exemple `"data team"` ou `"services bugs"`. Il peut contenir jusqu’à 225 caractères. Par défaut : `null`
`action`	enum	Événement qui déclenche l’e-mail de notification. Les valeurs possibles sont les suivantes : - `"put"` - `"post"` - `"delete"`. Par défaut : `POST` Obligatoire sur : `POST (JSON)`
`recipient_emails`	chaîne	Adresses e-mail des personnes qui doivent recevoir la notification. Peut contenir des adresses e-mail spécifiques séparées par des virgules et/ou une variable qui extrait des e-mails spécifiques de la base de données pour remplir le champ. Exemples : - `name1@appnexus.com` - `name1@appnexus.com,name2@appnexus.com` - `%developer_email%,name1@appnexus.com` - `%developer_email%,%installer_email%` Obligatoire sur : `POST (JSON)`
`subject`	string	Texte qui apparaîtra dans le champ objet de l’e-mail. Obligatoire sur : `POST (JSON)`
`body`	string	Corps de l’e-mail. N’a pas de limite de caractères. Obligatoire sur : `POST (JSON)`
`bcc`	string	Adresses e-mail des personnes qui doivent recevoir la notification en tant que destinataires cci. Peut contenir des adresses e-mail spécifiques séparées par des virgules et/ou une variable qui extrait des e-mails spécifiques de la base de données pour remplir le champ. Exemples : - `name1@appnexus.com` - `name1@appnexus.com,name2@appnexus.com` - `%developer_email%,name1@appnexus.com` - `%developer_email%,%installer_email%` Par défaut : `null`

Exemples

Ajouter un nouvel e-mail d’application

$ 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
                      }
                      }
                      }

Mettre à jour un e-mail d’application existant

$ 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
                      }
                      }
                      }

Afficher tous les e-mails d’application

$ 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
                      }
                      ]
                      }
                      }

Afficher un e-mail d’application spécifique

$ 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
                      }
                      }
                      }

Supprimer un e-mail d’application

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

Last updated on 2025-10-22

Partager via