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 conversa
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.nexmo.com/v0.1 https://api.nexmo.com/beta/chatapp-accounts https://api.nexmo.com/accounts https://api.nexmo.com/v1/calls https://api.nexmo.com https://api.nexmo.com/verify
auth: b e a r s i
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
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.
| method | path | what the vendor says it does |
|---|---|---|
GET | /conversations | List conversations This endpoint is **DEPRECATED**. Please use [/v0.2/conversations](/api/conversation.v2#get- |
POST | /conversations | Create a conversation conversation |
GET | /conversations/{conversation_id} | Retrieve a conversation conversation |
PUT | /conversations/{conversation_id} | Update a conversation conversation |
DELETE | /conversations/{conversation_id} | Delete a conversation conversation |
GET | /conversations/{conversation_id}/events | List events This endpoint is **DEPRECATED**. Please use [/v0.2/events](/api/conversation.v2#get-events). event |
POST | /conversations/{conversation_id}/events | Create an event event |
GET | /conversations/{conversation_id}/events/{event_id} | Retrieve an event event |
DELETE | /conversations/{conversation_id}/events/{event_id} | Delete an event event |
GET | /conversations/{conversation_id}/members | List members This endpoint is **DEPRECATED**. Please use [/v0.2/members](/api/conversation.v2#get-members). me |
POST | /conversations/{conversation_id}/members | Create a member member |
GET | /conversations/{conversation_id}/members/{member_id} | Retrieve a member member |
PUT | /conversations/{conversation_id}/members/{member_id} | Update a member member |
DELETE | /conversations/{conversation_id}/members/{member_id} | Delete a member member |
PUT | /conversations/{conversation_id}/record | Record a conversation conversation |
GET | /legs | List legs leg |
DELETE | /legs/{leg_id} | Delete a leg leg |
GET | /users | List users This endpoint is **DEPRECATED**. Please use [/v0.2/users](/api/conversation.v2#get-users). user |
POST | /users | Create a user Note: Users must be created with an admin JWT. user |
GET | /users/{user_id} | Retrieve a user user |
PUT | /users/{user_id} | Update a user user |
DELETE | /users/{user_id} | Delete a user user |
GET | /users/{user_id}/conversations | List user conversations user |
specification origin: https://raw.githubusercontent.com/nexmo/api-specification/master/definitions/conversation.
The External Accounts API is used to manage accounts for Viber Business Messages, Facebook Messenger and Whatsapp for use in the [Messages](https://developer.nexmo.com/messages/overview) and [Dispatch](https://developer.nexmo.com/dispatch/overview) APIs.
| method | path | what the vendor says it does |
|---|---|---|
GET | / | Retrieve all accounts you own Account |
POST | /messenger | Create a Messenger account Facebook Messenger |
GET | /messenger/{external_id} | Retrieve a Messenger account Facebook Messenger |
PATCH | /messenger/{external_id} | Update a Messenger account Facebook Messenger |
DELETE | /messenger/{external_id} | Delete a Messenger account Facebook Messenger |
GET | /viber_service_msg/{external_id} | Retrieve a Viber Service Message account Viber Service Message |
GET | /whatsapp/{external_id} | Retrieve a Whatsapp account WhatsApp |
POST | /{provider}/{external_id}/applications | Link application to an account Application |
DELETE | /{provider}/{external_id}/applications/{application_id} | Unlink application from an account Application |
specification origin: https://raw.githubusercontent.com/nexmo/api-specification/master/definitions/external-acco
The Subaccounts API enables you to create subaccounts under your primary account. Subaccounts facilitate differential product configuration, reporting, and billing. The Subaccounts API is released initially with restricted availability. You can read more about the API in the [Subaccounts documentation](/account/subaccounts/overview).
| method | path | what the vendor says it does |
|---|---|---|
GET | /{api_key}/balance-transfers | Retrieve list of balance transfers Retrieve a list of balance transfers that have taken place for a primary ac |
POST | /{api_key}/balance-transfers | Transfer balance Transfer balance between a primary account and one of its subaccounts. Note that balance_avai |
GET | /{api_key}/credit-transfers | Retrieve list of credit transfers Retrieve a list of credit transfers that have taken place for a primary acco |
POST | /{api_key}/credit-transfers | Transfer credit Transfer credit limit between a primary account and one of its subaccounts. Transfers |
GET | /{api_key}/subaccounts | Retrieve list of subaccounts Get the information of all the subaccounts owned by the primary account. Subaccou |
POST | /{api_key}/subaccounts | Create subaccount Create a subaccount for a given primary account. Subaccount Management |
GET | /{api_key}/subaccounts/{subaccount_key} | Retrieve a subaccount Get the information of a subaccount specified with its API key. Subaccount Management |
PATCH | /{api_key}/subaccounts/{subaccount_key} | Modify a subaccount Change one or more properties of a subaccount. Subaccount Management |
POST | /{api_key}/transfer-number | Transfer number Transfer number from one account to another. Transfers |
specification origin: https://raw.githubusercontent.com/nexmo/api-specification/master/definitions/subaccounts.y
The Voice API lets you create outbound calls, control in-progress calls and get information about historical calls. More information about the Voice API can be found at .
| method | path | what the vendor says it does |
|---|---|---|
GET | / | Get details of your calls Get details of your calls Calls |
POST | / | Create an outbound call Create an outbound Call Calls |
GET | /{uuid} | Get detail of a specific call Get detail of a specific call Calls |
PUT | /{uuid} | Modify an in progress call Modify an in progress call Calls |
PUT | /{uuid}/dtmf | Play DTMF tones into a call Play DTMF tones into a call Play DTMF |
PUT | /{uuid}/stream | Play an audio file into a call Play an audio file into a call Stream Audio |
DELETE | /{uuid}/stream | Stop playing an audio file into a call Stop playing an audio file into a call Stream Audio |
PUT | /{uuid}/talk | Play text to speech into a call Play text to speech into a call Play TTS |
DELETE | /{uuid}/talk | Stop text to speech in a call Stop text to speech in a call Play TTS |
specification origin: https://raw.githubusercontent.com/nexmo/api-specification/master/definitions/voice.yml
Enables users to manage their Vonage API Account by programmable means. More information is available here: .
| method | path | what the vendor says it does |
|---|---|---|
GET | /account/get-balance | Get Account Balance Retrieve the current balance of your Vonage API account Balance |
POST | /account/register-sender | Register an email sender Register an email sender with an API Key for using email with Verify V2. Configuratio |
POST | /account/settings | Change Account Settings Update the default webhook URLs associated with your account: * Callback URL for inc |
POST | /account/top-up | Top Up Account Balance You can top up your account using this API when you have enabled auto-reload in the das |
GET | /accounts/{api_key}/secrets | Retrieve API Secrets Secret Management |
POST | /accounts/{api_key}/secrets | Create API Secret Secret Management |
GET | /accounts/{api_key}/secrets/{secret_id} | Retrieve one API Secret Secret Management |
DELETE | /accounts/{api_key}/secrets/{secret_id} | Revoke an API Secret Secret Management |
specification origin: https://raw.githubusercontent.com/nexmo/api-specification/master/definitions/account.yml
The [Reports API](/reports/overview) enables you to request a report of activity for your Vonage account. Depending on your query pattern, you can choose from one of the two versions of the Reports API: asynchronous and synchronous. The asynchronous version is optimized for infrequent and large data queries (from several records to tens of millions). The synchronous version is optimized for frequ
| method | path | what the vendor says it does |
|---|---|---|
GET | /v2/reports | List reports List reports created by the specified account based on filtered provided. |
POST | /v2/reports | Create an asynchronous report Request a report on your account activity |
GET | /v2/reports/records | Load records synchronously Fetch usage data synchronously |
GET | /v2/reports/{report_id} | Get status of report Retrieve status and metadata about a requested report. |
DELETE | /v2/reports/{report_id} | Cancel the execution of a report Cancel the execution of a pending or processing report. |
GET | /v3/media/{file_id} | Get report data Download a zipped archive of the rendered report. The file is available for download for 72 ho |
specification origin: https://raw.githubusercontent.com/nexmo/api-specification/master/definitions/reports.yml
The Verify API helps you to implement 2FA (two-factor authentication) in your applications. This is useful for: * Protecting against spam, by preventing spammers from creating multiple accounts * Monitoring suspicious activity, by forcing an account user to verify ownership of a number * Ensuring that you can reach your users at any time because you have their correct phone number More informatio
| method | path | what the vendor says it does |
|---|---|---|
POST | /check/{format} | Verify Check Use Verify check to confirm that the PIN you received from your user matches the one sent by Vona |
POST | /control/{format} | Verify Control Control the progress of your Verify requests. To cancel an existing Verify request, or to trigg |
POST | /network-unblock | Request a network unblock Request to unblock a network that has been blocked due to potential fraud detection |
POST | /psd2/{format} | PSD2 (Payment Services Directive 2) Request Use Verify request to generate and send a PIN to your user to auth |
GET | /search/{format} | Verify Search Use Verify search to check the status of past or current verification requests: 1. Send a Verif |
POST | /{format} | Request a Verification Use Verify request to generate and send a PIN to your user: 1. Create a request to sen |
specification origin: https://raw.githubusercontent.com/nexmo/api-specification/master/definitions/verify.yml
Vonage provides an Application API to allow management of your Vonage Applications. This API is backwards compatible with version 1. Applications created using version 1 of the API can also be managed using version 2 (this version) of the API.
| method | path | what the vendor says it does |
|---|---|---|
GET | / | List available applications |
POST | / | Create an application |
GET | /{id} | Get an application |
PUT | /{id} | Update an application |
DELETE | /{id} | Delete an application Deleting an application **cannot be undone**. |
specification origin: https://raw.githubusercontent.com/nexmo/api-specification/master/definitions/application.v
Applications V1 is deprecated This version of the API has been deprecated. Please use version 2 going forwards A Nexmo application contains the security and configuration information you need to connect to Nexmo endpoints and easily use our products.
| method | path | what the vendor says it does |
|---|---|---|
GET | / | Retrieve all Applications You use a `GET` request to retrieve details of all applications associated with your |
POST | / | Create Application You use a `POST` request to create a new application. |
GET | /{app_id} | Retrieve Application You use a `GET` request to retrieve details about a single application. |
PUT | /{app_id} | Update Application You use a `PUT` request to update an existing application. |
DELETE | /{app_id} | Destroy Application You use a `DELETE` request to delete a single application. |
specification origin: https://raw.githubusercontent.com/nexmo/api-specification/master/definitions/application.y
The Numbers API enables you to manage your existing numbers and buy new virtual numbers for use with the Vonage APIs. Further information is here:
| method | path | what the vendor says it does |
|---|---|---|
GET | /account/numbers | List the numbers you own Retrieve all the inbound numbers associated with your Vonage account. |
POST | /number/buy | Buy a number Request to purchase a specific inbound number. |
POST | /number/cancel | Cancel a number Cancel your subscription for a specific inbound number. |
GET | /number/search | Search available numbers Retrieve inbound numbers that are available for the specified country. |
POST | /number/update | Update a number Change the behaviour of a number that you own. |
specification origin: https://raw.githubusercontent.com/nexmo/api-specification/master/definitions/numbers.yml
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.
| method | path | what the vendor says it does |
|---|---|---|
GET | /conversations | List Conversations Please note that not all data is available in the list endpoint. Once you've identified th |
GET | /conversations/{conversation_id}/events | List Events event |
GET | /conversations/{conversation_id}/members | List Members member |
GET | /users | List Users |
specification origin: https://raw.githubusercontent.com/nexmo/api-specification/master/definitions/conversation.
The Media API can be used to query, download and delete media items such as audio files for use with other Nexmo APIs.
| method | path | what the vendor says it does |
|---|---|---|
GET | / | List and search media items Retrieve information about multiple media items with the ability to search and pag |
DELETE | /:id | Delete a media item Delete a previously created media item by ID. |
GET | /:id/info | Retrieve a media item Retrieve information about a single media item |
PUT | /:id/info | Update a media item Update a previously created media item by ID. |
specification origin: https://raw.githubusercontent.com/nexmo/api-specification/master/definitions/media.yml
and 8 more specification(s) from nexmo.com, all indexed.
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.