SMS Conversion Voice Conversion
 
 

Nexmo Conversion API

The Conversion API allows you to tell Nexmo about the reliability of your 2FA communications. Sending conversion data back to us means that Nexmo can deliver messages faster and more reliably. The conversion data you send us is confidential: Nexmo does not share it with third parties. In order to identify the carriers who provide the best performance, Nexmo continually tests the routes we use to deliver SMS and voice calls. Using Adaptive Routing™, Nexmo actively reroutes messages through different carrier routes and ensures faster and more reliable delivery for your messages. The route choice is made using millions of real-time conversion data points.

Jump to:

SMS Conversion »

SMS Conversion Request

Voice Conversion »

Voice Conversion Request

SMS Conversion

SMS Conversion Request

Available Operations:

Tell Nexmo if your SMS message was successful

Send a Conversion API request with information about the SMS message identified by message-id. Nexmo uses your conversion data and internal information about message-id to help improve our routing of messages in the future.

POST https://api.nexmo.com/conversions/sms
Host https://api.nexmo.com
POST /conversions/sms

Query Parameter

api_key
apiKey

You can find your API key in your account overview

api_secret
apiKey

You can find your API secret in your account overview

sig
apiKey

The hash of the request parameters in alphabetical order, a timestamp and the signature secret. For example: sig=SIGNATURE

message-id
string | Required

The ID you receive in the response to a request. * From the Verify API - use the event_id in the response to Verify Check. * From the SMS API - use the message-id * From the Text-To-Speech API - use the call-id * From the Text-To-Speech-Prompt API - use the call-id

delivered
Required

Set to true if your user replied to the message you sent. Otherwise, set to false. Note: for curl, use 0 and 1.

Must be one of: true, false, 0 or 1
timestamp
string | Required

When the user completed your call-to-action (e.g. visited your website, installed your app) in UTC±00:00 format: yyyy-MM-dd HH:mm:ss. If you do not set this parameter, Nexmo uses the time it receives this request.

Example Responses

200 401 402 420 423

Voice Conversion

Voice Conversion Request

Available Operations:

Tell Nexmo if your voice call was successful

Send a Conversion API request with information about the Call or Text-To-Speech identified by message-id. Nexmo uses your conversion data and internal information about message-id to help improve our routing of messages in the future.

POST https://api.nexmo.com/conversions/voice
Host https://api.nexmo.com
POST /conversions/voice

Query Parameter

api_key
apiKey

You can find your API key in your account overview

api_secret
apiKey

You can find your API secret in your account overview

sig
apiKey

The hash of the request parameters in alphabetical order, a timestamp and the signature secret. For example: sig=SIGNATURE

message-id
string | Required

The ID you receive in the response to a request. * From the Verify API - use the event_id in the response to Verify Check. * From the SMS API - use the message-id * From the Text-To-Speech API - use the call-id * From the Text-To-Speech-Prompt API - use the call-id

delivered
Required

Set to true if your user replied to the message you sent. Otherwise, set to false. Note: for curl, use 0 and 1.

Must be one of: true, false, 0 or 1
timestamp
string | Required

When the user completed your call-to-action (e.g. visited your website, installed your app) in UTC±00:00 format: yyyy-MM-dd HH:mm:ss. If you do not set this parameter, Nexmo uses the time it receives this request.

Example Responses

200 401 402 420 423