Namirasoft SMS Sender API V1

Namira Software Corporation SMS Sender API Version 1 (1.4.14)

Install


To use this cli, we need to first Install Nodejs, then run the following command.

npm i -g namirasoft-sms-sender-api-v1

Copied!

Commands


Healthz

Get

Returns the application health status

ns-sms-sender healthz get

Copied!

Value

List

Returns the value list of a given table and column

ns-sms-sender value list {table} {column} {search} {field_id} {limit}

Copied!

ProviderCategory

List

Returns the provider category list

ns-sms-sender providercategory list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a provider category by id.

ns-sms-sender providercategory get {id}

Copied!

Create

Creates a new provider category for an entity

ns-sms-sender providercategory create {entity_id}

Copied!

--category_id (String)

Delete

Deletes a provider category by an id.

ns-sms-sender providercategory delete {entity_id} {id}

Copied!

ProviderField

List

Returns the provider field list

ns-sms-sender providerfield list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a provider field by id.

ns-sms-sender providerfield get {id}

Copied!

Create

Creates a new provider field for an entity

ns-sms-sender providerfield create {entity_id}

Copied!

--field_id (String)

--value (String)

Update

Updates a provider field by an id for an entity

ns-sms-sender providerfield update {entity_id} {id}

Copied!

--field_id (String)

--value (String)

Delete

Deletes a provider field by an id.

ns-sms-sender providerfield delete {entity_id} {id}

Copied!

ProviderTag

List

Returns the provider tag list

ns-sms-sender providertag list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a provider tag by id.

ns-sms-sender providertag get {id}

Copied!

Create

Creates a new provider tag for an entity

ns-sms-sender providertag create {entity_id}

Copied!

--name (String)

--value (String)

Update

Updates a provider tag by an id for an entity

ns-sms-sender providertag update {entity_id} {id}

Copied!

--name (String)

--value (String)

Delete

Deletes a provider tag by an id.

ns-sms-sender providertag delete {entity_id} {id}

Copied!

SMS

Send

Sends an SMS

ns-sms-sender sms send

Copied!

--provider_id (String)

--phone (String)

--message (String)

Provider

List

Returns the provider list

ns-sms-sender provider list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a provider by an id

ns-sms-sender provider get {id}

Copied!

Delete

Deletes a provider by an id

ns-sms-sender provider delete {id}

Copied!

Request

Sends a provider validation request by SMS

ns-sms-sender provider request {id}

Copied!

--phone (Phone)

Verify

Verify provider

ns-sms-sender provider verify {id}

Copied!

--code (String)

AWS

Create

Creates a new aws

ns-sms-sender aws create

Copied!

--workspace_id (String)

--name (String)

--region (String)

--access_key (String)

--secret_key (String)

--provider_category (Array)

--provider_field (Array)

--provider_tag (Array)

Update

Updates an aws by an id

ns-sms-sender aws update {id}

Copied!

--workspace_id (String)

--name (String)

--region (String)

--access_key (String)

--secret_key (String)

--provider_category (Array)

--provider_field (Array)

--provider_tag (Array)

Sent

List

Returns the sent list

ns-sms-sender sent list {filters} {page} {size} {sorts} {user_id}

Copied!

Get

Returns a sent by an id

ns-sms-sender sent get {id}

Copied!

Schemas


ProviderCategory

{
  "name": "ProviderCategory",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "category_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityCategoryInput

{
  "name": "EntityCategoryInput",
  "type": "Object",
  "required": true,
  "fields": {
    "category_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    }
  }
}

ProviderField

{
  "name": "ProviderField",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "field_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "value": {
      "type": "String",
      "required": false
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityFieldInput

{
  "name": "EntityFieldInput",
  "type": "Object",
  "required": true,
  "fields": {
    "field_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "value": {
      "type": "String",
      "required": false
    }
  }
}

ProviderTag

{
  "name": "ProviderTag",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "value": {
      "type": "String",
      "required": false
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityTagInput

{
  "name": "EntityTagInput",
  "type": "Object",
  "required": true,
  "fields": {
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "value": {
      "type": "String",
      "required": false
    }
  }
}

Provider

{
  "name": "Provider",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "workspace_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "type": {
      "name": "ProviderType",
      "type": "Enum",
      "required": true,
      "valids": [
        "AWS"
      ]
    },
    "p_verified": {
      "type": "Boolean",
      "required": true
    },
    "meta": {
      "type": "Any",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

ProviderFull

{
  "name": "ProviderFull",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "user_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "p_verified": {
      "type": "Boolean",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    },
    "region": {
      "type": "String",
      "required": true
    },
    "access_key": {
      "type": "String",
      "required": true
    },
    "secret_key": {
      "type": "String",
      "required": true
    },
    "provider_category": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "EntityCategoryInput",
          "type": "Object",
          "required": false,
          "fields": {
            "category_id": {
              "type": "String",
              "required": true,
              "min": 20,
              "max": 20
            }
          }
        }
      ]
    },
    "provider_field": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "EntityFieldInput",
          "type": "Object",
          "required": false,
          "fields": {
            "field_id": {
              "type": "String",
              "required": true,
              "min": 20,
              "max": 20
            },
            "value": {
              "type": "String",
              "required": false
            }
          }
        }
      ]
    },
    "provider_tag": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "EntityTagInput",
          "type": "Object",
          "required": false,
          "fields": {
            "name": {
              "type": "String",
              "required": true,
              "max": 255
            },
            "value": {
              "type": "String",
              "required": false
            }
          }
        }
      ]
    }
  }
}

AWSInput

{
  "name": "AWSInput",
  "type": "Object",
  "required": true,
  "fields": {
    "workspace_id": {
      "type": "String",
      "required": false,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "region": {
      "type": "String",
      "required": true
    },
    "access_key": {
      "type": "String",
      "required": true
    },
    "secret_key": {
      "type": "String",
      "required": true
    },
    "provider_category": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "EntityCategoryInput",
          "type": "Object",
          "required": false,
          "fields": {
            "category_id": {
              "type": "String",
              "required": true,
              "min": 20,
              "max": 20
            }
          }
        }
      ]
    },
    "provider_field": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "EntityFieldInput",
          "type": "Object",
          "required": false,
          "fields": {
            "field_id": {
              "type": "String",
              "required": true,
              "min": 20,
              "max": 20
            },
            "value": {
              "type": "String",
              "required": false
            }
          }
        }
      ]
    },
    "provider_tag": {
      "type": "Array",
      "required": true,
      "items": [
        {
          "name": "EntityTagInput",
          "type": "Object",
          "required": false,
          "fields": {
            "name": {
              "type": "String",
              "required": true,
              "max": 255
            },
            "value": {
              "type": "String",
              "required": false
            }
          }
        }
      ]
    }
  }
}

Sent

{
  "name": "Sent",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "String",
      "required": true
    },
    "user_id": {
      "type": "String",
      "required": true
    },
    "session_id": {
      "type": "String",
      "required": true
    },
    "workspace_id": {
      "type": "String",
      "required": false
    },
    "provider_id": {
      "type": "String",
      "required": true
    },
    "phone": {
      "type": "String",
      "required": true
    },
    "message": {
      "type": "String",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "sent_at": {
      "type": "DateTime",
      "required": false
    },
    "successful": {
      "type": "Boolean",
      "required": false
    },
    "result": {
      "type": "String",
      "required": false
    }
  }
}

Enums

ProviderType

AWS

Namira Software Corporation

©Copyright 2010 to 2025 Namira Software Corporation. All rights reserved.