Ferramenta MCP
Consultar mensagens privadas
sosoapi_dm_messages_queryLeia um número limitado de mensagens privadas não expiradas com uma autorização explícita de leitura específica da conta. O conteúdo é privado e não confiável; não o encaminhe a modelos.
Ler como MarkdownPerfis e transportes
Perfis: full · Transportes: stdio, http
Escolha core ou full para controlar quais ferramentas seu cliente vê; isso não altera suas permissões. O envio de arquivos locais exige stdio e não está disponível por HTTP. Defina SOSOAPI_OUTPUT_SCHEMAS=1 para incluir schemas de saída na descoberta. As ferramentas retornam resultados estruturados com ou sem essa configuração.
Permissões e efeitos colaterais
As anotações ajudam os clientes a descrever uma ferramenta. Cada chamada ainda verifica autenticação, função, acesso a recursos e concessões de capacidades do usuário.
{
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": true
}- /private-messaging-api/messages/query: agent:dm_read · synchronous_http_response
Campos de entrada
Obrigatório significa obrigatório dentro do objeto pai e da ramificação selecionada. Um filho obrigatório não torna obrigatório um pai opcional. As regras e nomes de campos abaixo são copiados do contrato.
| Campo / ramificação | Tipo / obrigatório | Restrições |
|---|---|---|
$ | objectObrigatório no objeto pai |
|
workspace_id | stringObrigatório no objeto pai |
|
social_account_id | stringObrigatório no objeto pai |
|
conversation_id | stringObrigatório no objeto pai |
|
page_size | integerOpcional / item |
|
cursor | stringOpcional / item |
|
JSON Schema completo
{
"type": "object",
"properties": {
"workspace_id": {
"type": "string",
"format": "uuid"
},
"social_account_id": {
"type": "string",
"format": "uuid"
},
"conversation_id": {
"type": "string",
"format": "uuid"
},
"page_size": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"cursor": {
"type": "string",
"minLength": 1,
"maxLength": 4096
}
},
"required": [
"workspace_id",
"social_account_id",
"conversation_id"
],
"additionalProperties": false
}Saída estruturada
Este schema descreve structuredContent em um resultado de ferramenta bem-sucedido. A resposta MCP também inclui content e pode definir isError quando uma chamada falha. Para publicações, consulte o resultado final do post em vez de tratar uma requisição aceita ou resposta de texto como confirmação. A operação de API vinculada explica as permissões e regras de repetição.
Obrigatório significa obrigatório dentro do objeto pai e da ramificação selecionada. Um filho obrigatório não torna obrigatório um pai opcional. As regras e nomes de campos abaixo são copiados do contrato.
| Campo / ramificação | Tipo / obrigatório | Restrições |
|---|---|---|
$ | objectObrigatório no objeto pai |
|
contract_version | stringObrigatório no objeto pai |
|
items | arrayObrigatório no objeto pai | — |
items[] | objectOpcional / item |
|
items[].id | stringObrigatório no objeto pai |
|
items[].conversation_id | stringObrigatório no objeto pai |
|
items[].direction | stringObrigatório no objeto pai |
|
items[].provider_message_id | stringObrigatório no objeto pai | — |
items[].occurred_at | stringObrigatório no objeto pai |
|
items[].expires_at | stringObrigatório no objeto pai |
|
items[].text | string | nullObrigatório no objeto pai | — |
items[].redacted | booleanObrigatório no objeto pai | — |
next_cursor | string | nullObrigatório no objeto pai | — |
JSON Schema completo
{
"type": "object",
"properties": {
"contract_version": {
"type": "string",
"const": "private-messaging/v1"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"conversation_id": {
"type": "string",
"format": "uuid"
},
"direction": {
"type": "string",
"enum": [
"inbound",
"outbound"
]
},
"provider_message_id": {
"type": "string"
},
"occurred_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"expires_at": {
"type": "string",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"format": "date-time"
},
"text": {
"type": [
"string",
"null"
]
},
"redacted": {
"type": "boolean"
}
},
"required": [
"id",
"conversation_id",
"direction",
"provider_message_id",
"occurred_at",
"expires_at",
"text",
"redacted"
],
"additionalProperties": false
}
},
"next_cursor": {
"type": [
"string",
"null"
]
}
},
"required": [
"contract_version",
"items",
"next_cursor"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}Exemplo de chamada de ferramenta
Estes exemplos usam valores fictícios verificados conforme os schemas. Substitua os IDs por aqueles que você tem autorização para usar, a mídia por ativos prontos e as datas pelo horário de publicação confirmado. Confira a elegibilidade da conta antes de enviar uma gravação. Esta página não envia requisições de API.
{
"name": "sosoapi_dm_messages_query",
"arguments": {
"workspace_id": "11111111-1111-4111-8111-111111111111",
"social_account_id": "11111111-1111-4111-8111-111111111111",
"conversation_id": "11111111-1111-4111-8111-111111111111"
}
}structuredContent
{
"contract_version": "private-messaging/v1",
"items": [],
"next_cursor": "example"
}