Chat Thread - Get Chat Message
Obtém uma mensagem por ID.
GET {endpoint}/chat/threads/{chatThreadId}/messages/{chatMessageId}?api-version=2024-03-07
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
chat
|
path | True |
string |
A ID da mensagem. |
chat
|
path | True |
string |
A ID do thread para a qual a mensagem foi enviada. |
endpoint
|
path | True |
string |
O ponto de extremidade do recurso de Comunicação do Azure. |
api-version
|
query | True |
string |
Versão da API a ser invocada. |
Cabeçalho da solicitação
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
Authorization | True |
string |
Um token de acesso de usuário do ACS (Serviços de Comunicação do Azure). |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Solicitação bem-sucedida. A ação retorna um recurso de |
|
401 Unauthorized |
Communication |
Desautorizado. |
403 Forbidden |
Communication |
Proibido. |
429 Too Many Requests |
Communication |
Muitas solicitações. |
Other Status Codes |
Communication |
Serviço indisponível. |
Segurança
Authorization
Um token de acesso de usuário do ACS (Serviços de Comunicação do Azure).
Tipo:
apiKey
Em:
header
Exemplos
Get Message
Solicitação de exemplo
GET https://contoso.westus.communications.azure.com/chat/threads/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/messages/1591768249318?api-version=2024-03-07
Resposta de exemplo
{
"id": "1591768249318",
"sequenceId": "1",
"type": "text",
"version": "1599016601134",
"content": {
"message": "Let's head out for lunch in 15 minutes."
},
"senderDisplayName": "Jane",
"createdOn": "2020-06-10T05:50:49.3180000Z",
"senderCommunicationIdentifier": {
"rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
"communicationUser": {
"id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
}
},
"metadata": {
"someKey1": "someValue1",
"someKey2": "someValue2"
}
}
{
"error": {
"code": "Unauthorized",
"message": "Request is not authorized."
}
}
{
"error": {
"code": "Forbidden",
"message": "User is not allowed to perform specified action."
}
}
{
"error": {
"code": "TooManyRequests",
"message": "Rate limit exceeded."
}
}
{
"error": {
"code": "ServiceUnavailable",
"message": "The server is currently unable to handle the request."
}
}
Definições
Nome | Description |
---|---|
Chat |
Um anexo em uma mensagem de chat. |
Chat |
O tipo de anexo. |
Chat |
Mensagem de chat. |
Chat |
Conteúdo de uma mensagem de chat. |
Chat |
O tipo de mensagem de chat. |
Chat |
Um participante do thread de chat. |
ChatAttachment
Um anexo em uma mensagem de chat.
Nome | Tipo | Description |
---|---|---|
attachmentType |
O tipo de anexo. |
|
id |
string |
ID do anexo |
name |
string |
O nome do conteúdo do anexo. |
previewUrl |
string |
A URL em que a visualização do anexo pode ser baixada |
url |
string |
A URL em que o anexo pode ser baixado |
ChatAttachmentType
O tipo de anexo.
Nome | Tipo | Description |
---|---|---|
file |
string |
|
image |
string |
ChatMessage
Mensagem de chat.
Nome | Tipo | Description |
---|---|---|
content |
Conteúdo de uma mensagem de chat. |
|
createdOn |
string |
O carimbo de data/hora quando a mensagem de chat chegou ao servidor. O carimbo de data/hora está no formato RFC3339: |
deletedOn |
string |
O carimbo de data/hora (se aplicável) quando a mensagem foi excluída. O carimbo de data/hora está no formato RFC3339: |
editedOn |
string |
O último carimbo de data/hora (se aplicável) quando a mensagem foi editada. O carimbo de data/hora está no formato RFC3339: |
id |
string |
A ID da mensagem de chat. Essa ID é gerada pelo servidor. |
metadata |
object |
Metadados de mensagem. |
senderCommunicationIdentifier |
Communication |
|
senderDisplayName |
string |
O nome de exibição do remetente da mensagem de chat. Essa propriedade é usada para preencher o nome do remetente para notificações por push. |
sequenceId |
string |
Sequência da mensagem de chat na conversa. |
type |
O tipo de mensagem de chat. |
|
version |
string |
Versão da mensagem de chat. |
ChatMessageContent
Conteúdo de uma mensagem de chat.
Nome | Tipo | Description |
---|---|---|
attachments |
Lista de anexos para esta mensagem |
|
initiatorCommunicationIdentifier |
Communication |
|
message |
string |
Conteúdo da mensagem de chat para mensagens de tipos de texto ou html. |
participants |
Conteúdo da mensagem de chat para mensagens dos tipos de participante Adicionados ou participanteRemoved. |
|
topic |
string |
Conteúdo da mensagem de chat para mensagens do tipo topicUpdated. |
ChatMessageType
O tipo de mensagem de chat.
Nome | Tipo | Description |
---|---|---|
html |
string |
|
participantAdded |
string |
|
participantRemoved |
string |
|
text |
string |
|
topicUpdated |
string |
ChatParticipant
Um participante do thread de chat.
Nome | Tipo | Description |
---|---|---|
communicationIdentifier |
Communication |
|
displayName |
string |
Nome de exibição para o participante do chat. |
shareHistoryTime |
string |
Hora da qual o histórico de chat é compartilhado com o participante. O carimbo de data/hora está no formato RFC3339: |