Nexmo

Conversation API: Conversation

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 23

conversation

  • GETList conversations/conversations?date_start=2018-01-01 10:00:00&date_end=2018-01-01 12:00:00&page_size=50&record_index=0&order=ascDeprecated. This endpoint is DEPRECATED. Please use /v0.2/conversations. List all conversations associated with your application. This endpoint required an…
  • POSTCreate a conversation/conversations
  • GETRetrieve a conversation/conversations/:conversation_id
  • PUTUpdate a conversation/conversations/:conversation_id
  • DELETEDelete a conversation/conversations/:conversation_id
  • PUTRecord a conversationhttps://api.nexmo.com/v1/conversations/:conversation_id/record

user

  • GETList users/usersDeprecated. This endpoint is DEPRECATED. Please use /v0.2/users.
  • POSTCreate a user/usersNote: Users must be created with an admin JWT.
  • GETRetrieve a user/users/:user_id
  • PUTUpdate a user/users/:user_id
  • DELETEDelete a user/users/:user_id
  • GETList user conversations/users/:user_id/conversations

member

  • GETList members/conversations/:conversation_id/membersDeprecated. This endpoint is DEPRECATED. Please use /v0.2/members.
  • POSTCreate a member/conversations/:conversation_id/members
  • GETRetrieve a member/conversations/:conversation_id/members/:member_id
  • PUTUpdate a member/conversations/:conversation_id/members/:member_id
  • DELETEDelete a member/conversations/:conversation_id/members/:member_id

event

  • GETList events/conversations/:conversation_id/eventsDeprecated. This endpoint is DEPRECATED. Please use /v0.2/events.
  • POSTCreate an event/conversations/:conversation_id/events
  • GETRetrieve an event/conversations/:conversation_id/events/:event_id
  • DELETEDelete an event/conversations/:conversation_id/events/:event_id

leg

  • GETList legs/legs
  • DELETEDelete a leg/legs/:leg_id

API details

Base URL
https://api.nexmo.com/v0.1
Authentication
A bearer token in the Authorization header
Operations
23 operations on 12 pathsGET 10DELETE 5PUT 4POST 4
4 marked deprecated
Main resources
conversation 6user 6member 5event 4leg 2
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 2.0.1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Conversation API: Conversation 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 collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List conversations” (GET /conversations?date_start=2018-01-01 10:00:00&date_end=2018-01-01 12:00:00&page_size=50&record_index=0&order=asc), 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?

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 23 endpoints.

Who publishes the Conversation API: Conversation?

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?

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

How do I authenticate with the Conversation API: Conversation?

With A bearer token in the Authorization header.

How many endpoints does the Conversation API: Conversation have?

23 operations on 12 paths (10 GET, 5 DELETE, 4 PUT, 4 POST). The largest groups are conversation, user, member, event.

Is forking the Conversation API: Conversation 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.