v1

latestOpenAPI 3.0.0The MIT License (MIT)2026-07-14204.9 KB

SMS Conversion

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/sms

Query parameters

message-idstring 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

{"stackTrail":"components:parameters:delivered:schema","oasType":"schema","type":"unknown"}

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

timestampstring 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.

Response

All 2 operations