API Reference

Learn how to access UNLOQ end points

POST /Providers

Create a new provider

POST https://api.unloq.io/v1/sms/providers
Headers:
   Authorization: Bearer {your application API Key}
   Content-Type: application/json
Body parameters
  • type (string) - Required. Supported providers are: "NEXMO", "TWILIO".
  • name (string) - Required. Name of the provider
  • countries (array) - Optional. Multiple select from a list of countries.
  • patterns (array) - Optional.
  • phone_types (array) - Minimum one required. *Read below for a list of supported phone types.
  • is_default (boolean) - Optional. Sets the current provider to be used as default.
  • creds (object) - Required. Credentials used to authenticate with the external sms provider.
  • log_messages (enum) - Optional. Available options are ['DISABLED', 'HASH', 'FULL']

The currently supported phone types are: ['MOBILE', 'FIXED_LINE', 'FIXED_LINE_OR_MOBILE', 'SHARED_COST', 'VOIP', 'PERSONAL_NUMBER', 'PAGER', 'UAN', 'VOICEMAIL', 'TOLL_FREE', 'PREMIUM_RATE']

Result format (200 OK)
{
  "type": "provider.create",
  "result": {
    "id": "544e2d4de39647a997868439lXoBttek",
    "type": "NEXMO",
    "name": "NEXMO",
    "log_messages": "FULL",
    "countries": [],
    "patterns": [],
    "phone_types": [
      "MOBILE",
      "FIXED_LINE",
      "FIXED_LINE_OR_MOBILE",
      "SHARED_COST"
    ],
    "is_default": false,
    "is_verified": false,
    "is_active": true,
    "sort": 11,
    "created_at": "2017-12-14T15:39:29.000Z"
  }
}
      

Have a question? You can always send us an email at support@unloq.io, or contact us on chat.

For security related concerns, please visit our Security page.