1MSG
ReferenceInbox API

Contatos do Inbox para copiar em um segmento de campanha

GET
/api/v1/inbox/contacts

Somente leitura. Retorna nome, telefone, bsuid e username. Não envia mensagens.

Authorization

bearer
headerAuthorizationBearer <token>

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.

Query Parameters

status?string
Value in"OPEN""CLOSED"
assignee?string

id do usuário responsável pela conversa

lastMessageFrom?string

Limite inferior, inclusivo, da hora da última mensagem em ISO-8601

lastMessageTo?string

Limite superior, inclusivo, da hora da última mensagem em ISO-8601

fields?string

Campos desejados, separados por vírgula: name, phone, bsuid, username

limit?number

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

Default50
cursor?string

Cursor de página retornado na resposta anterior. Deixe vazio para a primeira página.

Response Body

application/json
  1. response
items*array<>
nextCursor*string|null
curl -X GET 'https://api.1msg.io/api/v1/inbox/contacts'
{  "items": [    {      "name": "string",      "phone": "string",      "bsuid": "string",      "username": "string"    }  ],  "nextCursor": "string"}