Send RCS (Single Recipient)

Used to initiate a new dialog with a customer by sending the first message. Note: To send RCS to multiple recipients simultaneously, use the endpoint Bundles.

Start a new conversation #

Quick start #

💻

Quick start (cURL)

curl -X POST https: //api.ip1.net/v3/conversations \
  -H "Authorization: Bearer API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "brand": "Min-Butik-AB",
  "agent": "Kundservice",
  "recipient": "46700123456",
  "fallbackPolicy": "FallbackOnNoCapability,FallbackOnFailure, FallbackAfterTimeout",
  "fallbackMessage": "Detta är ett fallbackmeddelande",
  "fallbackTimeOutSeconds": 300,
  "type": "Carousel",
  "carousel": [
    {
      "title": "Sommarkampanj 2026",
      "content": "Få 20% rabatt på alla solglasögon!",
      "mediaUrl": "https://cdn.site.se/promo-sun.jpg",
      "type": "Carousel",
      "order": 0,
      "height": "Medium",
      "orientation": "Horizontal"
    },
    {
      "title": "Sommarkampanj 2026",
      "content": "Få 20% rabatt på alla solglasögon!",
      "mediaUrl": "https://cdn.site.se/promo-sun.jpg",
      "type": "Carousel",
      "order": 1
      "height": "Medium",
      "orientation": "Horizontal"
    },
  ],
  "suggestions": [
    {
      "text": "Se utbud",
      "type": "OpenUrlAction",
      "order": 0,
      "url": "https://site.se/shop",
      "postbackData": "shop_click"
    },
    {
      "text": "Ring butik",
      "type": "DialAction",
      "order": 1,
      "phoneNumber": "468123456",
      "postbackData": "call_click"
    }
  ]
}'

Call #

Endpoint: /conversations

Methodology: POST

Example of call data #

📋

filename.js

{
  "brand": "Min-Butik-AB",
  "agent": "Kundservice",
  "recipient": "46700123456",
  "fallbackPolicy": "FallbackOnNoCapability,FallbackOnFailure,FallbackAfterTimeout",
  "fallbackMessage": "Detta är ett fallbackmeddelande",
  "fallbackTimeOutSeconds": 300,
  "type": "Carousel",
  "carousel": [
    {
      "title": "Sommarkampanj 2026",
      "content": "Få 20% rabatt på alla solglasögon!",
      "mediaUrl": "https://cdn.site.se/promo-sun.jpg",
      "type": "Carousel",
      "order": 0,
      "height": "Medium",
      "orientation":
    },
    {
      "title": "Sommarkampanj 2026",
      "content": "Få 20% rabatt på alla solglasögon!",
      "mediaUrl": "https://cdn.site.se/promo-sun.jpg",
      "type": "Carousel",
      "order": 1,
      "height": "Medium",
      "orientation": "Horizontal"
    },
  ],
  "suggestions": [
    {
      "text": "Se utbud",
      "type": "OpenUrlAction",
      "order": 0,
      "url": "https://site.se/shop",
      "postbackData": "shop_click"
    },
    {
      "text": "Ring butik",
      "type": "DialAction",
      "order": 1,
      "phoneNumber": "468123456",
      "postbackData": "call_click"
    }
  ]
}

Fields for request data #

Field name	Description of the project	Required	Type	Example
brand	Your brand name	Yes	string	`"My Shop Ltd."`
agent	Your agent's name	Yes	string	”Customer service”
recipient	Recipient's number	Yes	Object	”46700123456”: { ”name”: ”Kalle” }
content	The content of the message itself	Yes (Except when using Cards)	string	”Hi {name}! Your order has now been shipped.”
fallback policy	Type of SMS fallback policy (NoFallback, FallbackOnNoCapability, FallbackOnFailure, FallbackAfterTimeout, CustomerControlledFallback).	No (Default is NoFallback)	string	”FallbackOnNoCapability,FallbackOnFailure, FallbackAfterTimeout”
fallback message	Specific message that is sent out as a fallback	Yes, when using Carousel. Cards or content are automatically generated if nothing is specified.	string	”This is a fallback message”
fallbackTimeoutSeconds	Time in seconds before the fallback policy activates (If FallbackAfterTimeOut is selected)	Yes, if the FallBackAfterTimout option is selected.	Integer	500
type	Message in conversation type	Yes	string	”Carousel”
carousel	A list of multiple cards that create a Carousel	Required if the type is ”Carousel”	Array	(See table below)
card	Contains image, headline, and text (Rich Card).	Required if the type is ”Card”	Object	(See table below)
suggestions	A list of interactive buttons.	No, it is not.	Array	(See table below)
uniqueId	Unique ID to avoid duplicates.	No, it is not.	string	”order-12345-id”

Field details `card` #

Field name	Description of the project	Required	Type	Example
title	The heading displayed at the top of the card.	Yes	string	”Spring Sale!”
content	The descriptive text on the card.	Yes	string	”We are emptying the warehouse now.”
type	Type of card (Carousel for Rich Card in carousel).	No, it is not.	Integer	”Carousel”
order	Order in which cards are shown	No, it is not.	Integer	1
Height	The height of the card	No, it is not.	String (enum)	”Medium”
width	The width of the card	No, it is not.	String (enum(	”Medium”
orientation	Location of the card	No, it is not.	String (enum)	”Horizontal”
mediaUrl	URL to image or video (public link).	No, it is not.	URI	”https://site.se/image.jpg”

Field details `suggestions` #

Field name	Description of the project	Required	Type	Example
text	The text on the button.	Yes	string	”Shop now”
type	Type of action (”OpenUrlAction”= URL, ”ShareLocationAction”= Share Location, ”ViewLocationAction”= View Location, ”DialAction”= Call), ”CreateCalendarEventAction” = Create calendar event.	Yes	Integer	”OpenUrlAction”
order	Determines the order suggestions are displayed.	No, it is not.	Integer	2
postbackData	The data you get back upon a click.	Yes	string	”track_sale_click”
URL	Target URL (required for type 2).	No, it is not.	string	”https://site.se/shop”
Title	Title for Show Location on Map and Calendar Event.	Required for the ShareLocationAction and ViewLocationAction types	string	”Our Store”
Description	Event description.	Required when creating a CreateCalendarEventAction	string	”Welcome for a haircut!”
Start Time	The start time for a calendar event.	Required when creating a CreateCalendarEventAction	string	”2026-07-01T14:30”
EndTime	The end time for a calendar event.	Required when creating a CreateCalendarEventAction	string	”2026-07-01T15:30”
Latitude	Latitude to display a location on a map.	Required when using the ViewLocationAction type	string	”58.3944347”
Longitude	The longitude to display a location on a map.	Required when using the ViewLocationAction type	string	”13.8601547,18”
PhoneNumber	The phone number being dialed when the button is pressed	Required for the DialAction type	string	”46101606060”

Responsibility #

Returns the first message in the created conversation.

Example of response data #

📋

Response data (JSON)

{
  "id": "65eb3d14f1234567890abcdef",
  "conversationId": "65e15d14f1234547890ghijkl",
  "owner": "ip1-xxxx",
  "brand": "min-butik-ab",
  "agent": "kundservice"
  "recipient": "46700123456",
  "direction": "MT",
  "type": "Carousell",
  "content": "Hej! Hur kan vi hjälpa dig idag?",
  "modified": "2026-03-09T08:00:05Z",
  "fallback": {
    "fallbackPolicy": "FallbackOnNoCapability,FallbackOnFailure",
    "fallbackMessage": "Detta är ett fallback-meddelande",
    "fallbackStatus": "Unknown"
  },
  "statuses": [
      {
      "code": 101,
      "duration": 0,
      "created": "2026-10-02T11:20:21.4129735Z"
      }
    ]
}

Fields for response data #

Field name	Description of the project	Type	Example
id	Message ID to which the current conversation belongs	string	`"65eb3d14f1234567890abcdef"`
brand	Brand's internal name.	string	”my-store-ab”
agent	The agent handling the conversation.	string	”customer service”
conversationId	The current conversation ID	string	”65e15d14f1234547890ghijkl”
owner	The account that started the conversation	string	”ip1-xxxx”
recipient	Recipient's number	Object	”46700123456”: { ”name”: ”Kalle” }
direction	If the message in the conversation is an incoming (MO) or outgoing (MT).	string	”MT”
content	The first message in the conversation's content (If the linked content is linked to a card)	string	”Hi! How can we help you today?”
type	The first message in the conversation type	string	”Carousell”
fallback	An object to collect information about Fallback.	Object	See the table below for details.
modified	Timestamp of last modification (status update, response, etc.)	DateTime	”2026-03-09T08:00:05Z”
uniqueId	Unique ID to avoid duplicates.	string	”conversation-12345-id”

Response data for the fallback object #

Field name	Description of the project	Type	Example
fallback policy	Type of SMS fallback policy (NoFallback, FallbackOnNoCapability, FallbackOnFailure, FallbackAfterTimeout, CustomerControlledFallback). Part of the Falback object.	string	”FallbackOnFailure, FallbackOnNoCapability”
fallback message	Specific message sent out when fallback is activated	string	”This is a fallback message”
fallback status	Status for fallback (Unknown, Pending, Late, Completed, Failed,)	String (enum)	”Pending”
fallback timeout	Shows how long it takes before the fallback policy takes effect. Occurs at the ”FallbackAfterTimeout” policy”	Time	00:05:00
fallback reason	A reason for the fallback was triggered.	string	”FallbackOnNoCapability”
fallbackMessageId	ID for the fallback message itself	string	”65eg3d14s1234667890obcdhf”

Continue conversation #

Used to send additional messages in an ongoing conversation.

Quick start #

💻

Quick start (cURL)

curl -X POST https://api.ip1.net/v3/conversations/65e15d14f1234547890ghijkl \
  -H "Authorization: Bearer API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"content": "Here is the information you requested."}'

Call #

Endpoint: /conversations/{conversation}

Methodology: POST

Example of call data #

🔷

Call (URL)

{
  "fallbackPolicy": "FallbackOnNoCapability,FallbackOnFailure,FallbackAfterTimeout",
  "fallbackMessage": "Detta är ett fallbackmeddelande",
  "fallbackTimeOutSeconds": 300,
  "type": "Carousel",
  "carousel": [
    {
      "title": "Sommarkampanj 2026",
      "content": "Få 20% rabatt på alla solglasögon!",
      "mediaUrl": "https://cdn.site.se/promo-sun.jpg",
      "type": "Carousel",
      "order": 0,
      "height": "Medium",
      "orientation":
    },
    {
      "title": "Sommarkampanj 2026",
      "content": "Få 20% rabatt på alla solglasögon!",
      "mediaUrl": "https://cdn.site.se/promo-sun.jpg",
      "type": "Carousel",
      "order": 1,
      "height": "Medium",
      "orientation": "Horizontal"
    },
  ],
  "suggestions": [
    {
      "text": "Se utbud",
      "type": "OpenUrlAction",
      "order": 0,
      "url": "https://site.se/shop",
      "postbackData": "shop_click"
    },
    {
      "text": "Ring butik",
      "type": "DialAction",
      "order": 1,
      "phoneNumber": "468123456",
      "postbackData": "call_click"
    }
  ]
}

Call fields #

See table for Start a conversation

Responsibility #

Returns details about the new message in the conversation.

Example of response data #

See the response data to start a new conversation

_ga	Purpose: The primary Google Analytics cookie. It is used to distinguish unique users by assigning a randomly generated number as a client identifier. It helps calculate visitor, session, and campaign data.
_ga_PWZPL9SN6X	Purpose: A Google Analytics 4 (GA4) session cookie. It is used to maintain the session state and track technical details of your visit (like session ID and timestamps) specifically for our tracking ID.

Send RCS (Single recipient)

Introduction

Bundles

Conversations

Messages

Callbacks

Troubleshooting

Start a new conversation #

Quick start #

Call #

Example of call data #

Fields for request data #

Field details `card` #

Field details `suggestions` #

Responsibility #

Example of response data #

Fields for response data #

Response data for the fallback object #

Continue conversation #

Quick start #

Call #

Example of call data #

Call fields #

Responsibility #

Example of response data #

Send RCS (Single recipient)

Start a new conversation #

Quick start #

Call #

Example of call data #

Fields for request data #

Field details card #

Field details suggestions #

Responsibility #

Example of response data #

Fields for response data #

Response data for the fallback object #

Continue conversation #

Quick start #

Call #

Example of call data #

Call fields #

Responsibility #

Example of response data #

Field details `card` #

Field details `suggestions` #