List Chat Messages - List Chat Messages

Service:: Communication

Version d'API:: 2020-09-21-preview2

Obtient une liste de messages d’un thread.

GET {endpoint}/chat/threads/{chatThreadId}/messages?api-version=2020-09-21-preview2

Avec des paramètres facultatifs:

GET {endpoint}/chat/threads/{chatThreadId}/messages?maxPageSize={maxPageSize}&startTime={startTime}&api-version=2020-09-21-preview2

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
chatThreadId	path	True	string	ID de thread du message.
endpoint	path	True	string	Point de terminaison de la ressource Azure Communication.
api-version	query	True	string	Version de l’API à appeler.
maxPageSize	query		integer (int32)	Nombre maximal de messages à renvoyer par page. La limite est disponible à https://docs.microsoft.com/azure/communication-services/concepts/service-limits#size-limits
startTime	query		string (date-time)	Le point le plus tôt dans le temps pour recevoir des messages. L’horodatage doit être au format ISO8601 : `yyyy-MM-ddTHH:mm:ssZ`.

En-tête de la demande

Nom	Obligatoire	Type	Description
Authorization	True	string	Jeton d’accès utilisateur ACS (Azure Communication Services).

Réponses

Nom	Type	Description
200 OK	ChatMessagesCollection	Succès
401 Unauthorized	Error	Non autorisée
403 Forbidden	Error	Interdit
429 Too Many Requests	Error	Trop de demandes
Other Status Codes	Error	Service indisponible

Sécurité

Authorization

Jeton d’accès utilisateur ACS (Azure Communication Services).

Type: apiKey
Dans: header

Exemples

Get messages with pagination (max page size)

Exemple de requête

HTTP

GET https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/messages?maxPageSize=5&api-version=2020-09-21-preview2

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "1593107077690",
      "type": "Text",
      "priority": "Normal",
      "version": "1593107077683",
      "content": "So where should we get lunch from today?",
      "senderDisplayName": "Jane",
      "createdOn": "2020-06-25T17:44:37.6830000Z",
      "senderId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
    },
    {
      "id": "1593107077683",
      "type": "Text",
      "priority": "Normal",
      "version": "1593107077683",
      "content": "Let's use this chat to decide what to get for lunch today.",
      "senderDisplayName": "Jane",
      "createdOn": "2020-06-25T17:44:37.6830000Z",
      "senderId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
    },
    {
      "id": "1593107046498",
      "type": "Text",
      "priority": "Normal",
      "version": "1593107046498",
      "content": "Good morning everyone!",
      "senderDisplayName": "Jane",
      "createdOn": "2020-06-25T17:44:06.4980000Z",
      "senderId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
    },
    {
      "id": "1593106976785",
      "type": "ThreadActivity/TopicUpdate",
      "priority": "Normal",
      "version": "1593106976785",
      "content": "<topicupdate><eventtime>1593106976785</eventtime><initiator>8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b</initiator><value>Lunch</value></topicupdate>",
      "createdOn": "2020-06-25T17:42:56.7850000Z",
      "senderId": "19:453dafb77b26481ea2e73bcada0324af@thread.v2"
    },
    {
      "id": "1593106976753",
      "type": "ThreadActivity/AddMember",
      "priority": "Normal",
      "version": "1593106976753",
      "content": "<addmember><eventtime>1593106976753</eventtime><initiator>8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b</initiator><rosterVersion>1593106976566</rosterVersion><target>8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a</target><detailedtargetinfo><id>8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10a</id></detailedtargetinfo><target>8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b</target><detailedtargetinfo><id>8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b</id></detailedtargetinfo><target>8:acs:29d8ac59-6011-44dc-87c0-1f9f93dbc713_2a711a-6c8ffcdc41</target><detailedtargetinfo><id>8:acs:29d8ac59-6011-44dc-87c0-1f9f93dbc713_2a711a-6c8ffcdc41</id></detailedtargetinfo><target>8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c</target><detailedtargetinfo><id>8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10c</id></detailedtargetinfo></addmember>",
      "createdOn": "2020-06-25T17:42:56.7530000Z",
      "senderId": "19:453dafb77b26481ea2e73bcada0324af@thread.v2"
    }
  ],
  "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:453dafb77b26481ea2e73bcada0324af@thread.v2/messages?syncState=3e4700000031393a756e6930315f7a626e68336e74326466756666657a6333736f7837646f67377766686b36793571653272776c6e66686c68647a69726968647071407468726561642e763201451fe6e77201000004357fea72010000&startTime=0&maxPageSize=5&api-version=2020-09-21-preview2"
}

Code d’état:: 401

{
  "code": "Unauthorized",
  "message": "Request is not authorized."
}

Code d’état:: 403

{
  "code": "Forbidden",
  "message": "User is not allowed to perform specified action."
}

Code d’état:: 429

{
  "code": "TooManyRequests",
  "message": "Rate limit exceeded."
}

Code d’état:: 503

{
  "code": "ServiceUnavailable",
  "message": "The server is currently unable to handle the request."
}

Définitions

Nom	Description
ChatMessage
ChatMessagePriority	Priorité du message de conversation.
ChatMessagesCollection	Collection de messages de conversation pour un thread de conversation particulier.
Error

ChatMessage

Object

Nom	Type	Description
content	string	Contenu du message de conversation.
createdOn	string (date-time)	Horodatage lorsque le message de conversation est arrivé au serveur. L’horodatage est au format ISO8601 : `yyyy-MM-ddTHH:mm:ssZ`.
deletedOn	string (date-time)	Horodatage lorsque le message de conversation a été supprimé. L’horodatage est au format ISO8601 : `yyyy-MM-ddTHH:mm:ssZ`.
editedOn	string (date-time)	Horodatage lorsque le message de conversation a été modifié. L’horodatage est au format ISO8601 : `yyyy-MM-ddTHH:mm:ssZ`.
id	string	ID du message de conversation. Cet ID est généré par le serveur.
priority	ChatMessagePriority	Priorité du message de conversation.
senderDisplayName	string	Nom complet de l’expéditeur du message de conversation. Cette propriété est utilisée pour remplir le nom de l’expéditeur pour les notifications Push.
senderId	string	ID de l’expéditeur du message de conversation.
type	string	Type du message de conversation. Valeurs possibles : - Text - ThreadActivity/TopicUpdate - ThreadActivity/AddMember - ThreadActivity/DeleteMember
version	string	Version du message de conversation.

ChatMessagePriority

Énumération

Priorité du message de conversation.

Valeur	Description
Normal
High

ChatMessagesCollection

Object

Collection de messages de conversation pour un thread de conversation particulier.

Nom	Type	Description
nextLink	string	S’il existe plus de messages de conversation qui peuvent être récupérés, le lien suivant est rempli.
value	ChatMessage[]	Collection de messages de conversation.

Error

Object

Nom	Type	Description
code	string
innerErrors	Error[]
message	string
target	string

Partager via

List Chat Messages - List Chat Messages

Paramètres URI

En-tête de la demande

Réponses

Sécurité

Authorization

Exemples

Get messages with pagination (max page size)

Exemple de requête

Exemple de réponse

Définitions

ChatMessage

ChatMessagePriority

ChatMessagesCollection

Error