APIHub
Back to Explore

Conversation API

The Conversation API provides endpoints for creating, retrieving, updating, and deleting conversations and their related resources—including participants (members), events, recordings, call legs, and user accounts—allowing developers to manage multi‑medium communication sessions programmatically.

Uncategorized
bearer
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

416ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/conversations/{conversation_id}/members/{member_id}

Retrieve a member

PUT

/conversations/{conversation_id}/members/{member_id}

Update a member

PUT

/conversations/{conversation_id}/record

Record a conversation

GET

/conversations/{conversation_id}/events/{event_id}

Retrieve an event

GET

/conversations/{conversation_id}/members

List members

POST

/conversations/{conversation_id}/members

Create a member

DELETE

/conversations/{conversation_id}/members/{member_id}

Delete a member

GET

/conversations

List conversations

  • date_start (query) — Return the records that occurred after this point in time.
  • date_end (query) — Return the records that occurred before this point in time.
  • page_size (query, limit) — Return this amount of records in the response
  • record_index (query) — Return calls from this index in the response
  • order (query) — Return the records in ascending or descending order.
POST

/conversations

Create a conversation

DELETE

/conversations/{conversation_id}

Delete a conversation

GET

/conversations/{conversation_id}

Retrieve a conversation

PUT

/conversations/{conversation_id}

Update a conversation

GET

/conversations/{conversation_id}/events

List events

POST

/conversations/{conversation_id}/events

Create an event

DELETE

/conversations/{conversation_id}/events/{event_id}

Delete an event

GET

/legs

List legs

DELETE

/legs/{leg_id}

Delete a leg

GET

/users

List users

POST

/users

Create a user

DELETE

/users/{user_id}

Delete a user

GET

/users/{user_id}

Retrieve a user

PUT

/users/{user_id}

Update a user

GET

/users/{user_id}/conversations

List user conversations

23 endpoints auto-detected

Authentication

This API uses Bearer token authentication — pass your token in the Authorization header.

curl -X GET \
  "https://api.nexmo.com/v0.1/conversations/{conversation_id}/members/{member_id}" \
  -H "Authorization: Bearer YOUR_TOKEN"

api.nexmo.com · HTTPS only