DOM360
Canais

Listar as mensagens enviadas por um canal

GET
/channels/{channel_id}/messages

As mensagens que a plataforma enviou pelo canal, da mais nova para a mais antiga, e o que aconteceu com cada uma: aceita, enviada, entregue, lida ou falha. As mensagens da conversa inteira estão em /conversations/{conversation_id}/messages.

Autorização

bearer channels:read
AutorizaçãoBearer <token>

Credencial da v3: o JWT da sessão (o mesmo da v2) ou um token pessoal dom_pat_…. A lista de escopos de cada operação diz o que ela exige: uma capacidade (agents:read), authenticated ou session-only. Segredo de máquina (X-Agent-Secret, X-API-Token, sdk_…) não é aceito.

Em: header

Escopo: channels:read

Parâmetros de caminho

channel_id*string

Id do canal

Parâmetros de consulta

cursor?string

Cursor opaco devolvido em page.next_cursor da página anterior. Omita para começar do início.

limit?integer

Tamanho da página. Padrão 50; o máximo é o da coleção: 200, ou até 500 nas coleções de itens pequenos.

Formatoint32
Intervalo0 <= value

Corpo da resposta

application/json

application/json

curl -X GET "https://example.com/channels/string/messages"
{  "data": [    {      "accepted_at": "2019-08-24T14:15:22Z",      "campaign_contact_id": "832822bb-340d-4bea-9671-a5599c7f8728",      "contact": "string",      "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407",      "created_at": "2019-08-24T14:15:22Z",      "delivered_at": "2019-08-24T14:15:22Z",      "error": "string",      "external_id": "string",      "failed_at": "2019-08-24T14:15:22Z",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "kind": "free_form",      "read_at": "2019-08-24T14:15:22Z",      "sent_at": "2019-08-24T14:15:22Z",      "status": "accepted",      "status_label": "string",      "template_name": "string"    }  ],  "page": {    "has_more": true,    "next_cursor": "string"  }}