La page de signature permet à un participant et à un membre de l’espace de travail d’échanger des messages.
Envoyer un message instantané à un participant
Si un participant a envoyé un message au créateur de la transaction via la fonctionnalité de messagerie instantanée de la page de signature, le créateur de la transaction peut y répondre. Pour envoyer un message instantané à un participant, envoyez une requête à POST/v1/transactions/{transaction_id}/participants/messages et transmettez l’argument email du participant ainsi que l’argument message :
curl
https://api.universign.com/v1/transactions/tx_aA5g6yzYVYW8/participants/messages \
-d [email protected] \
-d message=Veuillez nous excuser pour ce désagrément. La faute de frappe a été corrigée.
L’API renvoie le message envoyé par le membre de l’espace de travail qui a répondu au participant.
{
"object": "message",
"id": "msg_MJAobD5aG297e",
"sent_at": "2022-01-19T18:45:44Z",
"message": "Veuillez nous excuser pour ce désagrément. La faute de frappe a été corrigée.",
"from_participant": false,
"was_read": false
}
Marquer un message comme lu
Une fois que vous avez répondu au message d’un participant, vous pouvez marquer son message comme lu. Pour ce faire, envoyez une requête à POST/v1/transactions/{transaction_id}/participants/messages/{message_id} et transmettez l’argument email du participant :
curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/participants/messages/msg_1aZMnyLZB477e
-d [email protected]
L’API renvoie le message envoyé par le participant.
{
"object": "message",
"id": "msg_1aZMnyLZB477e",
"sent_at": "2022-01-19T18:45:44Z",
"message": "Merci pour votre réponse.",
"from_participant": true,
"was_read": true
}
Récupérer une conversation
Pour récupérer le contenu de la conversation, envoyez une requête à GET/v1/transactions/{transaction_id}/participants/messages et transmettez l’argument email du participant :
curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/participants/messages
-d [email protected]
L’API renvoie les messages existants entre le participant et l’espace de travail.
[
{
"object": "message",
"id": "msg_V9KaBgPreADy",
"sent_at": "2022-10-19T15:02:28Z",
"message": "Ceci est un exemple de message !",
"from_participant": true,
"was_read": true
},
{
"object": "message",
"id": "msg_zwEVwYaB1ZX6r",
"sent_at": "2022-10-19T15:13:23Z",
"message": "Ceci est un exemple de réponse !",
"from_participant": false,
"was_read": false
}
]
