🟢List Actions

GET https://api.anunzi.net/v2/actions

Retrieve a paginated list of all available actions configured in your Anunzi environment.


Query Parameters

Parameter
Type
Required
Description

limit

int32

No

Number of actions displayed per page (default: 20).

offset

int32

No

Starting point for listing actions (default: 0).


Example Request (cURL)

curl --request GET \
     --url https://api.anunzi.net/v2/actions \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer API_KEY'

Example Response (200 OK)

{
    "status": "ok",
    "response": {
        "pagination": {
            "total_records": 103,
            "limit": 20,
            "offset": 0
        },
        "actions": [
            {
                "action_id": "1722936793779x397329270058999800",
                "action_type": "SEND_SMS",
                "name": "send_sms",
                "description": "If user wants to have a meeting next week.",
                "parameters_hard_coded": {
                    "sms_message_text": "Hello, thanks for your interest in a demo meeting. You can book your session here: Booking Link"
                }
            },
            {
                "action_id": "1722936881007x6148720204197584900",
                "action_type": "INFORMATION_EXTRACTOR",
                "name": "",
                "description": "",
                "parameters_hard_coded": {
                    "type": "",
                    "identifier": "",
                    "condition": "",
                    "choices": [],
                    "examples": []
                }
            }
        ]
    }
}

Response Fields

Field
Type
Description

total_records

int32

Total number of actions available.

limit

int32

Number of actions displayed per page.

offset

int32

Starting point of the records returned.

action_id

string

Unique identifier for the action.

action_type

string

Type of action (e.g., SEND_SMS, LIVE_TRANSFER, REAL_TIME_BOOKING).

name

string

Name of the action.

description

string

Description of what the action is expected to do.

parameters_hard_coded

object

Key-value pairs containing predefined parameters for the action.


Status Codes

Code
Description

200

Actions retrieved successfully.

400

Bad Request. Invalid or missing parameters.

Última actualización

¿Te fue útil?