Conversation API
nexmo · Company
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.
Authentication
Sample Requests
Please 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](#get-conversation) endpoint to fetch all of the conversation details
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/nexmo.com/conversation.v2/1.0.1/conversations?order=asc&cursor=example&date_end=example&page_size=10&date_start=example"
import requests
params = {
"order": "asc",
"cursor": "example",
"date_end": "example",
"page_size": "10",
"date_start": "example"
}
response = requests.get(
"https://api.apis.guru/v2/specs/nexmo.com/conversation.v2/1.0.1/conversations",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/nexmo.com/conversation.v2/1.0.1/conversations');
url.searchParams.set('order', 'asc');
url.searchParams.set('cursor', 'example');
url.searchParams.set('date_end', 'example');
url.searchParams.set('page_size', '10');
url.searchParams.set('date_start', 'example');
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/nexmo.com/conversation.v2/1.0.1/conversations")
q := baseURL.Query()
q.Set("order", "asc")
q.Set("cursor", "example")
q.Set("date_end", "example")
q.Set("page_size", "10")
q.Set("date_start", "example")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/nexmo.com/conversation.v2/1.0.1/conversations")
uri.query = URI.encode_www_form({
"order" => "asc",
"cursor" => "example",
"date_end" => "example",
"page_size" => "10",
"date_start" => "example"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/nexmo.com/conversation.v2/1.0.1/conversations?" . http_build_query([
"order" => "asc",
"cursor" => "example",
"date_end" => "example",
"page_size" => "10",
"date_start" => "example"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));List Users
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/nexmo.com/conversation.v2/1.0.1/users?order=asc&cursor=example&page_size=10"
import requests
params = {
"order": "asc",
"cursor": "example",
"page_size": "10"
}
response = requests.get(
"https://api.apis.guru/v2/specs/nexmo.com/conversation.v2/1.0.1/users",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/nexmo.com/conversation.v2/1.0.1/users');
url.searchParams.set('order', 'asc');
url.searchParams.set('cursor', 'example');
url.searchParams.set('page_size', '10');
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/nexmo.com/conversation.v2/1.0.1/users")
q := baseURL.Query()
q.Set("order", "asc")
q.Set("cursor", "example")
q.Set("page_size", "10")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/nexmo.com/conversation.v2/1.0.1/users")
uri.query = URI.encode_www_form({
"order" => "asc",
"cursor" => "example",
"page_size" => "10"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/nexmo.com/conversation.v2/1.0.1/users?" . http_build_query([
"order" => "asc",
"cursor" => "example",
"page_size" => "10"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));List Events
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/nexmo.com/conversation.v2/1.0.1/conversations/{conversation_id}/events?order=asc&cursor=example&end_id=example&start_id=example&page_size=10&event_type=example"import requests
params = {
"order": "asc",
"cursor": "example",
"end_id": "example",
"start_id": "example",
"page_size": "10",
"event_type": "example"
}
response = requests.get(
"https://api.apis.guru/v2/specs/nexmo.com/conversation.v2/1.0.1/conversations/{conversation_id}/events",
params=params,
)
print(response.json())const url = new URL('https://api.apis.guru/v2/specs/nexmo.com/conversation.v2/1.0.1/conversations/{conversation_id}/events');
url.searchParams.set('order', 'asc');
url.searchParams.set('cursor', 'example');
url.searchParams.set('end_id', 'example');
url.searchParams.set('start_id', 'example');
url.searchParams.set('page_size', '10');
url.searchParams.set('event_type', 'example');
const response = await fetch(url);
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/nexmo.com/conversation.v2/1.0.1/conversations/{conversation_id}/events")
q := baseURL.Query()
q.Set("order", "asc")
q.Set("cursor", "example")
q.Set("end_id", "example")
q.Set("start_id", "example")
q.Set("page_size", "10")
q.Set("event_type", "example")
baseURL.RawQuery = q.Encode()
targetURL := baseURL.String()
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/nexmo.com/conversation.v2/1.0.1/conversations/{conversation_id}/events")
uri.query = URI.encode_www_form({
"order" => "asc",
"cursor" => "example",
"end_id" => "example",
"start_id" => "example",
"page_size" => "10",
"event_type" => "example"
})
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/nexmo.com/conversation.v2/1.0.1/conversations/{conversation_id}/events?" . http_build_query([
"order" => "asc",
"cursor" => "example",
"end_id" => "example",
"start_id" => "example",
"page_size" => "10",
"event_type" => "example"
]);
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Postman Setup Guide
- See official documentation for authentication and setup.
What can you build with Conversation API?
Conversation API is a Company API. Developers commonly use company APIs for:
- enriching CRM records with company firmographics
- building lead-generation and prospecting tools
- verifying business identity and registration details
- monitoring competitors and market intelligence
- powering B2B data enrichment pipelines
No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Conversation API is free to use, making it a low-risk choice to experiment with.
New to APIs? Read our beginner's guide · Learn about API keys · What is REST?