Innan du kan skicka meddelanden behöver du sätta upp en struktur för ditt varumärke (Brand) och dina agenter.

Brands och agenter utgör den strukturella grunden för din RCS-kommunikation: ett Brand representerar företagets övergripande identitet, medan en Agent är den specifika avsändarprofil eller chattbot som interagerar med slutanvändaren.

Genom att organisera dina agenter under ett varumärke kan du hantera olika tjänster, såsom support och marknadsföring, med unika profiler men med en konsekvent visuell upplevelse för kunden.


Brands #

Quick Start #

Nedan hittar du ett exempel på hur du registrerar en Agent

💻
Quick start (cURL)
Kopiera till urklipp
curl -X POST https://api.ip1.net/brands \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"displayName": "Min Butik AB"}'

Endpoints – Brands #

Lista alla dina registrerade Brands #

Endpoint: /brands

Metod: GET

Exempel på responsdata

📋
Responsdata (JSON)
Kopiera till urklipp
{
  "brandName": "min-butik-ab",
  "displayName": "Min Butik AB",
  "created": "2026-03-04T10:00:00Z"
}

Registrera ett nytt Brand #

Endpoint: /brands

Metod: POST

Exempel på anropsdata

📋
Responsdata (JSON)
Kopiera till urklipp
{
  "displayName": "Min Butik AB"
}

Hämta detaljer kring ett specifikt Brand #

Endpoint: /brands/{brandName}

Metod: GET

Exempel på responsdata

📋
Responsdata (JSON)
Kopiera till urklipp
{
  "brandName": "min-butik-ab",
  "displayName": "Min Butik AB",
  "created": "2026-03-04T10:00:00Z"
}

Radera ett specifikt Brand #

Endpoint: /brands/{brandName}

Metod: DELETE

Exempel på responsdata

📋
Responsdata (JSON)
Kopiera till urklipp
{
  "brandName": "min-butik-ab",
  "displayName": "Min Butik AB",
  "created": "2026-03-04T10:00:00Z"
}

Fält för anropsdata #

FältnamnBeskrivningRequiredTypExempel
displayNameNamnet på agenten som syns i chattenJaString"Kundservice"

Fält för responsdata #

FältnamnBeskrivningTypExempel
brandNameSystemets interna ID/namn för brandet.String"min-butik-ab"
displayNameDet visningsnamn som angavs vid skapandet.String”Min Butik AB”
createdTidpunkt när brandet registrerades.DateTime”2026-03-04T10:00:00Z”

Agenter #

Quickstart #

💻
Quick start (cURL)
Kopiera till urklipp
curl -X POST https://api.ip1.net/brands/min-butik-ab/agents \
  -H "Authorization: Bearer DIN_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "Kundservice",
    "description": "Vi hjälper dig med dina leveransfrågor.",
    "logoUri": "https://din-doman.se/assets/logo.png",
    "heroUri": "https://din-doman.se/assets/banner.png",
    "privacyUri": "https://din-doman.se/privacy",
    "termsUri": "https://din-doman.se/terms",
    "color": "#007AFF",
    "emailAdress": "support@din-doman.se",
    "websiteUri": "https://din-doman.se"
  }'

Lista agenter kopplade till ett brand #

Endpoint: /brands/{brandName}/agents

Metod: GET

Skapa en ny agent #

Endpoint: /brands/{brandName}/agents

Metod: POST

Exempel på anropsdata

📋
Anropsdata (JSON)
Kopiera till urklipp
{
  "displayName": "Kundservice",
  "description": "Vi hjälper dig med dina frågor om leverans.",
  "logoUri": "https://din-sida.se/logo.png",
  "heroUri": "https://din-sida.se/banner.png",
  "color": "#FF5733",
  "privacyUri": "https://din-sida.se/privacy",
  "termsUri": "https://din-sida.se/terms"
}

Hämta detaljer kring en specifik agent #

Endpoint: /brands/{brandName}/agents/{name}

Metod: GET

Exempel på responsdata

📋
Responsdata (JSON)
Kopiera till urklipp
{
  "name": "kundservice",
  "brandName": "min-butik",
  "displayName": "Kundservice",
  "description": "Vi hjälper dig med dina frågor.",
  "logoUri": "https://din-sida.se/logo.png",
  "color": "#FF5733",
  "created": "2026-03-04T12:00:00Z"
}

Raderar en specifik agent #

Endpoint: /brands/{brandName}/agents/{name}

Metod: DELETE

Exempel på responsdata

📋
Responsdata (JSON)
Kopiera till urklipp
{
  "name": "kundservice",
  "brandName": "min-butik",
  "displayName": "Kundservice",
  "description": "Vi hjälper dig med dina frågor.",
  "logoUri": "https://din-sida.se/logo.png",
  "color": "#FF5733",
  "created": "2026-03-04T12:00:00Z"
}

Fält för anropsdata #

FältnamnBeskrivningRequiredTypExempel
displayNameNamnet på agenten som syns i chattenJaString"Kundservice"
descriptionEn kort beskrivning av agentens syfte.JaString”Vi hjälper dig med orderfrågor”
logoUriURL till agentens logotyp (kvadratisk).JaURI”https://cdn.se/logo.png”
heroUriURL till den stora bannerbilden i profilen.JaURI”https://cdn.se/hero.png”
colorTemafärg för chatten (Hex-kod).JaString”#FF5733”
privacyUriLänk till integritetspolicy.JaURI”https://site.se/privacy”
termsUriLänk till användarvillkor.JaURI”https://site.se/terms”
emailAdressKontaktmail för agenten.NejString”support@butik.se”

Fält för responsdata #

FältnamnBeskrivningTypExempel
nameSystemets interna ID för agenten.String"kundservice"
brandNameNamnet på brandet som agenten tillhör.String”min-butik-ab”
displayNameNamnet som visas i användarens telefon.String”Kundservice”
descriptionBeskrivningen av agenten.String”Vi hjälper dig med order.”
logoUriPublik länk till logotypen.URI”https://cdn.se/logo.png”
colorDen valda temafärgen (Hex).String”#FF5733”
createdTidpunkt när agenten skapades.DateTime”2026-03-04T12:00:00Z”