Ajoute une note interne d'équipe à la conversation avec contact number . Les notes ne sont jamais visibles par le contact.
POST/v2/api/conversations/{contact_number}/notes
Comportement
Ajoute une note interne d'équipe à la conversation avec contact_number. Les notes ne sont jamais visibles par le contact.
Identifiez la ligne à laquelle la conversation est rattachée avec allo_number (E.164, listez vos lignes avec GET /v2/api/numbers) ou sender_id (pour les conversations d'une boîte sender ID). Omettre les deux retourne une erreur 400 avec le code MISSING_ALLO_NUMBER_OR_SENDER_ID.
Mentions
Mentionnez des coéquipiers inline dans content avec @[Display Name](usr-xxxx) — ils reçoivent les mêmes notifications push, email et in-app que les mentions faites depuis les applications Allo. Voir le guide des mentions.
Erreurs
Statut
Code
Quand
400
EMPTY_NOTE_CONTENT
content est manquant ou vide
400
NOTE_CONTENT_TOO_LONG
content dépasse 4 000 caractères
400
MISSING_ALLO_NUMBER_OR_SENDER_ID
Ni allo_number ni sender_id n'a été fourni
403
ALLO_NUMBER_FORBIDDEN
Vous n'avez pas accès à cette ligne Allo
404
SENDER_ID_NOT_FOUND
Aucun sender ID avec cet identifiant sur votre compte
Autorisation
Authorizationstring · headerrequis
Api-Key ak_live_…
Paramètres de chemin
contact_numberstringrequis
The contact's phone number (E.164)
Corps
contentstringrequis
Note text (max 4000 characters). Mention teammates inline with @[Name](usr-...), or @[all](all) to notify the whole team.
allo_numberstring
The Allo line the conversation belongs to (E.164). Required unless sender_id is provided.
sender_idstring | null
Sender-ID inbox identifier, as an alternative to allo_number for sender-ID conversations.
Réponses
201Note created
dataobject
8 champs
idstring
Note ID (not-*)
contentstring
Note text, with mentions inline as @[Name](usr-...).
contact_numberstring
The contact's phone number (E.164).
allo_numberstring | null
The Allo line the conversation belongs to (E.164).
userobject
Author of a note or comment.
2 champs
idstring
namestring | null
mentionsobject[]
3 champs
user_idstring
namestring | null
deletedboolean
true if the mentioned user has since been removed from the team.