REST API · v3

API Referens

En snabb överblick över resurser, metoder och endpoints. Öppna en endpoint för fullständiga fält, exempel och svar.

Bas-URL

https://api.ip1.net/v3

Autentisering

Authorization: Bearer YOUR_API_TOKEN
OpenAPI 3.1 ↧Kom igång

Introduktion

GET/phones/{msisdn}/capabilitiesKontrollera om mottagarens enhet stöder RCS

Returnerar mottagarens RCS-stöd och tillgängliga funktioner.

RESTJSONBearer auth
Öppna full guide →

Parametrar

NamnPlatsKravBeskrivning
msisdnpathJaMottagarens nummer i internationellt format.
AnropGET
curl -X GET "https://api.ip1.net/v3/phones/{msisdn}/capabilities" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
Svarsexempel200
{
  "rcs": true,
  "features": [
    "CARD",
    "CAROUSEL",
    "SUGGESTIONS"
  ]
}

Statuskoder

200Capabilities
400Invalid request
401Missing or invalid API token

Brands & agenter

GET/brandsLista registrerade varumärken

Listar varumärken som tillhör kontot.

RESTJSONBearer auth
Öppna full guide →
AnropGET
curl -X GET "https://api.ip1.net/v3/brands" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
Svarsexempel200
[
  {
    "name": "ip1-demo",
    "displayName": "iP1 Demo"
  }
]

Statuskoder

200Brands
400Invalid request
401Missing or invalid API token
POST/brandsRegistrera ett varumärke

Registrerar ett nytt RCS-varumärke.

RESTJSONBearer auth
Öppna full guide →
AnropPOST
curl -X POST "https://api.ip1.net/v3/brands" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
  -H "Content-Type: application/json" \
  -d '{
  "name": "min-butik-ab",
  "displayName": "Min Butik AB"
}'
Svarsexempel201
{
  "name": "min-butik-ab",
  "displayName": "Min Butik AB"
}

Statuskoder

201Brand created
400Invalid request
401Missing or invalid API token
GET/brands/{brandName}/agentsLista agenter för ett varumärke

Listar avsändarprofiler för ett varumärke.

RESTJSONBearer auth
Öppna full guide →

Parametrar

NamnPlatsKravBeskrivning
brandNamepathJaUnikt namn för varumärket.
AnropGET
curl -X GET "https://api.ip1.net/v3/brands/{brandName}/agents" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
Svarsexempel200
[
  {
    "name": "support",
    "displayName": "Support",
    "status": "VERIFIED"
  }
]

Statuskoder

200Agents
400Invalid request
401Missing or invalid API token
POST/brands/{brandName}/agentsSkapa en agent

Skapar en avsändarprofil under ett varumärke.

RESTJSONBearer auth
Öppna full guide →

Parametrar

NamnPlatsKravBeskrivning
brandNamepathJaUnikt namn för varumärket.
AnropPOST
curl -X POST "https://api.ip1.net/v3/brands/{brandName}/agents" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
  -H "Content-Type: application/json" \
  -d '{
  "name": "support",
  "displayName": "Support"
}'
Svarsexempel201
{
  "name": "support",
  "displayName": "Support",
  "status": "PENDING"
}

Statuskoder

201Agent created
400Invalid request
401Missing or invalid API token

Bundles

GET/bundlesLista utskick till flera mottagare

Returnerar tidigare bundle-utskick och deras status.

RESTJSONBearer auth
Öppna full guide →

Parametrar

NamnPlatsKravBeskrivning
tagquery—Valfri kampanjtagg.
AnropGET
curl -X GET "https://api.ip1.net/v3/bundles" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
Svarsexempel200
[
  {
    "id": "bnd_01JRC5N8",
    "status": "ACCEPTED"
  }
]

Statuskoder

200Bundles
400Invalid request
401Missing or invalid API token
POST/bundlesSkicka RCS till flera mottagare

Skickar samma RCS-innehåll till flera mottagare.

RESTJSONBearer auth
Öppna full guide →
AnropPOST
curl -X POST "https://api.ip1.net/v3/bundles" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
  -H "Content-Type: application/json" \
  -d '{
  "brand": "ip1-demo",
  "agent": "support",
  "recipients": {
    "46700123456": {},
    "46700987654": {}
  },
  "type": "Text",
  "content": "Hello from RCS"
}'
Svarsexempel202
{
  "id": "bnd_01JRC5N8",
  "status": "ACCEPTED"
}

Statuskoder

202Bundle accepted
400Invalid request
401Missing or invalid API token

Konversationer

GET/conversationsLista konversationer

Returnerar pågående och avslutade RCS-konversationer.

RESTJSONBearer auth
Öppna full guide →
AnropGET
curl -X GET "https://api.ip1.net/v3/conversations" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
Svarsexempel200
[
  {
    "id": "cnv_01JRC5N8",
    "agent": "support",
    "recipient": "46700123456",
    "status": "ACTIVE"
  }
]

Statuskoder

200Conversations
400Invalid request
401Missing or invalid API token
POST/conversationsStarta en konversation

Startar en ny RCS-konversation med en mottagare.

RESTJSONBearer auth
Öppna full guide →
AnropPOST
curl -X POST "https://api.ip1.net/v3/conversations" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
  -H "Content-Type: application/json" \
  -d '{
  "brand": "ip1-demo",
  "agent": "iP1 Demo",
  "recipient": "46700123456",
  "type": "Card",
  "card": {
    "title": "Skapa rikare kunddialoger",
    "content": "Skicka högupplösta bilder, video och interaktiva val direkt i meddelandeappen.",
    "mediaUrl": "/media/2026-09-rcs-high-definition-media.webp",
    "height": "Medium",
    "orientation": "Vertical"
  },
  "suggestions": [
    {
      "text": "Utforska RCS",
      "type": "OpenUrlAction",
      "url": "https://rcs-api.com/guide/",
      "postbackData": "explore=rcs"
    },
    {
      "text": "Kontakta oss",
      "type": "Reply",
      "postbackData": "contact=sales"
    }
  ]
}'
Svarsexempel201
{
  "id": "cnv_01JRC5N8",
  "status": "ACCEPTED"
}

Statuskoder

201Conversation created
400Invalid request
401Missing or invalid API token

Meddelanden

GET/bundles/{bundle}/messagesLista meddelanden i en bundle

Returnerar enskilda meddelanden och leveransstatus i en bundle.

RESTJSONBearer auth
Öppna full guide →

Parametrar

NamnPlatsKravBeskrivning
bundlepathJaBundle-identifierare.
AnropGET
curl -X GET "https://api.ip1.net/v3/bundles/{bundle}/messages" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
Svarsexempel200
[
  {
    "id": "msg_01JRC5N8",
    "recipient": "46700123456",
    "status": "DELIVERED"
  }
]

Statuskoder

200Messages
400Invalid request
401Missing or invalid API token
GET/messages/{messageId}/cardsHämta cards för ett meddelande

Returnerar rich cards som hör till ett meddelande.

RESTJSONBearer auth
Öppna full guide →

Parametrar

NamnPlatsKravBeskrivning
messageIdpathJaMeddelande-identifierare.
AnropGET
curl -X GET "https://api.ip1.net/v3/messages/{messageId}/cards" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
Svarsexempel200
[
  {
    "title": "Skapa rikare kunddialoger",
    "content": "Skicka högupplösta bilder, video och interaktiva val direkt i meddelandeappen.",
    "mediaUrl": "/media/2026-09-rcs-high-definition-media.webp",
    "height": "Medium",
    "orientation": "Vertical"
  }
]

Statuskoder

200Cards
400Invalid request
401Missing or invalid API token
GET/messages/{messageId}/suggestionsHämta förslag och knappar

Returnerar föreslagna svar och åtgärder.

RESTJSONBearer auth
Öppna full guide →

Parametrar

NamnPlatsKravBeskrivning
messageIdpathJaMeddelande-identifierare.
AnropGET
curl -X GET "https://api.ip1.net/v3/messages/{messageId}/suggestions" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
Svarsexempel200
[
  {
    "text": "Open website",
    "type": "OpenUrlAction",
    "url": "https://example.com"
  }
]

Statuskoder

200Suggestions
400Invalid request
401Missing or invalid API token
⌘ K

Cookieinställningar

Vi använder nödvändiga cookies för webbplatsens funktion. Firebase Analytics aktiveras endast om du godkänner analys.