Mocean connects to a Nagent workspace with an API key. Once it is connected, agents can call 6 Mocean actions, such as "Query SMS Message Status V2", "Voice Dial V2" and "Voice Download Recording V2". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Mocean, with input parameters and output schema.
MOCEAN_QUERY_MESSAGE_STATUS_V2Tool to query delivery status of an SMS message. Use after sending an SMS when you need to check its delivery success by msgid.
Input parameters
Message ID returned when the SMS was submitted
Your Mocean API key.
Your Mocean API secret.
Response format. Supported: JSON, XML. Defaults to JSON.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MOCEAN_VOICE_DIAL_V2Tool to initiate an outbound voice call via Mocean API. Use when you need to place a call with a defined command flow.
Input parameters
Recipient phone number(s) in international format without '+'; separate multiple numbers with space or comma.
Caller ID (originating number).
JSON-encoded array defining the call flow (e.g., play, say, collect, dial).
Webhook URL to receive call status events.
Response format. Only JSON is supported.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MOCEAN_VOICE_DOWNLOAD_RECORDING_V2Tool to download a call recording. Use when you need to retrieve the recording audio for a completed call by its UUID.
Input parameters
Call UUID of the recording to download.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MOCEAN_VOICE_HANGUP_V2Tool to hang up an active voice call. Use when you need to terminate an ongoing call by its call UUID immediately.
Input parameters
Your Mocean API key.
The call UUID of the active call to hang up.
Your Mocean API secret.
Response format; xml or json (default json).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MOCEAN_WHATSAPP_INCOMING_WEBHOOK_V2Tool to receive and return the full incoming WhatsApp webhook payload. Use when you must capture raw webhook JSON (message_id, event_type, event_data) for downstream parsing.
Input parameters
Complete detail payload of the incoming WhatsApp message
Type of the event, must be 'message'
Identifier for the incoming message
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MOCEAN_WHATS_APP_SEND_MESSAGE_V2Tool to send a WhatsApp message via Mocean API. Use when you need to send text, media, template, reaction, or interactive messages on WhatsApp.
Input parameters
Destination WhatsApp number, with country code.
Registered WhatsApp Business sender number, with country code (e.g., 60123456789).
Content object of the message (e.g., text, media, template, reaction, interactive).
Optional webhook URL for delivery events.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 6 Mocean actions on Nagent, including "Query SMS Message Status V2", "Voice Dial V2" and "Voice Download Recording V2". Query SMS Message Status V2: Query delivery status of an SMS message. Each action is listed on this page with its input parameters and its output.
Mocean connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Query SMS Message Status V2 takes 3 required inputs: mocean-msgid, mocean-api-key and mocean-api-secret. It also takes 1 optional input: mocean-resp-format. It returns data, error and successful.