Messages API v0.5.0

New

  • adds MMS VCard

SMS API v1.0.11

Minor changes to clarify the prices are estimates.

Application API v2.1.0

New

  • Added the new privacy settings

Number-insight API v1.1.2

  • Removes roaming from standard response as it is not supposed to be returned
  • Corrects bug where original_carrier was not marked as nullable

Subaccounts API v1.0.8

The limit for account names has changed from 24 to 80 characters. The original limit was never documented here.

New

The POST /{api_key}/subaccounts endpoint now supports a name property that is up to 80 characters long

Number-insight API v1.1.1

Fixed

  • Fixed NI responses for "unknown" roaming

Number-insight API v1.1.0

Changed

  • Converts carrier information and roaming values to Nullable where appropriate

Voice API v1.3.7

New VAPI feature added - the ability to use random from number, selected from one of the phone numbers assigned to the application.

Added

  • Add new random_from_number parameter to POST /v1/calls request;
  • from in POST /v1/calls request is not mandatory now.

Reports API v2.1.17

Changed

  • Updated default value for concatenated

Added

  • Added new product - REPORTS-USAGE

Reports API v2.1.16

Added

  • Show "concatenated" field in response example

Reports API v2.1.15

Added

  • added ASR product where it was missing
  • new product : VOICE-FAILED
  • the parameter show_concatenated (true/false)

NOTE: VOICE-FAILED has retention of only 7 days (all other ones have 13 months)

Whatsapp-provisioning API v0.1.4

Added

  • adding x-error for conflicting deployments.

Number-insight API v1.0.10

Fixed

  • Initial carrier for NI is now described as the carrier a number was initially connected to, versus the number it is currently connected to.

External-accounts API v0.1.5

Added

  • In December we added a new tool to manage the linking of Facebook accounts to your Vonage API account, this update reflects that.

Deprecated

  • messenger.nexmo.com is being deprecated.

Whatsapp-provisioning API v0.1.0

Added

  • Added new WhatsApp provisioning API spec. This API will create a new WhatsApp cluster for the requester and perform WhatsApp OTP verification. Additionally, this API allows you to update your profile information/picture.

Verify API v1.1.7

Added

  • Specifies that either request_id or request_ids is required when searching for verify request.

Sms API v1.0.10

To make sure that our APIs meet new regulations, we're adding two new fields to the send-sms endpoint. These are entity-id and content-id. The first of these regulations is DLT, which is an Indian regulation. For more information on DLT please go to: https://help.nexmo.com/hc/en-us/articles/204017423-India-Features-Restrictions .

Verify API v1.1.6

Fixes

  • Add error message when new users try to access non-permitted destinations with Verify API

Reports API v2.1.14

Fixes

  • You can now specify a comma-separated list of UUIDs to synchronously retrieve records for.

Reports API v2.1.13

Fixes

  • Adds error 409 and links to it from Cancel Report.

Account API v1.0.3

Fixes

  • Restructure the Account API to have named request bodies along the same lines as our other APIs

Application API v2.0.9

Fixes

  • Clarifies the descriptions for connection_timeout and socket_timeout.

Verify API v1.1.5

Fixes

  • Structure change since moving to POST requests had left nameless objects in the API definition and this trips up some codegen tooling.
  • Add "deprecated" to the ip_address fields that we no longer use.

Application API v2.0.8

  • Add the default timeout information inside each action detail properties section.

Application API v2.0.7

New

Added connection_timeout and socket_timeout to voice capabilities - webhooks.

Messages-olympus API v0.3.12

Fixes

  • Change Nexmo references to Vonage.

Dispatch API v0.3.3

Fixes

  • Change Nexmo references to Vonage.

Subaccounts API v1.0.7

New

  • Added new name parameter to ModifySubaccountRequest

Developer/messages API v1.0.6

Fixes

  • Change Nexmo references to Vonage.

Redact API v1.0.6

Fixes

  • Improves overview by referencing main doc overview and auto-redact.

Sms API v1.0.9

Changed Nexmo references to Vonage.

Number-insight API v1.0.9

Fixes

  • Change Nexmo references to Vonage.

Conversation API v1.0.1

Fixes

  • Branding changes - Nexmo to Vonage.

Audit API v1.0.4

Fixes

  • Branding updates - Nexmo to Vonage.

Conversation API v2.0.1

Fixes

  • Branding changes - Nexmo to Vonage.

External-accounts API v0.1.4

Fixes

  • Branding changes - Nexmo to Vonage.

Redact API v1.0.5

Fixes

  • Change Nexmo references to Vonage.

Numbers API v1.0.20

Fixes

  • Change Nexmo references to Vonage.

Verify API v1.1.4

Fixes

  • Change Nexmo references to Vonage.

Voice API v1.3.6

Fixes

  • Change Nexmo references to Vonage.

Voice API v2.2.2

Fixes

  • Change Nexmo references to Vonage.

Account API v1.0.2

Fixes

  • Update branding to Vonage

Voice API v1.3.5

When the recommended TTS fields changed from voice_name to language and style, we completely removed the voice_name from the API description but it's still supported in the API itself. A more accurate way to describe the API would be to include the field but clearly mark it as deprecated.

(see also: an open issue to have our docs mark this more clearly. Other platforms should do it though https://github.com/Nexmo/nexmo-oas-renderer/issues/87)

Fixes

  • Keep the old voice name field docs for reference

Conversation API v2.0.0

Changes

  • Transitioned the Conversation API endpoints from beta and beta2 paths to v0.1 and v0.2 respectively.

Conversation API v1.0.0

Changes

  • Transitioned the Conversation API endpoints from beta and beta2 paths to v0.1 and v0.2 respectively.

Application API v2.0.6

Fixes

  • Improved examples and data types, renamed the common errors component.

Reports API v2.1.12

New report type and corresponding product value supported: WEBSOCKET-CALL.

Reports API v2.1.11

Fixes

  • For get records, every response example showed the product as SMS. Fixed to show correct product for each tab.
  • For get records, fixed direction for example responses so that they were correctly inbound/outbound as appropriate.
  • For get records, fixed tabbing between Response panel and tabs in corresponding example panel.

Messages-olympus API v0.3.11

  • Accidentally added SMS MO to previous spec refresh - removing as it's not supported by the Messages API yet.
  • Also needed to swap the id/number for viber inbound messages.

Messages-olympus API v0.3.10

Refreshing the Olympus OAS spec so that it can be a bit more usable then it is now. Making all channel/messageType permutations tabbable. Also made whatsapp node a required part of a WhatsApp message for MTM messages.

Example:

New

  • Tab interface for NewMessage operation
  • Made whatsapp node a required field for MTM
  • Cleaned up descriptions so they only refer to the channel for the tab

Fixes

  • Minor fixes to descriptions.

Number-insight API v1.0.8

While working with the Number Insights API I found a couple of really minor things so I fixed them.

Fixes

  • Adds the missing error_text field to the async response of Number Insight API
  • Corrects the remaining_balance data type to be a string everywhere on Number Insight API

Messages-olympus API v0.3.9

New

  • Adding unsupported type to inbound messages webhook for messages-Olympus. This will occur if a channel receives a type that's not supported (previous behavior was just to drop the message).

Reports API v2.1.10

Fixes

  • Removed JWT Authentication, as it is not supported.

Voice API v2.2.1

Fixes

  • Adds app as possible endpoint types for a create call request

Voice API v1.3.3

New talk operation parameters added: language and style

Verify API v1.1.3

New

  • Support for Thai (th-th) and Yue Chinese (yue-cn) languages

Voice API v1.3.2

Fixes

  • Correct the request example for a transfer action

Voice API v1.3.1

Fixes:

  • Correct length_timer description to match an actual VAPI call state, which is answered.

Reports API v2.1.8

New

  • ASR (Speech Recognition) records are now supported in Reports API

Subaccounts API v1.0.6

New

  • Added possible error messages when managing subaccounts

Voice API v1.3.0

Fixes

  • Split POST /calls in to a oneOf for answer_url and ncco options
  • Split PUT /calls/:id in to a oneOf for transfer with answer_url and ncco options, plus hangup, mute, unmute, earmuff, unearmuff
  • Remove dtmfAnswer from the from option when placing a call
  • Fix examples for ncco, event_url and answer_url

Voice API v2.2.0

Fixes

  • Split POST /calls in to a oneOf for answer_url and ncco options
  • Split PUT /calls/:id in to a oneOf for transfer with answer_url and ncco options, plus hangup, mute, unmute, earmuff, unearmuff
  • Remove dtmfAnswer from the from option when placing a call
  • Fix examples for ncco, event_url and answer_url

Account API v1.0.1

New

  • Add error responses to /account/get-balance
  • Add success and error responses to /account/top-up

Conversation API v1.7.8

Fixes

  • Remove unused numbers key from Create Conversation
  • Fix event_url example

Reports API v2.1.6

Fixes

  • Updated description for the CSV Responses success response

Voice API v1.2.10

Fixes

  • The GET /v1/calls endpoint returns a different data structure than we describe in the spec. Spec says: array of objects with "from" and "number" properties. In reality we get just get one of those objects, no array.

Verify API v1.1.2

Fixes

  • Update Verify status response codes - only /search returns the status 101 response

Developer/messages API v1.0.5

Deprecations

  • The message search API is now deprecated

Numbers API v1.0.19

New

  • Describe error responses in Numbers API

Voice API v1.2.8

Fixes

  • Clarify that event_url parameter is only required for creating a call request when it is not previously set at the application level.

Voice API v1.2.7

New

  • Newly supported Text to Speech voices added to the list of possible values for voice_name parameter of PUT /v1/calls/{uuid}/talk operation.

Reports API v2.1.5

New

  • Allowed time window for the Sync endpoint increased from 1 hour to 24 hours.

Verify API v1.1.1

New

  • Added new Verify API PSD2 feature for confirming payments

Reports API v2.1.3

Fixes

  • The correct parameter name for synchronous reports is id not message_id
  • Fixed example value for id.
  • Formatting fixes for date formats.

Messages-olympus API v0.3.8

Fixes

  • Remove fallback policy from whatsapp locale configuration
  • Add new validation error that is returned if fallback is sent

Voice API v1.2.6

New

  • Voice API describe the number attribute of the EndpointPhone object as required.

Fixes

  • If the field is not specified, the user gets this response:
{"type":400,"title":"Bad Request","invalid_parameters":[{"reason":"part of phone type and cannot be empty or NULL","name":"number"}]}                                                                                                          

Pricing API v0.0.3

Fixes

  • Removes reference to basicAuth as Pricing API seems to use query string auth.

Numbers API v1.0.18

New

  • Add mms number type

Sms API v1.0.8

New

  • Describe error response to Send an SMS

Fixes

  • Add missing (optional) client-ref field to API response and DLR payloads

Developer/messages API v1.0.4

Fixes

  • to number is a string but was displaying as number in response examples.

Verify API v1.1.0

Fixed

  • Switch Verify API endpoints to use POST requests

Voice API v2.1.0

New

  • Add client_ref request parameter to the event callback data

Reports API v2.1.1

Fixes

  • Rename messages_id parameter to id

Numbers API v1.0.17

New

  • Add app_id parameter

Deprecated

  • messagesCallbackType and messagesCallbackValue
  • voiceCallbackValue with type app

Reports API v2.1.0

New

  • Added /v2/reports/records endpoint for fetching data records synchronously

Messages-olympus API v0.3.7

Fixes

  • Updated Image, Audio, Video, and File properties in Inbound messages with note that media files are available for 48 hours after they are created.

Sms API v1.0.7

New

  • Added API key and message signature fields to delivery receipts callback

Fixes

  • Data types, field length information and a very small typo

Sms API v1.0.6

Fixes

  • Adds api-key field to Inbound SMS request body.

Conversation API v1.7.6

Fixes

  • Fixed the response fields for Create User.
  • Fixed the example user href.

Voice API v1.2.5

Fixes

  • Update response field description for start_time to include detail that it is only provided for completed calls

Verify API v1.0.10

Fixes

  • Clarify that the ip_address field isn't expected/used

External-accounts API v0.1.3

Fixes

  • Fix links to point to https://developer.nexmo.com/api/application.v2

Numbers API v1.0.15

Fixes

  • Make the country field on listOwnedNumbers optional
  • Fix the response format for searchAvailableNumbers

Verify API v1.0.9

Fixes

  • Give more information about the intended behaviour of Verify API when cancelling a request.

Dispatch API v0.3.1

New

  • Deprecate Messaging API fallback policy from Jan 2020.

Messages-olympus API v0.3.5

New

  • Update messages API to include Viber MO (inbound messages)

Reports API v2.0.8

Fixed

  • Modified description of Reports API date fields to match production date format

Numbers API v1.0.14

New

  • Add new target_api_key field when buying or cancelling a number using Numbers API

Verify API v1.0.8

Fixes

  • Change error example req_id to empty string in /verify endpoint.

Subaccounts API v1.0.4

Fixes

  • Adds default entry. The default for use_primary_account_balance is true.

Reports API v2.0.7

Fixes

  • Updated ISO 8601 format description.

Reports API v2.0.5

Fixes

  • Explain the difference between api_key (authentication) and account_id (target of the report)

Conversation API v1.7.4

Fixes

  • Recording event URL is array of URLs.

Voice API v1.2.3

Fixes

  • Corrected NCCO to be an "array of objects" not an "array of strings"

Number-insight API v1.0.5

Deprecated

  • Deprecate ip_match parameter for Advanced NI, and remove the ip object from the response. IP matching is no longer supported due to this information being unreliable globally.

Redact API v1.0.3

Fixes

  • /v1/redact/transaction endpoint uses basic auth, not key and secret in the query string

Pricing API v0.0.1

New

  • Added first version of Pricing OAS3 specification.

Numbers API v1.0.13

Fixes

  • You can filter the numbers that you own by providing a country code parameter

Reports API v2.0.4

Fixes

  • Renamed termination_status to status

Numbers API v1.0.12

Fixes

  • Clarify purpose of the voiceCallbackType parameter

Numbers API v1.0.11

New

  • Soft-deprecate the use of messagesCallbackType to enable messaging capabilityThe . Specify app in voiceCallbackType instead. messagesCallbackType and messagesCallbackValue parameters are still supported, but we discourage their use.

Conversation API v1.7.3

New

  • Added Conversation beta2 API reference

Deprecations

  • Deprecated the following endpoints in favour of beta2:
    • GET /beta/conversations
    • GET /beta/conversations/{id}/members
    • GET /beta/conversations/{id}/events
    • GET /beta/users

Reports API v2.0.3

New

  • Renamed download url from url to download_report and put it under _links field.
  • Removed trace_id from ip_voice.
  • Renamed ip_voice to conversations and made ip_voice it's subtype.
  • Decoupled response bodies for creating new report and getting report status.
  • Renamed msisdn to number for hlr reports.

Verify API v1.0.7

Fixes

  • Updates the list of available language codes now that Verify is using the new TTS feature.

Conversation API v1.7.2

Fixes

  • Override the base URL for the Conversation service /record endpoint to be the correct endpoint for this service.

Conversation API v1.7.1

Fixes

  • Mark action as required body field for recordConversation

Voice API v1.2.1

Fixes

  • Adjust description of Path Parameters to require uuid of the leg, not of the call

Reports API v2.0.2

Fixes

  • Add information explaining if date_start and date_end are inclusive/exclusive
  • Added date_finalized to the outbound SMS CSV report
  • Updated date_end example

Numbers API v1.0.10

Numbers API has new filters to make it easier to find numbers that are (or are not!) associated with applications

New

Added new has_application and application_id filters to the Numbers API

Conversation API v1.7.0

New

  • Added new /conversations/{conversation_id}/record endpoint for REST start/stop Conversation recording

Application API v1.0.2

Version 1 of the application API has been deprecated. It will continue to work for the foreseeable future, and any shutdown will be communicated to all customers before it happens.

Please use version 2 of the Applications API to manage your applications going forwards. Applications created with version 1 of the API can also be managed with version 2

Application API v2.0.4

Version 2 of the Application API is no longer in beta! Production tests of this new major version have been successful and we recommend that all consumers update to using version 2 at their earliest convenience

Verify API v1.0.6

New

Add the new estimated_price_messages_sent field to the search endpoint.

This field was already returned by the check/ endpoint but has now been added to the search as well.

Application API v1.0.1

Fixes

  • Add messages application type and examples

Voice API v1.2.0

This adds the 401 and 404 HTTP responses for a PUT request to /calls/:call_id.