Used to initiate a new dialogue with a customer by sending the first message.
Start a new conversation #
Quick start #
Quick start (cURL)
Copy to clipboard
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",
"content": "Hej! Hur kan vi hjälpa dig idag?"
}'Call #
Endpoint: /conversations
Methodology: POST
Example of call data #
filename.js
Copy to clipboard
Hello! How can we help you today?Fields for call 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.” |
| type | Message in conversation type | Yes | string | ”Carousell” |
| uniqueId | Unique ID to avoid duplicates. | No, it is not. | string | ”conversation-12345-id” |
Responsibility #
Returns the first message in the created conversation.
Example of response data #
Responsdata (JSON)
Copy to clipboard
Hi! How can we help you today?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” |
| recipient | Recipient's number | Object | ”46700123456”: { ”name”: ”Kalle” } |
| content | The first message in the conversation content | string | ”Hi! How can we help you today?” |
| type | The first message in the conversation type | string | ”Carousell” |
| 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” |
Continue conversation #
Used to send additional messages in an ongoing conversation.
Quick start #
Quick start (cURL)
Copy to clipboard
curl -X POST https://api.ip1.net/v3/conversations/65e15d14f1234547890ghijkl \
-H "Authorization: Bearer API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"content": "Här kommer informationen du bad om."}'Call #
Endpoint: /conversations/{conversation}
Methodology: GET
Example of call data #
Call (URL)
Copy to clipboard
https://api.ip1.net/v3/conversations/65e15d14f1234547890ghijklCall fields #
| Field name | Description of the project | Required | Type | Example |
| id | Conversation ID you wish to continue. | Yes | Query Parameter | 65e15d14f1234547890ghijkl |
Responsibility #
Returns details about the new message in the conversation.
Example of response data #
Responsdata (JSON)
Copy to clipboard
{
"id": "65eb3d14f1234567890abcdef",
"conversationId": "65e15d14f1234547890ghijkl",
"brand": "min-butik-ab",
"agent": "kundservice"
"recipient": "46700123456",
"content": "Hej! Hur kan vi hjälpa dig idag?",
"type": "Carousell"
"modified": "2026-03-09T08:00:05Z",
"uniqueId": "conversation-12345-id"
}Example of response data #
| Field name | Description of the project | Type | Example |
| id | New message ID | 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” |
| recipient | Recipient's number | Object | ”46700123456”: { ”name”: ”Kalle” } |
| content | The new message's content | string | ”Hi! How can we help you today?” |
| type | New message type | string | ”Carousell” |
| modified | Last modified timestamp | DateTime | ”2026-03-09T08:00:05Z” |
| uniqueId | Unique ID to avoid duplicates. | string | ”conversation-12345-id” |