Mass-operationer

Dessa endpoints utför så kallade mass-operationer och kan ibland vara destruktivt eller ”farligt” då data kan försvinna om den inte används på rätt sätt.

Quick start

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

Anrop

Radera kontakter genom filtrering

Endpoint: v2/contacts

Metod: DELETE

Denna endpoint låter dig ta bort alla kontakter som matchar de använda filtren. Detta är destruktivt och bör användas med försiktighet. Den returnerar en samling av de borttagna kontakterna ungefär som att lista dem.

Exempel på anrop

Detta anrop raderar samtliga kontakter.

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

Exempel på anrop med filter

Detta anrop raderar samtliga blockerade kontakter med etiketten ”Kunder”.

https://api.ip1sms.com/v2/contacts?labels=Kunder&metadata%5BphoneNumber.isBlocked%5D=true

Respons

Exempel på respons

[
  {
    "id": "606312a5d233ab8484e18404",
    "ownerId": "ip1-XXXXX",
    "properties": {
      "phoneNumber": "+46123456789",
      "email": "icarus@example.com",
      "firstName": "Icarus",
      "lastName": "Sol",
      "department": "Sales"
    },
    "metadata": {
      "phoneNumber": {
        "isPossiblePhoneNumber": "true",
        "isValidPhoneNumber": "true",
        "phoneNumberType": "MOBILE",
        "parsedMSISDN": "46123456789",
        "isBlocked": "true"
      }
    },
    "labels": [
      "Kunder",
      "all"
    ]
  }
]

Fält för responsdata

Fältnamn Typ Beskrivning Exempel
id String Kontaktens unika ID i systemet. Används för referens vid framtida anrop (GET, PATCH, DELETE). 
606312a5d233ab8484e18404
ownerId String ID för det konto (systemanvändare) som äger och har behörighet till kontakten. 
ip1-XXXXX
properties Object En samling av kontaktens rådata såsom telefonnummer, namn och avdelning. Innehåller de fält som definierats vid skapande/uppdatering. 
{ "phoneNumber": "+46123456789", "firstName": "Icarus" }
metadata Object Systemgenererad information som validerar och berikar kontaktens egenskaper. Inkluderas endast om query-parametern ?meta används. 
{ "phoneNumber": { "isValidPhoneNumber": "true", "parsedMSISDN": "46123456789" } }
labels Array En lista av strängar som representerar de etiketter kontakten är grupperad under. 
["Kunder", "all"]

Fält för metadata

Egenskap (Metadata) Typ Beskrivning
isPossiblePhoneNumber String (Boolean) Indikerar om numret ser korrekt ut strukturellt.
isValidPhoneNumber String (Boolean) Bekräftar om numret är ett faktiskt existerande format för det aktuella landet.
phoneNumberType String Beskriver typen av abonnemang, t.ex. MOBILE, FIXED_LINE eller VOIP.
parsedMSISDN String Numret formaterat som MSISDN (utan prefix), vilket är det format systemet använder för utskick.
isBlocked String (Boolean) Visar om kontakten finns med på kontots blacklist/spärrlista.