How to enable Nexmo SMS on a merchant.
Nexmo, now known as Vonage, offers a Messages API that integrates with SMS, MMS, and various social chat apps. This platform facilitates a broad range of communications options for global customer engagement, utilizing advanced messaging capabilities.
Features
✅ Messaging SMS messages can be delivered using Nexmo.
✅ Message Status SMS messages sent over Nexmo will have their status updated with delivery information.
Resources
Configuration
To configure Nexmo SMS in your system, log into the Nexmo Dashboard. You will need to access your API key and API secret located under the 'Settings' section to use in your application settings.
This table describes the required or possible attributes needed to configure a merchant product for this type.
Name | Type | Description | Rules |
---|---|---|---|
apiKey | string | The API key for your Nexmo account, used to authenticate API requests. Obtain this from your Nexmo dashboard. Examples: XXXXXXXX. | |
apiSecret | string | The API secret for your Nexmo account. This is used together with the API key to authenticate requests. Examples: XXXXXXXXXXXXXXXX. |
Features
All messaging products support the following features
attributes.
Name | Values | Description |
---|---|---|
noAuthcode | true or false (default) | All messages sent to customers using this product will never include an authorization response code. |
Enabling this Product
Using create-merchant-product API you can add a new product to your merchant record. Below is an example configuration for the payload of that request.
{
"line": "messaging",
"product": "sms",
"provider": "nexmo",
"config": {
"apiKey": "XXXXXXXX",
"apiSecret": "XXXXXXXXXXXXXXXX"
}
}
Data Mapping
The following bullet points outline the mapping of data fields between the Authvia platform and the Nexmo system, detailing the correspondence of specific attributes for seamless data integration.
- Authvia
message.from
maps to Nexmo provider.from - Authvia
configuration.line
maps to Nexmo provider.from - Authvia
message.to
maps to Nexmo provider.to - Authvia
message.body.raw
maps to Nexmo provider.text - Authvia
message.id
maps to Nexmo provider.client-ref