Nexmo Conversation V2
Nexmo Conversation is an API for building and managing conversations, participants, and messaging events on the Nexmo/Vonage platform.
- Base URL:
https://api.nexmo.com/v0.2 - Auth:
bearer(pass your key via theapiKeyinput)
Operations
get_conversations— GET /conversations — List Conversationsget_events— GET /conversations/{conversation_id}/events — List Eventsget_members— GET /conversations/{conversation_id}/members — List Membersget_users— GET /users — List Users
Inputs
apiKey— your nexmo-conversation-v2 API keyoperation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: get_conversations
apiKey: <your key>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
apiKey |
string | yes | — | DEPRECATED — bind an API Key credential to the task with credentialName instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change. |
operation |
string | yes | — | One of: get_conversations, get_events, get_members, get_users |
conversation_id |
string | no | — | Path parameter conversation_id (required by some operations). |
query |
string | no | — | Query-string parameters as a JSON object string, e.g. {"limit": 50}. Parsed and url-encoded onto the request. |