Get Flow Assets by Flow ID

GET Method

Kaleyra platform's Get Flow Assets by Flow ID API allows you to get all assets attached to a specified Flow. You can view asset details, such as asset_type, download_url, name, and paginating details before and after cursors.

Prerequisites

Before you get started, Create an API Key. To view the API Key and the SID, see View API Key and SID.
A prerequisite for using Kaleyra WhatsApp APIs is to have an active WhatsApp plan on Kaleyra platform.
To set up a WhatsApp account on Kaleyra platform, see Manual Signup
and Embedded Signup.
An active WhatsApp for Business API plan that includes:
- A WhatsApp business number.
- An associated profile with the business number.
- A WhatsApp verified and approved profile.
- A WABA ID onboarded on Kaleyra WhatsApp API V2.

Base URL

https://<api_domain>/v2/<SID>

API Domain and Value

api_domain	Value
IN pod	api.in.kaleyra.io
SG Pod	api.kaleyra.io
EU Pod	api.eu.kaleyra.io
NA pod	api.na.kaleyra.ai

API request to get flow assets by flow ID

To get Flows details by Flow ID, use the following endpoint with the request method: https://<api_domain>/v2/<sid>/whatsapp/<flow_id>/assets.

Request Format

The following is the request format to get flow assets by flow ID:

curl --location --request GET 'http://<api_domain>/v2/<sid>/whatsapp/<flow_id>/assets' \
--header 'api-key: <api-key>' \
--header 'Content-Type: <Contet-Type>'

Sample Request Format

The following is the sample request format to get flow assets by flow ID:

curl --location --request GET 'https://api.in.kaleyra.io/v2/HXAP16XXXXXX97IN/whatsapp/11576XXXXXXXXXX0' \
--header 'api-key: Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx3'\
--header 'Content-Type: application/json'

URL Parameters and Headers

Following is the list of parameters and headers to get flow assets by flow ID:

Parameter / Headers	Data Type	Description	Example	Mandatory?
`sid`	String	Account SID (Security Identifier).	HXAP16XXXXXX97IN	Yes
`flow_id`	String	The unique ID for each flow.	11576XXXXXXXXXX0	Yes
`api-key`	String	API key generated from Kaleyra account.	Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx3	Yes
`Content-Type`	String	Indicates the format of the content the API will be processing.	The only allowed value is application/json.	Yes

📘
Note:
Assets are all the files and resources associated with a specific Flow. This API helps in backing up the flow and reviewing its structure. This also helps in accessing the flow JSON to troubleshoot any issues and downloading the current assets before making any updates.

Sample Success Response

The following success message appears with the status 200 Accepted:

{
    "data": [
        {
            "asset_type": "FLOW_JSON",
            "download_url": "https://mmg.whatsapp.net/m1/v/t24/An_5xxxK_cwxxxxxxe4-p7xxxxxx8ks-rxxxxxxxiGg?ccb=10-5&oh=01_Q5xxxxxxxxxxno&oe=67xxxxD5&_nc_sid=471a72",
            "name": "flow.json"
        }
    ],
    "paging": {
        "cursors": {
            "after": "QVFS3dxxxxxxxxxxxxxxxxxxOLWNB",
            "before": "QVFIxxxxxxxxxxxxxxxxxxxOLWNB"
        }
    }
}

Sample Failure Response

The following are the failure responses:

401 Unauthorized
{
    "code": "RBC001",
    "message": "Incorrect SID or API key.",
    "data": [],
    "error": {
        "error": "Incorrect SID or API key."
    }
}

400 Incorrect payload
{
    "code": "WA-400",
    "message": "Refer to correct payload format",
    "data": {},
    "error": {
        "payload": "Incorrect payload format"
    }
}

500 Internal Server Error
{
    "code": "WA-500",
    "message": "Please try again later",
    "data": {},
    "error": {
        "error": "Internal server error"
    }
}

Updated 13 days ago