Kontakter

Kontakt-API:et lagrar egenskaper, etiketter och validerad metadata. Samlings-endpoints är paginerade.

Endpoints

Metod	Sökväg	Beskrivning
GET	/v2/contacts	Lista och filtrera kontakter.
GET	/v2/contacts/{contactId}	Läs en kontakt.
POST	/v2/contacts	Importera en lista med kontakter.
PATCH	/v2/contacts/{contactId}	Uppdatera angivna fält.
PUT	/v2/contacts/{contactId}	Ersätt kontaktens data.
DELETE	/v2/contacts/{contactId}	Radera en kontakt.

Lista och filtrera

curl "https://api.ip1sms.com/v2/contacts?meta&labels=Kunder&start=0&limit=50" \
  -H "Authorization: Bearer $IP1_TOKEN" \
  -H "Accept: application/json"

Samlingen kan filtreras på:

• labels
• properties[egenskap]
• metadata[egenskap]

Metadata inkluderas bara när query-parametern meta anges.

/v2/contacts?labels=Kunder
&properties[phoneNumber]=46700000000
&metadata[phoneNumber.isBlocked]=false
&meta

URL-koda hakparenteser och värden i en riktig klient.

Läs en kontakt

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

Importera kontakter

POST /v2/contacts tar en array med kontaktdokument. Importen behandlas normalt asynkront. Lägg till ?sync för direkt behandling av små samlingar; den publicerade rekommendationen begränsar synkron import till färre än 1 000 kontakter.

curl -X POST "https://api.ip1sms.com/v2/contacts" \
  -H "Authorization: Bearer $IP1_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "properties": {
        "phoneNumber": "46700000000",
        "email": "kontakt@example.com",
        "firstName": "Test"
      },
      "labels": ["Kunder"]
    }
  ]'

Fält	Krävs	Typ	Beskrivning
properties	Ja	object	Kontaktdata, exempelvis phoneNumber, firstName och email.
labels	Nej	string[]	Grupper eller kategorier.

Uppdatera en kontakt

Använd PATCH för en delvis uppdatering. Angivna null-värden tas enligt den publicerade dokumentationen bort. Använd PUT när hela dokumentet ska ersättas.

curl -X PATCH "https://api.ip1sms.com/v2/contacts/{contactId}" \
  -H "Authorization: Bearer $IP1_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "properties": { "firstName": "Uppdaterat namn" },
    "labels": ["Kunder", "Aktiva"]
  }'

Radera en kontakt

curl -X DELETE "https://api.ip1sms.com/v2/contacts/{contactId}" \
  -H "Authorization: Bearer $IP1_TOKEN"

För filterbaserad massradering, se Kontaktverktyg.

Kontaktdokument

{
  "id": "contact_abc123",
  "ownerId": "ip1-XXXXX",
  "properties": {
    "phoneNumber": "46700000000",
    "email": "kontakt@example.com",
    "firstName": "Test",
    "department": "Support"
  },
  "metadata": {
    "phoneNumber": {
      "isPossiblePhoneNumber": "true",
      "isValidPhoneNumber": "true",
      "phoneNumberType": "MOBILE",
      "parsedMSISDN": "46700000000",
      "isBlocked": "false"
    }
  },
  "labels": ["Kunder", "all"]
}

Metadatafält	Typ	Beskrivning
isPossiblePhoneNumber	strängrepresenterad boolean	Numret ser strukturellt möjligt ut.
isValidPhoneNumber	strängrepresenterad boolean	Numret har ett giltigt format för landet.
phoneNumberType	string	Exempelvis MOBILE, FIXED_LINE eller VOIP.
parsedMSISDN	string	Normaliserat MSISDN.
isBlocked	strängrepresenterad boolean	Numret finns i kontots spärrlista.

Metadatafältens booleanvärden visas som strängar i den publicerade API-referensen. Typa klienten efter den faktiska responsen och undvik att göra "false" till ett sant booleanvärde av misstag.