Ir para o conteúdo

Listas de contactos

Crie uma lista de contatos

Para criar uma lista de contatos, você precisa executar o método POST /address-book-api/contact-groups, passando parâmetros no corpo com a indicação dados de autorização no cabeçalho.

Parâmetros de solicitação

Parâmetro Tipo de dados Descrição e valores permitidos
fields array[object] Matriz de campos da lista de contatos
displayName string Nome do campo, que será exibido em sua conta pessoal
name string Nome do campo
type integer Tipo de campo. Valores possíveis:
0 - data/hora,
1 - true/false,
2 - número,
3 - texto,
5 - objeto,
8 - data
values array[string] Uma matriz de valores de campo possíveis, se houver (por exemplo: ["gender.male", "gender.female"])
name string Nome da lista de contatos
type string Tipo de lista de contatos. Valores possíveis:
STANDARD - lista regular,
STOPLIST - uma lista para a qual os contatos não precisam ser enviados

Solicitar exemplo

```json tab="JSON" POST /address-book-api/contact-groups Authorization: Key QWxhZGRpbjpvcGVuIHNlc2FtZQ== Content-Type: application/json Accept: application/json { "fields": [ { "displayName": "Apelido", "name": "nickname", "type": 3 }, { "displayName": "Carro", "name": "auto", "type": 3 } ], "name": "TestList", "type": "STANDARD" }

### Resposta exemplo

```json tab="JSON"
{
  "result": "3576515602081985000"
}

Parâmetros de resposta

Parâmetro Tipo de dados Descrição e valores permitidos
result string Identificador da lista de contatos

Carregando contatos para a lista

Para carregar os contatos na lista, você precisa executar o método POST /address-book-api/contacts/batch, passando parâmetros no corpo com a indicação dados de autorização no cabeçalho.

Parâmetros de solicitação

Parâmetro Tipo de dados Descrição e valores permitidos
zoneOffset integer Deslocamento de tempo para contato de UTC + 0 (em minutos)
contactGroupId integer Identificador da lista de contatos
contacts array[object] Matriz de contatos
email string Email de contato
fields array[object] Matriz de campos de contato
displayName string Nome do campo, que será exibido em sua conta pessoal
name string Nome do campo
type integer Tipo de campo. Valores possíveis:
0 - data/hora,
1 - true/false,
2 - número,
3 - texto,
5 - objeto,
8 - data
value array[string] Valor do campo
phone string Telefone para contato
duplicateCheckField integer Verifique se há dados de contato duplicados. Valores possíveis:
null - não verifique,
phone - telefone,
email - email

Solicitar exemplo

```json tab="JSON" POST /address-book-api/contacts/batch Authorization: Key QWxhZGRpbjpvcGVuIHNlc2FtZQ== Content-Type: application/json Accept: application/json { "contactGroupId": 3576505602081984000, "contacts": [ { "email": "valya@yandex.ru", "fields": [ { "displayName": "Apelido", "name": "nickname", "type": 3 }, { "displayName": "Carro", "name": "auto", "type": 3 } ], "phone": "79100000000" } ], "duplicateCheckField": "phone" }

### Resposta exemplo

```json tab="JSON"
{
  "result": [
    {
      "code": "OK",
      "result": {
        "contactId": "31a24ce55d4a8e00-31a251fea18b9280"
      }
    }
  ]
}

Parâmetros de resposta

Parâmetro Tipo de dados Descrição e valores permitidos
result array[object] Matriz de dados de resposta
code string Código de resposta
result object Matriz de contatos criados
contactId string Identificador do contato criado

Recuperando todas as listas de contatos

Para obter todas as listas de contatos, você precisa executar o método GET /address-book-api/contact-groups, passando parâmetros no corpo com a indicação dados de autorização no cabeçalho.

Parâmetros de solicitação

Parâmetro Tipo de dados Descrição e valores permitidos
name string Nome da lista de contatos (pesquisa por entrada)
from string Data de início da pesquisa data de início da criação da lista de contatos
limit integer Número de linhas para exibir em resposta
offset integer De qual linha produzir a resposta (deslocamento)
to string Data de término da pesquisa data de criação da lista de contatos
type array[string] Matriz de tipos de lista de contatos. Valores possíveis:
STANDARD - lista regular,
STOPLIST - uma lista para a qual os contatos não precisam ser enviados
zoneOffset integer Deslocamento de tempo para contato de UTC + 0 (em minutos)

Solicitar exemplo

```json tab="JSON" GET /address-book-api/contact-groups Authorization: Key QWxhZGRpbjpvcGVuIHNlc2FtZQ== Content-Type: application/json Accept: application/json { "name":"Test", "from":"2020-10-01 00:00:00", "limit":10, "offset":0, "to":"2020-11-01 00:00:00", "type":"STANDARD", "zoneOffset":180 }

### Resposta exemplo

```json tab="JSON"
{
  "result": [
    {
      "contactGroupId": "3576515602081985000",
      "companyId": 112233,
      "name": "TestList",
      "creationDate": "2020-10-20T08:16:31",
      "lastUpdate": "2020-10-20T09:01:05",
      "fields": [
        {
          "name": "name",
          "displayName": "Nome",
          "type": 3,
          "isDefault": true
        },
        {
          "name": "surname",
          "displayName": "Sobrenome",
          "type": 3,
          "isDefault": true
        },
        {
          "name": "gender",
          "displayName": "Feminino ou Masculino",
          "type": 3,
          "isDefault": true,
          "values": [
            "gender.male",
            "gender.female"
          ]
        },
        {
          "name": "country",
          "displayName": "Um país",
          "type": 3,
          "isDefault": true
        },
        {
          "name": "city",
          "displayName": "Cidade",
          "type": 3,
          "isDefault": true
        },
        {
          "name": "birthdate",
          "displayName": "Data de nascimento",
          "type": 8,
          "isDefault": true
        },
        {
          "name": "timezone",
          "displayName": "Fuso horário",
          "type": 2,
          "value": "180",
          "isDefault": true
        },
        {
          "name": "nickname",
          "displayName": "Apelido",
          "type": 3,
          "value": "null",
          "isDefault": false
        },
        {
          "name": "auto",
          "displayName": "Carro",
          "type": 3,
          "value": "null",
          "isDefault": false
        }      
      ],
      "contactsCount": "1",
      "segmentsCount": "0",
      "type": "STANDARD"
    }
  ]
}

Parâmetros de resposta

Parâmetro Tipo de dados Descrição e valores permitidos
result array[string] Matriz de listas de contato
companyId integer Identificador da empresa
contactGroupId string Identificador da lista de contatos
contactsCount integer Número de contatos na lista
creationDate string Data em que a lista de contatos foi criada
fields array[object] Matriz de campos de contato na lista
displayName string Nome do campo, que será exibido em sua conta pessoal
name string Nome do campo
type integer Tipo de campo. Valores possíveis:
0 - data/hora,
1 - true/false,
2 - número,
3 - texto,
5 - objeto,
8 - data
values array[string] Uma matriz de valores de campo possíveis, se houver (por exemplo: ["gender.male", "gender.female"])
isDefault boolean Se o campo é exibido por padrão
lastUpdate string Data da última modificação da lista de contatos
name string Nome da lista de contatos
segmentsCount integer Número de segmentos na lista
type string Tipo de lista de contatos. Valores possíveis:
STANDARD - lista regular,
STOPLIST - uma lista para a qual os contatos não precisam ser enviados

Recuperando todos os contatos de uma lista específica

Para obter todos os contatos de uma lista específica, você precisa executar o método GET /address-book-api/contacts/http/range, passando parâmetros no corpo com a indicação dados de autorização no cabeçalho.

Parâmetros de solicitação

Parâmetro Tipo de dados Descrição e valores permitidos
contactGroupId string Identificador da lista de contatos
descOrder boolean A ordem de classificação. Valores possíveis:
asc - false,
desc - true
limit integer Número de linhas para exibir em resposta
offset integer De qual linha produzir a resposta (deslocamento)
queryName string Campo de filtro
queryOperator string Operador de filtro. Valores possíveis:
ex - EXISTS
eq - EQUALS
neq - NOT_EQUALS
gt - GREATER_THEN
lt - LESS_THAN
ngt - NOT_GREATER_THAN
nlt - NOT_LESS_THAN
inc - CONTAINS
ninc - NOT_CONTAINS
sw - STARTS_WITH
ew - ENDS_WITH
nsw - NOT_STARTS_WITH
new - NOT_ENDS_WITH
range - RANGE
nrange - NOT_IN_RANGE
ma - MATCHES
nma - NOT_MATCHES
queryValue string Valor do filtro
segmentId string Identificador do segmento
sortByField string O campo pelo qual classificar
zoneOffset integer Deslocamento de tempo para contato de UTC + 0 (em minutos)

Solicitar exemplo

```json tab="JSON" GET /address-book-api/contacts/http/range Authorization: Key QWxhZGRpbjpvcGVuIHNlc2FtZQ== Content-Type: application/json Accept: application/json { "contactGroupId":"3576515602081985000", "descOrder":true, "limit":10, "offset":0, "queryName":"email", "queryOperator":"eq", "queryValue":"valya", "sortByField":"contactId", "zoneOffset":180 }

### Resposta exemplo

```json tab="JSON"
{
  "result": [
    {
      "contactId": "31a24ce55d4a8e00-31a251fea18b9280",
      "companyId": 112233,
      "contactGroupId": "3576515602081985000",
      "creationDate": "2020-10-20 09:01:05",
      "lastUpdate": "2020-10-20 09:01:05",
      "phone": "79100000000",
      "email": "valya@yandex.ru",
      "unsubscribedData": [
        {
          "companyId": 112233,
          "data": "valya@yandex.ru",
          "dataType": "EMAIL",
          "channelList": [
            {
              "channel": "EMAIL",
              "unsubscribedAt": "2020-10-21 08:13:55"
            }
          ],
          "updatedAt": "2020-10-21 08:13:55"
        }
      ],      
      "fields": [
        {
          "name": "name",
          "displayName": "Nome",
          "type": 3,
          "isDefault": true
        },
        {
          "name": "surname",
          "displayName": "Sobrenome",
          "type": 3,
          "isDefault": true
        },
        {
          "name": "gender",
          "displayName": "Feminino ou Masculino",
          "type": 3,
          "isDefault": true,
          "values": [
            "gender.male",
            "gender.female"
          ]
        },
        {
          "name": "country",
          "displayName": "Um país",
          "type": 3,
          "isDefault": true
        },
        {
          "name": "city",
          "displayName": "Cidade",
          "type": 3,
          "isDefault": true
        },
        {
          "name": "birthdate",
          "displayName": "Data de nascimento",
          "type": 8,
          "isDefault": true
        },
        {
          "name": "timezone",
          "displayName": "Fuso horário",
          "type": 2,
          "value": "180",
          "isDefault": true
        },
        {
          "name": "nickname",
          "displayName": "Apelido",
          "type": 3,
          "value": "null",
          "isDefault": false
        },
        {
          "name": "auto",
          "displayName": "Carro",
          "type": 3,
          "value": "null",
          "isDefault": false
        }
      ]
    }
  ]
}

Parâmetros de resposta

Parâmetro Tipo de dados Descrição e valores permitidos
result array[string] Matriz de contatos
companyId integer Identificador da empresa
contactGroupId integer Identificador da lista de contatos
contactId string Identificador de contato
creationDate string Data em que o contato foi criado
email string Email de contato
fields array[object] Matriz de campos de contato na lista
displayName string Nome do campo, que será exibido em sua conta pessoal
name string Nome do campo
type integer Tipo de campo. Valores possíveis:
0 - data/hora,
1 - true/false,
2 - número,
3 - texto,
5 - objeto,
8 - data
value object Valor do campo
values array[string] Uma matriz de valores de campo possíveis, se houver (por exemplo: ["gender.male", "gender.female"])
isDefault boolean Se o campo é exibido por padrão
lastUpdate string Data da última modificação da lista de contatos
phone string Telefone para contato
unsubscribedData array[object] Dados de cancelamento de assinatura de contato
channelList array[object] Dados de canal de cancelamento de inscrição. Matriz do formulário:
channel - cancelar canal
unsubscribedAt - data de cancelamento de inscrição
unsubscribedType - tipo de cancelamento de inscrição
companyId integer Identificador da empresa
data string Dados de cancelamento de inscrição (telefone ou e-mail)
dataType string Cancelar inscrição de canal
updatedAt string Data da última alteração de cancelamento de inscrição