TelecomsXChange (TCXC)
TelecomsXChange (TCXC) · GPT-Aktionen
TCXC SMS API
API for sending SMS messages via the TCXC Platform.
POST /send-smsSends an SMS message to specified destinations.
Ursprüngliches API-Schema
{
"openapi": "3.0.0",
"info": {
"title": "TCXC SMS API",
"description": "API for sending SMS messages via the TCXC Platform.",
"version": "1.0.2"
},
"servers": [
{
"url": "https://send-sms-ntx-api.replit.app",
"description": "SMS Gateway API Server"
}
],
"paths": {
"/send-sms": {
"post": {
"operationId": "sendSms",
"summary": "Sends an SMS message to specified destinations.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"destinations",
"text",
"username",
"password"
],
"properties": {
"destinations": {
"type": "array",
"items": {
"type": "string"
},
"description": "The destination phone number(s) that the user wishes to reach. Provide each number in international format."
},
"text": {
"type": "string"
},
"username": {
"type": "string",
"description": "Username for SMPP account. This is required to send SMS. Obtain from members.telecomsxchange.com if you do not have one."
},
"password": {
"type": "string",
"description": "Password for SMPP account. This is required to send SMS. Obtain from members.telecomsxchange.com if you do not have one."
}
}
}
}
}
},
"responses": {
"200": {
"description": "SMS sent successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"API-transactionID": {
"type": "string"
},
"NTX MessageID": {
"type": "array",
"items": {
"type": "string"
}
},
"Sender ID": {
"type": "string"
},
"Destinations": {
"type": "array",
"items": {
"type": "string"
}
},
"Source_addr_NPI": {
"type": "integer"
},
"Source_addr_TON": {
"type": "integer"
},
"Destination_addr_NPI": {
"type": "integer"
},
"Destination_addr_TON": {
"type": "integer"
},
"Registered_Delivery": {
"type": "integer"
},
"time_stamp": {
"type": "string"
},
"Message Status": {
"type": "string"
}
}
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}Simple CRM API
A basic CRM API to manage customer information
GET /customersRead Customers
Ursprüngliches API-Schema
{
"openapi": "3.0.0",
"info": {
"title": "Simple CRM API",
"version": "1.0.0",
"description": "A basic CRM API to manage customer information"
},
"servers": [
{
"url": "https://crm--api-tcxc.replit.app",
"description": "Production server"
}
],
"paths": {
"/customers": {
"get": {
"summary": "Read Customers",
"operationId": "read_customers",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Customer"
}
},
"examples": {
"sampleResponse": {
"value": [
{
"id": 1,
"name": "Arab Bank",
"balance": 123.45,
"phone_number": "96264600900"
},
{
"id": 2,
"name": "Bank Of America - Dubai",
"balance": 678.9,
"phone_number": "9714425 8200"
}
]
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Customer": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "The unique identifier of the customer"
},
"name": {
"type": "string",
"description": "The name of the customer"
},
"balance": {
"type": "number",
"format": "float",
"description": "The account balance of the customer"
},
"phone_number": {
"type": "string",
"description": "The contact phone number of the customer"
}
},
"required": [
"id",
"name",
"balance",
"phone_number"
]
}
}
}
}TelecomsXChange HLR Lookup API
This API provides an interface for performing HLR lookups via TelecomsXChange platform.
POST /hlr-lookupPerform an HLR lookup, AKA number insights.
Ursprüngliches API-Schema
{
"openapi": "3.0.0",
"info": {
"title": "TelecomsXChange HLR Lookup API",
"description": "This API provides an interface for performing HLR lookups via TelecomsXChange platform.",
"version": "1.0.0"
},
"servers": [
{
"url": "https://hlr-lookup-tcxc-api.replit.app",
"description": "Local server for testing"
}
],
"paths": {
"/hlr-lookup": {
"post": {
"operationId": "hlrLookup",
"summary": "Perform an HLR lookup, AKA number insights.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"phone_number": {
"type": "string",
"description": "The phone number to perform HLR lookup on. aka number insights."
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful HLR lookup",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Overall status of the response."
},
"response": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "Status code of the HLR lookup."
},
"status_message": {
"type": "string",
"description": "Message detailing the status of the HLR lookup."
},
"request_id": {
"type": "string",
"description": "Unique identifier for the HLR lookup request."
},
"international_format_number": {
"type": "string",
"description": "Phone number in international format."
},
"national_format_number": {
"type": "string",
"description": "Phone number in national format."
},
"country_code": {
"type": "string",
"description": "Two-letter country code."
},
"country_code_iso3": {
"type": "string",
"description": "Three-letter country code ISO."
},
"country_name": {
"type": "string",
"description": "Full name of the country."
},
"country_prefix": {
"type": "string",
"description": "Telephone country prefix."
},
"current_carrier": {
"type": "object",
"properties": {
"network_code": {
"type": "string"
},
"name": {
"type": "string"
},
"country": {
"type": "string"
},
"network_type": {
"type": "string"
}
}
},
"original_carrier": {
"type": "object",
"properties": {
"network_code": {
"type": "string"
},
"name": {
"type": "string"
},
"country": {
"type": "string"
},
"network_type": {
"type": "string"
}
}
},
"ported": {
"type": "string",
"description": "Information about the ported status of the number."
},
"roaming": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Roaming status of the phone number."
}
}
}
}
}
}
}
}
}
},
"4XX": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
}
}
}
}
}
},
"5XX": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}TCXC Voice Callback API
API for initiating voice calls using TelecomsXChange platform.
POST /MakeCall/Initiates a voice callMake a call between two numbers using specified connections.
Ursprüngliches API-Schema
{
"openapi": "3.0.0",
"info": {
"title": "TCXC Voice Callback API",
"version": "1.0.0",
"description": "API for initiating voice calls using TelecomsXChange platform."
},
"servers": [
{
"url": "https://tcxc-voice-callback-api.replit.app"
}
],
"paths": {
"/MakeCall/": {
"post": {
"summary": "Initiates a voice call",
"description": "Make a call between two numbers using specified connections.",
"operationId": "makeCall",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MakeCallRequest"
}
}
}
},
"responses": {
"200": {
"description": "Call initiated successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MakeCallResponse"
}
}
}
},
"4XX": {
"description": "Client Error (e.g., bad request, unauthorized)"
},
"5XX": {
"description": "Server Error"
}
}
}
}
},
"components": {
"schemas": {
"MakeCallRequest": {
"type": "object",
"required": [
"second_number",
"second_caller_id",
"i_account",
"i_connection1",
"i_connection2",
"api_username",
"api_password"
],
"properties": {
"second_number": {
"type": "string",
"example": "96264600900"
},
"second_caller_id": {
"type": "string",
"example": "19542405411"
},
"i_account": {
"type": "string",
"example": "2536"
},
"i_connection1": {
"type": "integer",
"default": 220,
"example": 220
},
"i_connection2": {
"type": "integer",
"default": 220,
"example": 220
},
"api_username": {
"type": "string",
"example": "example_username"
},
"api_password": {
"type": "string",
"example": "example_password"
}
}
},
"MakeCallResponse": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "The call has been initiated successfully to 96264600900"
}
}
}
}
}
}Destinations API
POST /search/Search in destinationsAllows searching for destinations based on various criteria.
Ursprüngliches API-Schema
{
"openapi": "3.0.0",
"info": {
"title": "Destinations API",
"version": "1.0.0"
},
"description": "API for searching destinations in the TelecomsXChange database.",
"servers": [
{
"url": "https://destinations-api.telecomsxchange.com",
"description": "Production server"
}
],
"paths": {
"/search/": {
"post": {
"summary": "Search in destinations",
"description": "Allows searching for destinations based on various criteria.",
"operationId": "searchDestinations",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchParams"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Destination"
}
}
}
}
},
"400": {
"description": "Validation Error"
},
"500": {
"description": "Internal Server Error"
}
}
}
}
},
"components": {
"schemas": {
"SearchParams": {
"type": "object",
"properties": {
"prefix": {
"type": "string",
"description": "The prefix to search for.",
"example": "4473971"
},
"country_name": {
"type": "string",
"description": "The name of the country.",
"example": "UNITED KINGDOM"
},
"description": {
"type": "string",
"description": "Description of the destination.",
"example": "Mobile - Airtel"
},
"mccmnc": {
"type": "integer",
"description": "The MCCMNC code.",
"example": 23420
}
}
},
"Destination": {
"type": "object",
"properties": {
"i_destination": {
"type": "integer",
"description": "Unique identifier for the destination."
},
"prefix": {
"type": "string",
"description": "The prefix associated with the destination."
},
"country_name": {
"type": "string",
"description": "Name of the country for the destination."
},
"description": {
"type": "string",
"description": "Description of the destination."
},
"mccmnc": {
"type": "integer",
"description": "MCCMNC code associated with the destination."
},
"interval_1": {
"type": "integer",
"description": "Interval 1 value."
},
"interval_n": {
"type": "integer",
"description": "Interval N value."
}
}
}
}
}
}TelecomsXChange API
GET /search-numbersSearch for phone numbers with a given prefixPOST /hlr-lookupPerform HLR lookup for a given phone number
Ursprüngliches API-Schema
{
"openapi": "3.1.0",
"info": {
"title": "TelecomsXChange API",
"version": "1.0.2"
},
"servers": [
{
"url": "https://telecoms-x-change-plugin-ameedjamous.replit.app/"
}
],
"paths": {
"/search-numbers": {
"get": {
"summary": "Search for phone numbers with a given prefix",
"operationId": "searchNumbers",
"parameters": [
{
"name": "prefix",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The prefix to search for."
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"cdrs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"CLD": {
"type": "string"
},
"billing_prefix": {
"type": "string"
},
"country_code": {
"type": "string"
},
"country_name": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
}
},
"required": [
"status",
"cdrs"
]
}
}
}
}
}
}
},
"/hlr-lookup": {
"post": {
"summary": "Perform HLR lookup for a given phone number",
"operationId": "hlrLookup",
"parameters": [
{
"name": "phone_number",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "The phone number to perform the HLR lookup on."
}
],
"responses": {
"200": {
"description": "Successful HLR lookup",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"response": {
"type": "object",
"properties": {
"status": {
"type": "integer"
},
"status_message": {
"type": "string"
},
"request_id": {
"type": "string"
},
"international_format_number": {
"type": "string"
},
"national_format_number": {
"type": "string"
},
"country_code": {
"type": "string"
},
"country_code_iso3": {
"type": "string"
},
"country_name": {
"type": "string"
},
"country_prefix": {
"type": "string"
},
"current_carrier": {
"type": "object",
"properties": {
"network_code": {
"type": "string"
},
"name": {
"type": "string"
},
"country": {
"type": "string"
},
"network_type": {
"type": "string"
}
}
},
"original_carrier": {
"type": "object",
"properties": {
"network_code": {
"type": "string"
},
"name": {
"type": "string"
},
"country": {
"type": "string"
},
"network_type": {
"type": "string"
}
}
},
"ported": {
"type": "string"
},
"roaming": {
"type": "object",
"properties": {
"status": {
"type": "string"
}
}
}
}
}
},
"required": [
"status",
"response"
]
}
}
}
},
"400": {
"description": "Error in HLR lookup",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
}
},
"required": [
"detail"
]
}
}
}
}
}
}
}
}
}TelecomsXChange MarketView API
API to proxy requests to TelecomsXChange Market View Search
POST /proxyProxies a request to TelecomsXChange Market View Search
Ursprüngliches API-Schema
{
"openapi": "3.1.0",
"info": {
"title": "TelecomsXChange MarketView API",
"version": "1.0.0",
"description": "API to proxy requests to TelecomsXChange Market View Search"
},
"servers": [
{
"url": "https://market-view-api-tcxc.replit.app"
}
],
"paths": {
"/proxy": {
"post": {
"summary": "Proxies a request to TelecomsXChange Market View Search",
"operationId": "PriceLookup",
"requestBody": {
"required": "true",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"prefix": {
"type": "string",
"description": "The prefix to search for"
},
"searchform": {
"type": "integer",
"default": 1,
"description": "Search form identifier (optional)"
},
"smpp": {
"type": "integer",
"default": 0,
"description": "Set to 1 to look up SMS routes, default is 0 (optional)"
},
"type": {
"type": "string",
"default": "any",
"description": "Route Type - cli, nocli, tdm, any (optional)"
},
"seller": {
"type": "string",
"description": "Seller name (optional)"
},
"pager": {
"type": "integer",
"description": "Show SMS rates only (optional)"
},
"offset": {
"type": "integer",
"description": "Offset, number of pages to return (pagination) (optional)"
}
},
"required": [
"prefix"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response with the search results",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "success"
},
"rates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prefix": {
"type": "string"
},
"vendor_name": {
"type": "string"
},
"connection_name": {
"type": "string"
},
"i_tariff": {
"type": "string"
},
"daily_asr": {
"type": "integer"
},
"weekly_asr": {
"type": "integer"
},
"daily_acd": {
"type": "integer"
},
"weekly_acd": {
"type": "integer"
},
"daily_minutes": {
"type": "integer"
},
"weekly_minutes": {
"type": "integer"
},
"stats_time": {
"type": "string"
},
"i_connection": {
"type": "string"
},
"effective_from": {
"type": "string"
},
"price_1": {
"type": "string"
},
"price_n": {
"type": "string"
},
"interval_1": {
"type": "string"
},
"interval_n": {
"type": "string"
},
"i_vendor": {
"type": "string"
},
"capacity_limit": {
"type": "string"
},
"i_rate": {
"type": "string"
},
"forbidden": {
"type": "string"
},
"discontinued": {
"type": "string"
},
"route_type": {
"type": "string"
},
"seller_registration_date": {
"type": "string"
},
"vendor_short_memo": {
"type": "string"
},
"connection_short_memo": {
"type": "string"
},
"anonymous": {
"type": "string"
},
"pos_on_page": {
"type": "integer"
},
"country_code": {
"type": "string"
},
"country_name": {
"type": "string"
},
"description": {
"type": "string"
},
"mccmnc": {
"type": "string"
},
"seller_avg_rating": {
"type": "integer"
},
"seller_reviews": {
"type": "integer"
},
"orig_effective_from": {
"type": "string"
},
"rateid": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"default": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Error": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"status_code": {
"type": "integer"
}
}
}
}
}
}