Namirasoft Telegram Sender API V1
Namira Software Corporation Telegram Sender API Version 1 (1.5.3)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-telegram-sender-api-v1
Commands
Health
Liveness
Returns the application liveness status
ns-telegram-sender health liveness
Readiness
Returns the application readiness status
ns-telegram-sender health readiness
Metrics
Get
Returns the application metrics
ns-telegram-sender metrics get
Value
List
Returns the value list of a given table and column
ns-telegram-sender value list {table} {column} {search} {field_id} {limit}
ProviderCategory
List
Returns the provider category list
ns-telegram-sender providercategory list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a provider category by id.
ns-telegram-sender providercategory get {id}
Create
Creates a new provider category for an entity
ns-telegram-sender providercategory create
--slot_id (String)
--category_id (String)
Delete
Deletes a provider category by an id.
ns-telegram-sender providercategory delete {id}
ProviderField
List
Returns the provider field list
ns-telegram-sender providerfield list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a provider field by id.
ns-telegram-sender providerfield get {id}
Create
Creates a new provider field for an entity
ns-telegram-sender providerfield create
--slot_id (String)
--field_id (String)
--value (Any)
Update
Updates a provider field by an id for an entity
ns-telegram-sender providerfield update {id}
--slot_id (String)
--field_id (String)
--value (Any)
Delete
Deletes a provider field by an id.
ns-telegram-sender providerfield delete {id}
ProviderTag
List
Returns the provider tag list
ns-telegram-sender providertag list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a provider tag by id.
ns-telegram-sender providertag get {id}
Create
Creates a new provider tag for an entity
ns-telegram-sender providertag create
--name (String)
--value (String)
Update
Updates a provider tag by an id for an entity
ns-telegram-sender providertag update {id}
--name (String)
--value (String)
Delete
Deletes a provider tag by an id.
ns-telegram-sender providertag delete {id}
Telegram
Send
Sends a message
ns-telegram-sender telegram send
--provider_id (String)
--chat_id (String)
--message_thread_id (String)
--message (String)
_SendFor
Sends a message for an user_id
ns-telegram-sender telegram _sendfor {user_id}
--provider_id (String)
--chat_id (String)
--message_thread_id (String)
--message (String)
Provider
List
Returns the provider list
ns-telegram-sender provider list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a provider by an id
ns-telegram-sender provider get {id}
Delete
Deletes a provider by an id
ns-telegram-sender provider delete {id}
Request
Sends a provider validation request by Telegram message
ns-telegram-sender provider request {id}
--chat_id (String)
--message_thread_id (String)
Verify
Verify provider
ns-telegram-sender provider verify {id}
--code (String)
NamirasoftBot
Create
Creates a new namirasoft bot
ns-telegram-sender namirasoftbot create
--workspace_id (String)
--name (String)
--limit (Boolean)
--limit_count (Integer)
--limit_per_value (Integer)
--limit_per_unit (Enum)
--delay (Boolean)
--delay_value (Integer)
--delay_unit (Enum)
--description (String)
--chat_id (String)
--message_thread_id (String)
--provider_category (Array)
--provider_field (Array)
--provider_tag (Array)
Update
Updates a namirasoft bot by an id
ns-telegram-sender namirasoftbot update {id}
--workspace_id (String)
--name (String)
--limit (Boolean)
--limit_count (Integer)
--limit_per_value (Integer)
--limit_per_unit (Enum)
--delay (Boolean)
--delay_value (Integer)
--delay_unit (Enum)
--description (String)
--chat_id (String)
--message_thread_id (String)
--provider_category (Array)
--provider_field (Array)
--provider_tag (Array)
CustomBot
Create
Creates a new custom bot
ns-telegram-sender custombot create
--workspace_id (String)
--name (String)
--limit (Boolean)
--limit_count (Integer)
--limit_per_value (Integer)
--limit_per_unit (Enum)
--delay (Boolean)
--delay_value (Integer)
--delay_unit (Enum)
--description (String)
--api_token (String)
--chat_id (String)
--message_thread_id (String)
--provider_category (Array)
--provider_field (Array)
--provider_tag (Array)
Update
Updates a custom bot by an id
ns-telegram-sender custombot update {id}
--workspace_id (String)
--name (String)
--limit (Boolean)
--limit_count (Integer)
--limit_per_value (Integer)
--limit_per_unit (Enum)
--delay (Boolean)
--delay_value (Integer)
--delay_unit (Enum)
--description (String)
--api_token (String)
--chat_id (String)
--message_thread_id (String)
--provider_category (Array)
--provider_field (Array)
--provider_tag (Array)
Sent
List
Returns the sent list
ns-telegram-sender sent list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a sent by an id
ns-telegram-sender sent get {id}
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 }, "slot_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": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "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 }, "slot_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": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "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": [ "NamirasoftBot", "CustomBot" ] }, "e_verified": { "type": "Boolean", "required": true }, "meta": { "type": "Any", "required": false }, "limit": { "type": "Boolean", "required": true }, "limit_count": { "type": "Integer", "required": false }, "limit_per_value": { "type": "Integer", "required": false }, "limit_per_unit": { "name": "ProviderLimitPerUnit", "type": "Enum", "required": false, "valids": [ "Second", "Minute", "Hour", "Day" ] }, "delay": { "type": "Boolean", "required": true }, "delay_value": { "type": "Integer", "required": false }, "delay_unit": { "name": "ProviderDelayUnit", "type": "Enum", "required": false, "valids": [ "Millisecond", "Second", "Minute" ] }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
NamirasoftBotCreate
{ "name": "NamirasoftBotCreate", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "limit": { "type": "Boolean", "required": true }, "limit_count": { "type": "Integer", "required": false }, "limit_per_value": { "type": "Integer", "required": false }, "limit_per_unit": { "name": "ProviderLimitPerUnit", "type": "Enum", "required": false, "valids": [ "Second", "Minute", "Hour", "Day" ] }, "delay": { "type": "Boolean", "required": true }, "delay_value": { "type": "Integer", "required": false }, "delay_unit": { "name": "ProviderDelayUnit", "type": "Enum", "required": false, "valids": [ "Millisecond", "Second", "Minute" ] }, "description": { "type": "String", "required": false }, "chat_id": { "type": "String", "required": true }, "message_thread_id": { "type": "String", "required": false }, "provider_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "provider_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "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 } } } ] } }}
NamirasoftBotUpdate
{ "name": "NamirasoftBotUpdate", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "limit": { "type": "Boolean", "required": true }, "limit_count": { "type": "Integer", "required": false }, "limit_per_value": { "type": "Integer", "required": false }, "limit_per_unit": { "name": "ProviderLimitPerUnit", "type": "Enum", "required": false, "valids": [ "Second", "Minute", "Hour", "Day" ] }, "delay": { "type": "Boolean", "required": true }, "delay_value": { "type": "Integer", "required": false }, "delay_unit": { "name": "ProviderDelayUnit", "type": "Enum", "required": false, "valids": [ "Millisecond", "Second", "Minute" ] }, "description": { "type": "String", "required": false }, "chat_id": { "type": "String", "required": false }, "message_thread_id": { "type": "String", "required": false }, "provider_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "provider_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "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 } } } ] } }}
CustomBotCreate
{ "name": "CustomBotCreate", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "limit": { "type": "Boolean", "required": true }, "limit_count": { "type": "Integer", "required": false }, "limit_per_value": { "type": "Integer", "required": false }, "limit_per_unit": { "name": "ProviderLimitPerUnit", "type": "Enum", "required": false, "valids": [ "Second", "Minute", "Hour", "Day" ] }, "delay": { "type": "Boolean", "required": true }, "delay_value": { "type": "Integer", "required": false }, "delay_unit": { "name": "ProviderDelayUnit", "type": "Enum", "required": false, "valids": [ "Millisecond", "Second", "Minute" ] }, "description": { "type": "String", "required": false }, "api_token": { "type": "String", "required": true }, "chat_id": { "type": "String", "required": true }, "message_thread_id": { "type": "String", "required": false }, "provider_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "provider_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "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 } } } ] } }}
CustomBotUpdate
{ "name": "CustomBotUpdate", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "limit": { "type": "Boolean", "required": true }, "limit_count": { "type": "Integer", "required": false }, "limit_per_value": { "type": "Integer", "required": false }, "limit_per_unit": { "name": "ProviderLimitPerUnit", "type": "Enum", "required": false, "valids": [ "Second", "Minute", "Hour", "Day" ] }, "delay": { "type": "Boolean", "required": true }, "delay_value": { "type": "Integer", "required": false }, "delay_unit": { "name": "ProviderDelayUnit", "type": "Enum", "required": false, "valids": [ "Millisecond", "Second", "Minute" ] }, "description": { "type": "String", "required": false }, "api_token": { "type": "String", "required": false }, "chat_id": { "type": "String", "required": false }, "message_thread_id": { "type": "String", "required": false }, "provider_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "provider_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "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 }, "chat_id": { "type": "String", "required": true }, "message_thread_id": { "type": "String", "required": false }, "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
NamirasoftBot
CustomBot
ProviderLimitPerUnit
Second
Minute
Hour
Day
ProviderDelayUnit
Millisecond
Second
Minute
Namira Software Corporation
©Copyright 2010 to 2026 Namira Software Corporation. All rights reserved.