Kontaktverktyg

Kompletterande endpoints ger överblick över kontaktregistret och hanterar etiketter, blockerade nummer och massradering.

Kontaktsammanfattning

Metod	Sökväg
GET	/v2/contacts/meta

curl "https://api.ip1sms.com/v2/contacts/meta" \
  -H "Authorization: Bearer $IP1_TOKEN"

{
  "totalCount": 10,
  "labels": [
    { "labelName": "all", "usageCount": 10 },
    { "labelName": "Kunder", "usageCount": 7 }
  ],
  "properties": [
    {
      "propertyName": "phoneNumber",
      "usageCount": 10,
      "averageLength": 11,
      "maxLength": 11,
      "minLength": 11
    }
  ]
}

labels summerar användning per etikett. properties innehåller propertyName, usageCount, averageLength, maxLength och minLength.

Etiketter

Metod	Sökväg	Beskrivning
POST	/v2/labels/{labelName}/contacts	Lägg etiketten på flera kontakter.
DELETE	/v2/labels/{labelName}	Ta bort etiketten från alla kontakter. Kontakterna behålls.

curl -X POST "https://api.ip1sms.com/v2/labels/Kunder/contacts" \
  -H "Authorization: Bearer $IP1_TOKEN" \
  -H "Content-Type: application/json" \
  -d '["contact_abc123", "contact_def456"]'

Svaret summerar etiketten:

{
  "labelName": "Kunder",
  "usageCount": 2
}

Spärrlista

Kontot har en spärrlista för nummer som inte ska ta emot SMS. Ett nummer kan läggas till via API, ett STOP-svar eller avregistreringsfunktionen.

Metod	Sökväg	Beskrivning
GET	/blacklist	Lista spärrade nummer.
POST	/blacklist	Lägg till en post.
GET	/blacklist/{msisdn}	Läs en post.
PUT	/blacklist/{msisdn}	Lägg till eller uppdatera.
DELETE	/blacklist/{msisdn}	Ta bort en post.

Spärrlistans endpoints tillhör en äldre, fortfarande operativ API-struktur och ligger direkt under https://api.ip1sms.com, utan /v2.

{
  "msisdn": "46700000000",
  "created": "2026-10-05T08:03:21Z"
}

Ta inte bort en spärr utan dokumenterad grund. Spärrlistan kan vara en del av verksamhetens hantering av mottagarens återkallade samtycke.

Massradering

Metod	Sökväg
DELETE	/v2/contacts

Samma filter som vid listning kan användas:

curl -X DELETE \
  "https://api.ip1sms.com/v2/contacts?labels=Kunder&metadata%5BphoneNumber.isBlocked%5D=true" \
  -H "Authorization: Bearer $IP1_TOKEN"

Ett anrop utan filter kan radera samtliga kontakter. Lägg en skyddsregel i klienten, visa antalet matchningar före körning och kräv en uttrycklig bekräftelse.

Den publicerade responsen är en samling av de borttagna kontaktdokumenten.