Sammanfattning kontakter

Quick start

Använd exemplet nedan och byt ut “API_NYCKEL” mot en bearer token som du skapar i användarportalen

curl -X GET "https://api.ip1sms.com/v2/contacts/meta" \
-H "Authorization: Bearer API_NYCKEL" \
-H "Content-Type: application/json" \

Anrop

Endpoint: v2/contacts/meta

Metod: GET

Denna endpoint tillhandahåller en summering av den kontaktdata som är lagrad i kontaktsystemet

Exempel på anrop

https://api.ip1sms.com/v2/contacts/meta

Respons

Exempel på responsdata

{
  "totalCount": 10,
  "labels": [
    {
      "labelName": "all",
      "usageCount": 10
    },
    {
      "labelName": "Customer",
      "usageCount": 7
    },
    {
      "labelName": "Coworker",
      "usageCount": 3
    }
  ],
  "properties": [
    {
      "propertyName": "email",
      "usageCount": 9,
      "averageLength": 20,
      "maxLength": 26,
      "minLength": 16
    },
    {
      "propertyName": "firstName",
      "usageCount": 10,
      "averageLength": 5,
      "maxLength": 6,
      "minLength": 3
    },
    {
      "propertyName": "lastName",
      "usageCount": 10,
      "averageLength": 7,
      "maxLength": 12,
      "minLength": 5
    },
    {
      "propertyName": "department",
      "usageCount": 10,
      "averageLength": 4,
      "maxLength": 8,
      "minLength": 3
    },
    {
      "propertyName": "phoneNumber",
      "usageCount": 10,
      "averageLength": 12,
      "maxLength": 12,
      "minLength": 12
    }
  ]
}

Fält för responsdata

Fältnamn Typ Beskrivning Exempel
totalCount Integer Det totala antalet kontakter lagrade. 

"totalCount": 10
labels Array En post för varje använd etikett. 

"labels": [
    {
      "labelName": "all",
      "usageCount": 10
    }
],
labels.labelName string Det totala antalet kontakter lagrade. 

"labelName": "Customer"
labels.usageCount Integer Det totala antalet kontakter lagrade. 

"usageCount": 7
properties Array En post för varje använd egenskap. 

"properties": [
    {
      "propertyName": "phoneNumber",
      "usageCount": 10,
      "averageLength": 12,
      "maxLength": 12,
      "minLength": 12
    }
]
properties.propertyName String Namnet/nyckeln för egenskapen. 

"propertyName": "phoneNumber"
properties.usageCount Integer Antalet kontakter som har ett värde för egenskapen. 

"usageCount": 10
properties.averageLength Integer Den genomsnittliga längden på egenskapen bland lagrade kontakter. 

"averageLength": 4
properties.maxLength Integer Det längsta värdet för egenskapen bland lagrade kontakten. 

"maxLength": 12
properties.minLength Integer Det kortaste värdet för egenskapen bland lagrade kontakten. 

"minLength": 12