POSTResponder uma conversa
Envia uma mensagem do administrador numa conversa.
Acrescenta uma mensagem, como admin, à conversa. A mensagem aparece na hora para os outros participantes que estiverem conectados (tempo real). O texto é limpo de HTML e scripts e fica como texto puro.
/api/v1/admin/messages/threads/{id}/replyAdminEnvia uma mensagem do administrador na conversa
Exige o privilégio manage_settings. O administrador enxerga e responde qualquer conversa da loja.
Parâmetros de caminho
iduuidobrigatórioIdentificador da conversa.
Corpo da requisição
bodystringTexto da mensagem. Obrigatório se não houver anexos.
attachmentsarrayAnexos já enviados à mídia da loja. Obrigatório se não houver body.
urlstringEndereço do arquivo.
filenamestringNome do arquivo.
content_typestringTipo MIME.
sizeintegerTamanho em bytes.
Exemplo de requisição
Resposta
201Mensagem enviada
Campos da resposta
iduuidIdentificador da mensagem.
thread_iduuidConversa.
sender_iduuidUsuário que enviou.
sender_typestringcustomervendoradminQuem enviou.
bodystringTexto, sem HTML.
attachmentsarrayAnexos. Cada um tem
url, filename, content_type e size (bytes).is_readbooleantrue quando o outro lado leu.delivered_atstringQuando chegou ao outro lado, RFC 3339. Ausente se ainda não.
read_atstringQuando foi lida, RFC 3339. Ausente se ainda não.
created_atstringEnvio, RFC 3339.
Erros
| Status | Quando | Exemplo de corpo |
|---|---|---|
| 401 | Token ausente, inválido ou expirado. | {"error":"invalid or expired token"} |
| 403 | O administrador não tem o privilégio manage_settings. | {"error":"insufficient privileges","required":"manage_settings"} |
| 400 | O id não é um UUID válido. | {"error":"invalid id","detail":"id must be a valid UUID"} |
| 400 | Corpo inválido, ou nem body nem attachments. | {"error":"body or attachments required"} |
| 500 | Falha ao gravar. | {"error":"failed to send message","detail":"..."} |