Nexmo

Conversation API: Conversation v2

The Conversation API enables you to build conversation features where communication can take place across multiple mediums including IP Messaging, PSTN Voice,…

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Conversation API enables you to build conversation features where communication can take place across multiple mediums including IP Messaging, PSTN Voice, SMS and WebRTC Audio and Video. The context of the conversations is maintained though each communication event taking place within a conversation, no matter the medium.

Endpoints 4

conversation

  • GETList Conversations/conversations?page_size=10&order=asc&cursor=string&date_start=string&date_end=stringPlease note that not all data is available in the list endpoint. Once you've identified the conversation you need to work with, use the GET /conversations/:id…

member

  • GETList Members/conversations/:conversation_id/members?page_size=10&order=asc&cursor=string

event

  • GETList Events/conversations/:conversation_id/events?page_size=10&order=asc&cursor=string&start_id=13&end_id=19&event_type=text
  • GETList Users/users?page_size=10&order=asc&cursor=string

API details

Base URL
https://api.nexmo.com/v0.2
Authentication
None declared in the description
Operations
4 operations on 4 pathsGET 4
Main resources
conversation 1event 1member 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0.1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Conversation API: Conversation v2 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Conversation API: Conversation v2 collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “List Conversations” (GET /conversations?page_size=10&order=asc&cursor=string&date_start=string&date_end=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Conversation API: Conversation v2?

The Conversation API enables you to build conversation features where communication can take place across multiple mediums including IP Messaging, PSTN Voice,… It is listed under Other and has 4 endpoints.

Who publishes the Conversation API: Conversation v2?

It is listed from Nexmo's public API description (an OpenAPI document), not published by Nexmo on Swastik Codes. Anyone who controls nexmo.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Conversation API: Conversation v2?

Requests go to https://api.nexmo.com/v0.2. Endpoint paths are added to this base URL.

How do I authenticate with the Conversation API: Conversation v2?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Conversation API: Conversation v2 have?

4 operations on 4 paths (4 GET). The largest groups are conversation, event, member.

Is forking the Conversation API: Conversation v2 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.