Listar os contatos de uma campanha
Os contatos na ordem da lista, com o estado, as tentativas feitas e a próxima prevista. Paginado de verdade: a lista inteira chega página a página, sem o corte silencioso em 200 da v2.
Autorização
bearer campaigns:readCredencial 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: campaigns:read
Parâmetros de caminho
Id da campanha
Parâmetros de consulta
O estado de um contato. A voz usa calling; o texto, sending e
delivered. Terminais: answered, delivered, completed, failed,
cancelled e not_answered.
Valor em
- "pending"
- "scheduled"
- "calling"
- "sending"
- "delivered"
- "answered"
- "not_answered"
- "retry_scheduled"
- "failed"
- "completed"
- "cancelled"
Cursor opaco devolvido em page.next_cursor da página anterior. Omita para começar do início.
Tamanho da página. Padrão 50; o máximo é o da coleção: 200, ou até 500 nas coleções de itens pequenos.
int320 <= valueCorpo da resposta
application/json
application/json
curl -X GET "https://example.com/campaigns/string/contacts"{ "data": [ { "attempt_count": 0, "contact_name": "string", "custom_fields": {}, "destination_number": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "last_attempt_at": "2019-08-24T14:15:22Z", "last_error": "string", "max_attempts": 0, "next_attempt_at": "2019-08-24T14:15:22Z", "row_index": 0, "status": "pending" } ], "page": { "has_more": true, "next_cursor": "string" }}