Please note that cards are created as part of a message via /bundles or /conversations, but you can retrieve details about them afterwards via these endpoints.
Get all cards for a message #
⚡Quick start #
Quick start (cURL)
Copy
curl -X GET https://api.ip1.net/v3/messages/msg-12345/cards \
-H "Authorization: Bearer DIN_API_TOKEN"Call #
Endpoint: /messages/{messageId}/cards
Method: GET
Example of call data #
This call requires no body. The message ID is sent in the URL.
Call data (URL)
Copy
https://api.ip1.net/v3/messages/65eb3d14f1234567890abcdef/cardsFields for request data #
| Field name | Description of the project | Required | Type | Example |
|---|---|---|---|---|
| messageId | ID of the message for which you want to list cards | Yes | Query Parameter | 65eb3d14f1234567890abcdef |
Responsibility #
Returns a list of cards included in the message (e.g., a single card or multiple in a carousel).
Example of response data #
Response data (JSON)
Copy
[
{
"id": "65eb3d14f1234567890a1b2c3d4",
"messageId": "msg-12345",
"type": "Standalone",
"order": 0,
"title": "VĂĄr stora sommarrea!",
"content": "Klicka nedan för att se alla fantastiska erbjudanden.",
"mediaUrl": "https://cdn.site.se/summer-sale.jpg",
"height": "Medium",
"width": 1,
"orientation": "Horizontal",
"suggestions": [
{
"text": "Se rean",
"type": "OpenUrlAction",
"url": "https://site.se/rea"
}
]
}
]Fields for response data #
| Field name | Description of the project | Type | Example |
|---|---|---|---|
| id | Unique card ID. | string | 65eb3d14f1234567890a1b2c3d4 |
| messageId | Message ID the card belongs to. | string | 65eb3d14f784682890abc24f |
| type | Type of card. | String (enum) | ”Standalone” |
| order | The position of the card. | Integer | 0 |
| title | Card title (max 100 characters). | string | ”Our big summer sale!” |
| content | The descriptive text (max 2000 characters). | string | ”Click below...” |
| mediaUrl | URL to image or video. | URI | ”https://cdn.se/bild.jpg” |
| Height | Height (1=Small, 2=Medium, 3=Large). | String (enum) | ”Medium” |
| width | Width (1=Small, 2=Large). | String (enum) | ”Large” |
| orientation | Orientation (1=Horizontal, 2=Vertical). | String (enum) | ”Horizontal” |
| suggestions | A list of buttons connected directly to the card. | Array | […] |
Get suggestions for a specific card #
If you want to retrieve only the buttons (suggestions) belonging to a specific card in a message.
⚡Quick start #
Quick Start (cURL)
Copy
curl -X GET https://api.ip1.net/v3/messages/msg-123/cards/card-888/suggestions \
-H "Authorization: Bearer DIN_API_TOKEN"Call #
Endpoint: /messages/{messageId}/cards/{cardId}/suggestions
Methodology: GET
Example of call data #
This call requires no body. The message ID is sent in the URL.
Call data (URL)
Copy
https://api.ip1.net/v3/messages/65eb3d14f784682890abc24f/cards/65eb3d14f1234567890a1b2c3d4/suggestionsFields for request data #
| Field name | Description of the project | Required | Type | Example |
|---|---|---|---|---|
| messageId | Message ID. | Yes | Query Parameter | 65eb3d14f1234567890abcdefHello. |
| cardId | Unique card ID. | Yes | Query Parameter | 65eb3d14f1234567890a1b2c3d4 |
Responsibility #
Returns a list of all suggestions/buttons for the selected card
Example of response data #
Response data (JSON)
Copy
[
{
"id": "65eb3d14f1234567890a1e2f3dg",
"messageId": "65eb3d14f1234567890abcdef",
"cardId": "65eb3d14f1234567890a1b2c3d4",
"type": "DialAction",
"order": 0,
"text": "Call us now",
"postbackData": "call_clicked",
"phoneNumber": "+468123456"
}
]Fields for response data #
| Field name | Description of the project | Type | Example |
| id | Suggestion/button ID. | string | 65eb3d14f1234567890abcdefHello. |
| messageId | Message ID | string | 65eb3d14f1234567890abcdef |
| cardId | Unique ID for the card that the suggestion/button belongs to. | string | 65eb3d14f1234567890a1b2c3d4 |
| type | Type of suggestion/button | string | ”DialAction” |
| order | Button layout on the card. | Integer | 0 |
| text | The text on the Suggestion/button. | string | ”Call us” |
| postbackData | The code that is sent to your webhook on click. | string | ”call_button_clicked” |
| phone number | Phone number (Tied to type 4) | string | ”46101606060” |
Do you want to know more? #
Read our Rich Cards guide to learn about best practices and code examples.