Skip to Content
1MSG
ReferenceCampaigns API

Listar membros do segmento

GET
/api/v1/campaigns/segments/{segmentId}/members

limit é o tamanho da página, padrão 50, máximo 100. cursor é o nextCursor da página anterior.

Authorization

bearer
headerAuthorizationBearer <API key>

Chave gerada em Settings → Developer → API key. Os métodos do Inbox precisam do escopo Inbox. Os métodos de Campaigns precisam do escopo Campaigns.

Path Parameters

segmentId*string

id do segmento retornado na criação ou na lista.

Query Parameters

limit?string

Tamanho da página. Padrão 50, máximo 100.

cursor?string

nextCursor da página anterior. Deixe vazio para a primeira página.

Response Body

application/json
  1. response
items*array<>

Membros desta página, os mais recentes primeiro.

nextCursor*|

Cursor da próxima página, ou null na última página.

Example Request
curl -X GET 'https://api.1msg.io/api/v1/campaigns/segments/string/members'
Example Response200
{  "items": [    {      "id": "cm3member01",      "name": "Ana",      "phone": "+15551234567",      "bsuid": "ab.abc123xyz"    }  ],  "nextCursor": null}